oracle.ide.cmd

Class CloseNodeCommand

java.lang.Object

oracle.ide.controller.Command

oracle.ide.cmd.CloseNodeCommand

public class CloseNodeCommand
extends Command

The CloseNodeCommand class implements the command to unload the the selected node(s) and revert to an unopen state.

See Also:

Command

Field Summary

Fields inherited from class oracle.ide.controller.Command

CANCEL, context, EXECUTING, MULTI_NODE, NO_CHANGE, NO_UNDO, NORMAL, OK, type

Constructor Summary

Constructors

Constructor and Description
CloseNodeCommand() Constructor.
CloseNodeCommand(UpdateMessage messageTemplate) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	checkSave(java.util.Iterator targets) Check if the user wants to save dirty Nodes about to be closed.
int	checkSave(java.util.Iterator targets, boolean canCancel) Check if the user wants to save dirty Nodes about to be closed.
int	checkSave(java.util.List dirtyNodes, boolean canCancel)
void	clearAffectedNodes() Reset the list of affected Nodes.
int	close(java.util.Iterator nodes, Context context, boolean uncache, boolean removeUnsavedNodes) Closes the nodes specified by the Iterator.
int	close(java.util.List nodes, boolean uncache, boolean removeUnsavedNodes) Close the Nodes listed in nodes.
protected int	close(java.util.List nodes, Context context, boolean uncache, boolean removeUnsavedNodes)
int	close(Node node) Close the specified Node.
int	close(Node node, boolean uncache, boolean removeUnsavedNode) Close the specified node.
static Command	closeAndremoveApplication(Context context)
protected void	collectDirtyNodes(java.util.Iterator targets, java.util.List dirtyNodes)
int	doit() Executes the actions associated with a specific command.
Node[]	getAffectedNodes() Returns an array of the Nodes closed.
boolean	isNeedConfirm()
static Command	removeOrCloseApplicationPrompt(Context context) Deprecated. No longer an option to close without removing application; use closeAndremoveApplication(oracle.ide.Context)
void	setNeedConfirm(boolean confirm)

Methods inherited from class oracle.ide.controller.Command

enableConfirmation, getContext, getData, getId, getName, getProgressHandle, getType, isGlobal, setContext, setData, setTaskInfo, undo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CloseNodeCommand

public CloseNodeCommand()

Constructor.

CloseNodeCommand

public CloseNodeCommand(UpdateMessage messageTemplate)

Constructor.

Method Detail

removeOrCloseApplicationPrompt

@Deprecated
public static Command removeOrCloseApplicationPrompt(Context context)

Deprecated. No longer an option to close without removing application; use closeAndremoveApplication(oracle.ide.Context)

closeAndremoveApplication

public static Command closeAndremoveApplication(Context context)

doit

public int doit()
         throws java.lang.Exception

Description copied from class: Command

Executes the actions associated with a specific command. When a command executes successfully, implementations should return OK, otherwise, return CANCEL or any other non-zero value.

Specified by:

doit in class Command

Throws:

java.lang.Exception

isNeedConfirm

public boolean isNeedConfirm()

setNeedConfirm

public void setNeedConfirm(boolean confirm)

close

public int close(java.util.List nodes,
        boolean uncache,
        boolean removeUnsavedNodes)

Close the Nodes listed in nodes. If the uncache parameter is true nodes are uncached from the node factory. When the removeUnsavedNodes parameter is true, nodes that have not yet been persited are removed from their container.

close

public int close(Node node,
        boolean uncache,
        boolean removeUnsavedNode)

Close the specified node. If the uncache parameter is true nodes are uncached from the node factory. When the removeUnsavedNodes parameter is true, nodes that have not yet been persited are removed from their container.

close

public int close(Node node)

Close the specified Node. If Node contains other Nodes those Nodes will also be closed. The user will be asked to save any dirty Node about to be closed. Users can choose to save or not save the Node, but they have no option to cancel the close operation.

getAffectedNodes

public Node[] getAffectedNodes()

Returns an array of the Nodes closed.

Overrides:

getAffectedNodes in class Command

Returns:

the Nodes affected by this command, otherwise, null.

clearAffectedNodes

public void clearAffectedNodes()

Reset the list of affected Nodes.

checkSave

public int checkSave(java.util.Iterator targets)

Check if the user wants to save dirty Nodes about to be closed. Users are given a chance to cancel.

checkSave

public int checkSave(java.util.Iterator targets,
            boolean canCancel)

Check if the user wants to save dirty Nodes about to be closed. If the canCancel parameter is true the user is given the choice to cancel.

checkSave

public int checkSave(java.util.List dirtyNodes,
            boolean canCancel)

close

public int close(java.util.Iterator nodes,
        Context context,
        boolean uncache,
        boolean removeUnsavedNodes)

Closes the nodes specified by the Iterator. If the uncache parameter is true nodes are uncached from the node factory. When the removeUnsavedNodes parameter is true, nodes that have not yet been persited are removed from their container.

close

protected int close(java.util.List nodes,
        Context context,
        boolean uncache,
        boolean removeUnsavedNodes)

collectDirtyNodes

protected void collectDirtyNodes(java.util.Iterator targets,
                     java.util.List dirtyNodes)