Package ca.cgjennings.apps.arkham.commands

Class DelegatedCommand

java.lang.Object

javax.swing.AbstractAction

ca.cgjennings.apps.arkham.commands.AbstractCommand

ca.cgjennings.apps.arkham.commands.DelegatedCommand

All Implemented Interfaces:

java.awt.event.ActionListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.swing.Action

public class DelegatedCommand
extends AbstractCommand

Delegated commands are commands that are normally handled by a Commandable, such as a StrangeEonsEditor, instead of being handled by the command itself.

Since:

3.0

Author:

Chris Jennings

See Also:

Serialized Form

Field Summary

Fields inherited from class ca.cgjennings.apps.arkham.commands.AbstractCommand

BUTTON_ID_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	Description
DelegatedCommand()
DelegatedCommand(java.lang.String nameKey)
DelegatedCommand(java.lang.String nameKey, java.lang.String iconResource)
DelegatedCommand(java.lang.String nameKey, java.lang.String iconResource, java.lang.String acceleratorKey)

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(java.awt.event.ActionEvent e)	Executes the delegated command by finding a command handler to delegate to; if no Commandable is found, and a default action is applicable, then the default action is performed by calling performDefaultAction(java.awt.event.ActionEvent).
boolean	isDefaultActionApplicable()	Returns true if a default action is applicable.
void	performDefaultAction(java.awt.event.ActionEvent e)	Performs a default action for this delegated command.
void	update()	Updates the command's state.

Methods inherited from class ca.cgjennings.apps.arkham.commands.AbstractCommand

getAccelerator, getCommandString, getIcon, getName, setAccelerator, setIcon, setIcon, setName, setNameKey, toString

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, wait, wait, wait

Methods inherited from interface javax.swing.Action

accept

Constructor Detail

DelegatedCommand

public DelegatedCommand()

DelegatedCommand

public DelegatedCommand(java.lang.String nameKey)

DelegatedCommand

public DelegatedCommand(java.lang.String nameKey,
                        java.lang.String iconResource)

DelegatedCommand

public DelegatedCommand(java.lang.String nameKey,
                        java.lang.String iconResource,
                        java.lang.String acceleratorKey)

Method Detail

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Executes the delegated command by finding a command handler to delegate to; if no Commandable is found, and a default action is applicable, then the default action is performed by calling performDefaultAction(java.awt.event.ActionEvent).

Parameters:

e - the action event that describes the command activation, or null

See Also:

Commands.findCommandable(ca.cgjennings.apps.arkham.commands.AbstractCommand), isDefaultActionApplicable(), performDefaultAction(java.awt.event.ActionEvent)

performDefaultAction

public void performDefaultAction(java.awt.event.ActionEvent e)

Performs a default action for this delegated command. If no relevant Commandable wishes to handle a command, and if isDefaultActionApplicable() returns true, then this method is called to handle the command. (The base class implementation does nothing.)

Parameters:

e - the event that caused the command to activate

See Also:

Commands.findCommandable(ca.cgjennings.apps.arkham.commands.AbstractCommand), actionPerformed(java.awt.event.ActionEvent), isDefaultActionApplicable()

isDefaultActionApplicable

public boolean isDefaultActionApplicable()

Returns true if a default action is applicable. (The base class implementation returns false.)

Returns:

true if there is a default action and it is currently applicable

update

public void update()

Updates the command's state. This method is called to update the command's internal state. It is typically called just before a menu containing the a menu item whose action is set to the command is displayed. (The default implementation does nothing.)

For delegated commands, this method updates the command's enabled state based on whether a Commandable is currently available to handle the command and whether a default action is currently applicable.

Overrides:

update in class AbstractCommand