|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.pietschy.command.Command
org.pietschy.command.ActionCommand
org.pietschy.command.ToggleCommand
org.pietschy.command.undo.UndoableToggleCommand
public abstract class UndoableToggleCommand
UndoableToggleCommands provide a default implementation for toggle commands that can be undone.
UndoableToggleCommands implement UndoableEventSource
and can be monitored by an
UndoController
.
Subclasses must implement performEdit(boolean)
to handle the selection process.
performEdit(boolean)
,
ToggleCommand.applySelection(boolean)
Field Summary |
---|
Fields inherited from class org.pietschy.command.ActionCommand |
---|
HINT_ACTION_EVENT, HINT_INVOKER, HINT_INVOKER_WINDOW, HINT_MODIFIERS |
Fields inherited from class org.pietschy.command.Command |
---|
internalLog, listenerList, pcs |
Constructor Summary | |
---|---|
|
UndoableToggleCommand()
Creates a new anonymous UndoableToggleCommand. |
protected |
UndoableToggleCommand(CommandManager commandManager,
java.lang.String commandId)
Creates a new command with the specified id that is bound to the specified CommandManager . |
|
UndoableToggleCommand(java.lang.String commandId)
Creates a new command with the speicifed Id that is bound to the CommandManager.defaultInstance() . |
Method Summary | |
---|---|
void |
addUndoableEditListener(javax.swing.event.UndoableEditListener l)
Adds a new UndoableEditListener to this command. |
javax.swing.event.UndoableEditListener[] |
getUndoableEditListeners()
Gets the UndoableEditListener s regstered with this command. |
protected void |
handleSelection(boolean selected)
Delegates to performEdit(boolean) |
protected abstract javax.swing.undo.UndoableEdit |
performEdit(boolean selected)
Subclasses must override to perform the actual edit. |
protected void |
postEdit(javax.swing.undo.UndoableEdit e)
Notifies all the UndoableEditListener s of the undoable event. |
void |
removeUndoableEditListener(javax.swing.event.UndoableEditListener l)
Removes an UndoableEditListener from this command. |
Methods inherited from class org.pietschy.command.ToggleCommand |
---|
addNotify, applySelection, attemptSelection, configureButtonStates, createButton, createCheckBox, createCheckBox, createCheckBox, createCheckBox, createMenuItem, handleExecute, isSelected, removeNotify, requestDefautIn, setSelected |
Methods inherited from class org.pietschy.command.ActionCommand |
---|
addCommandListener, addInterceptor, areEqual, attach, detach, execute, execute, getActionAdapter, getActionAdapter, getActionCommand, getActionEvent, getHint, getHint, getHints, getInvoker, getInvokerWindow, getModifiers, installShortCut, installShortCut, postExecute, preExecute, putHint, putHints, removeCommandListener, removeInterceptor, setActionCommand, uninstallShortCut, uninstallShortCut |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.pietschy.command.ActionCommandExecutor |
---|
addPropertyChangeListener, addPropertyChangeListener, isEnabled, removePropertyChangeListener, removePropertyChangeListener |
Constructor Detail |
---|
public UndoableToggleCommand()
groupCommand.installFace(myAnonymousCommand)
.
public UndoableToggleCommand(java.lang.String commandId)
CommandManager.defaultInstance()
.
protected UndoableToggleCommand(CommandManager commandManager, java.lang.String commandId)
CommandManager
.
Method Detail |
---|
protected final void handleSelection(boolean selected) throws ToggleVetoException
performEdit(boolean)
handleSelection
in class ToggleCommand
selected
- the new desired state of the toggle
ToggleVetoException
- if the new state can't be fullfilled.protected abstract javax.swing.undo.UndoableEdit performEdit(boolean selected) throws ToggleVetoException
ToggleCommand.handleSelection(boolean)
in that it can throw a ToggleVetoException
to cancel the edit.
Please note that the edit object should call ToggleCommand.applySelection(boolean)
to update the state of this command
without causing a new UndoableEdit to be created. For example
class MyToggle.ToggleUndoableEdit extends UndoableEdit { public void undo() { // undo any command specific stuff... ... // and reset our state without causeing any side effects.. applySelection(oldState); } }
selected
- the new selected state of the command.
ToggleVetoException
- if the toggle action can't proceed.ToggleCommand.applySelection(boolean)
protected void postEdit(javax.swing.undo.UndoableEdit e)
UndoableEditListener
s of the undoable event.
e
- the undoable event.public void addUndoableEditListener(javax.swing.event.UndoableEditListener l)
UndoableEditListener
to this command.
addUndoableEditListener
in interface UndoableEventSource
l
- the listener to installFace.UndoController
public void removeUndoableEditListener(javax.swing.event.UndoableEditListener l)
UndoableEditListener
from this command.
removeUndoableEditListener
in interface UndoableEventSource
l
- the listener to remove.UndoController
public javax.swing.event.UndoableEditListener[] getUndoableEditListeners()
UndoableEditListener
s regstered with this command.
getUndoableEditListeners
in interface UndoableEventSource
UndoController
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |