com.xmlmind.xmleditapp.desktop.custom

Class ToggleInclusionAction

java.lang.Object

javax.swing.AbstractAction

com.xmlmind.xmleditapp.desktop.AppAction

com.xmlmind.xmleditapp.desktop.LengthyAction

com.xmlmind.xmleditapp.desktop.CustomizeConfigAction

com.xmlmind.xmleditapp.desktop.custom.ToggleInclusionAction

All Implemented Interfaces:

Command, AppPart, ActionListener, Serializable, Cloneable, EventListener, Action

public final class ToggleInclusionAction
extends CustomizeConfigAction
implements Command

See Also:

Serialized Form

Field Summary

Fields inherited from class com.xmlmind.xmleditapp.desktop.AppAction

app, id, MODIFIERS_TOOLTIP_KEY, NO_MNEMONIC, SELECTED_ICON_KEY, UNSELECTED_ICON_KEY

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

Constructors

Constructor and Description
ToggleInclusionAction()

Method Summary

Modifier and Type	Method and Description
protected void	exec() Second step of LengthyAction.doIt().
CommandResult	executeCommand(Gadget gadget, String parameter, int x, int y) Actually executes this command with specified parameter and in specified context.
protected boolean	init() First step of LengthyAction.doIt().
boolean	prepareCommand(Gadget gadget, String parameter, int x, int y) Tests whether this command can be executed with specified parameter and in specified context.

Methods inherited from class com.xmlmind.xmleditapp.desktop.CustomizeConfigAction

getActiveCustomizableConfig, updateEnabled

Methods inherited from class com.xmlmind.xmleditapp.desktop.LengthyAction

doIt, finish

Methods inherited from class com.xmlmind.xmleditapp.desktop.AppAction

actionPerformed, activeEditorChanged, applyPreferences, destroyApp, editingContextChanged, flushPreferences, getAccelerator, getApp, getDialogTitle, getIcon, getId, getLabel, getMnemonic, getMnemonicIndex, getModifiersToolTip, getSelectedIcon, getToolTip, getUnselectedIcon, hasListeners, initApp, isEditingContextSensitive, isSelected, namespacePrefixesChanged, saveStateChanged, setAccelerator, setDisabledIcons, setIcon, setLabel, setMnemonic, setMnemonicIndex, setModifiersToolTip, setSelected, setSelectedIcon, setToolTip, setUnselectedIcon, undoStateChanged, validityStateChanged, wasCtrlClick, wasRightClick, wasShiftClick

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.xmlmind.xmledit.control.Command

copy

Constructor Detail

ToggleInclusionAction

public ToggleInclusionAction()

Method Detail

init

protected boolean init()

Description copied from class: LengthyAction

First step of LengthyAction.doIt(). Possibly an interactive one. It is possible to prompt the user during this step and therefore, the user can cancel the execution of the action (before it actually starts).

Specified by:

init in class LengthyAction

Returns:

true if execution should proceed; false if execution has been canceled

exec

protected void exec()

Description copied from class: LengthyAction

Second step of LengthyAction.doIt(). Actual execution of the action. A busy cursor is displayed during this step.

Specified by:

exec in class LengthyAction

prepareCommand

public boolean prepareCommand(Gadget gadget,
                              String parameter,
                              int x,
                              int y)

Description copied from interface: Command

Tests whether this command can be executed with specified parameter and in specified context.

If the command can be executed, this method returns true after having configured its internal state for consumption by method Command.executeCommand(com.xmlmind.xmledit.gadget.Gadget, java.lang.String, int, int) which should be invoked immediately after this one.

Returns false if this command cannot be executed with specified parameter and in specified context.

Specified by:

prepareCommand in interface Command

Parameters:

gadget - the target of this command

parameter - parameterizes the command (that is, modifies the behavior of the command in a command specific way)

x - X position relative to gadget of the mouse event having triggered this command; -1 if this command was triggered by a keyboard input

y - Y position relative to gadget of the mouse event having triggered this command; -1 if this command was triggered by a keyboard input

executeCommand

public CommandResult executeCommand(Gadget gadget,
                                    String parameter,
                                    int x,
                                    int y)

Description copied from interface: Command

Actually executes this command with specified parameter and in specified context.

This method assumes that Command.prepareCommand(com.xmlmind.xmledit.gadget.Gadget, java.lang.String, int, int) has been successfully invoked immediately before its own invocation.

Specified by:

executeCommand in interface Command

Parameters:

gadget - the target of this command

parameter - parameterizes the command (that is, modifies the behavior of the command in a command specific way)

x - X position relative to gadget of the mouse event having triggered this command; -1 if this command was triggered by a keyboard input

y - Y position relative to gadget of the mouse event having triggered this command; -1 if this command was triggered by a keyboard input

Returns:

the result of the command; may NOT be null