com.virtuosotechnologies.lib.basiccommand
Class BasicCommandNode

java.lang.Object
  com.virtuosotechnologies.lib.container.PseudoModifiablePropertySet
      com.virtuosotechnologies.lib.container.BasicModifiablePropertySet
          com.virtuosotechnologies.lib.command.AbstractCommandNode
              com.virtuosotechnologies.lib.basiccommand.BasicCommandNode

All Implemented Interfaces:

CommandListener, CommandNode, EventListener, ModifiablePropertySet, PropertySet

Direct Known Subclasses:

BasicContainerCommandNode, BasicDecoratingCommandNode, BasicGroupCommandNode, BasicItemCommandNode, BasicRadioGroupCommandNode, BasicSeparatorCommandNode, BasicToggleItemCommandNode

public abstract class BasicCommandNode

extends AbstractCommandNode

Base class for CommandNode implementations in basiccommand. Subclasses must implement commandInvoked() and getFlavor().

Field Summary

static ClassConstrainedKey	ACCELERATOR_KEYSTROKE_PROPERTY Property key for the keyboard accelerator property.
static CommandNodeFlavor	ACTIONITEM_FLAVOR Action-item flavor.
static CommandNodeFlavor	APPEARANCECHANGING_TOGGLEITEM_FLAVOR Special toggle-item flavor used for appearance-changing items.
static CommandNodeFlavor	CONTAINER_FLAVOR Container flavor.
static ClassConstrainedKey	DISABLED_PROPERTY Property key for the "command disabled" property.
static CommandNodeFlavor	GROUP_FLAVOR Group flavor.
static ClassConstrainedKey	HIDDEN_PROPERTY Property key for the "command hidden" property.
static ClassConstrainedKey	LONG_DESCRIPTION_PROPERTY Property key for the long description property.
static ClassConstrainedKey	MNEMONIC_CODE_PROPERTY Property key for the keyboard mnemonic property.
static ClassConstrainedKey	NAME_PROPERTY Property key for the command name property.
static CommandNodeFlavor	NULL_FLAVOR Null flavor.
static CommandNodeFlavor	RADIOCONTAINER_FLAVOR Radio container flavor.
static CommandNodeFlavor	RADIOGROUP_FLAVOR Radio group flavor.
static CommandNodeFlavor	RADIOMUTEX_FLAVOR Radio mutex flavor.
static ClassConstrainedKey	SELECTED_CHILD_PROPERTY Property key for the selected child property.
static ClassConstrainedKey	SELECTED_NAME_PROPERTY Property key for the command name when selected property.
static ClassConstrainedKey	SELECTED_SHORT_DESCRIPTION_PROPERTY Property key for the icon when selected property.
static ClassConstrainedKey	SELECTED_SMALL_ICON_PROPERTY Property key for the icon when selected property.
static ClassConstrainedKey	SELECTION_STATE_PROPERTY Property key for the selection state property.
static CommandNodeFlavor	SEPARATOR_FLAVOR Separator flavor.
static ClassConstrainedKey	SHORT_DESCRIPTION_PROPERTY Property key for the short description property.
static ClassConstrainedKey	SMALL_ICON_PROPERTY Property key for the icon property.
static CommandNodeFlavor	TOGGLEITEM_FLAVOR Toggle-item flavor.

Fields inherited from interface com.virtuosotechnologies.lib.command.CommandListener

COMMAND_INVOKED_METHOD

Constructor Summary

protected	BasicCommandNode() Constructor.
protected	BasicCommandNode(PropertySet defaults) Constructor.

Method Summary

static void	dump(CommandNode node) Dump subgraph to standard error (for debugging)
KeyStroke	getAcceleratorKeystrokeProperty() Convenience accessor for ACCELERATOR_KEYSTROKE_PROPERTY
static PropertySet	getDefaultProperties() Get the default property set.
boolean	getDisabledProperty() Convenience accessor for DISABLED_PROPERTY
boolean	getHiddenProperty() Convenience accessor for HIDDEN_PROPERTY
String	getLongDescriptionProperty() Convenience accessor for LONG_DESCRIPTION_PROPERTY
int	getMnemonicCodeProperty() Convenience accessor for MNEMONIC_CODE_PROPERTY
String	getNameProperty() Convenience accessor for NAME_PROPERTY
CommandNode	getSelectedChildProperty() Convenience accessor for SELECTED_CHILD_PROPERTY
String	getSelectedNameProperty() Convenience accessor for SELECTED_NAME_PROPERTY
String	getSelectedShortDescriptionProperty() Convenience accessor for SELECTED_SHORT_DESCRIPTION_PROPERTY
Icon	getSelectedSmallIconProperty() Convenience accessor for SELECTED_SMALL_ICON_PROPERTY
boolean	getSelectionStateProperty() Convenience accessor for SELECTION_STATE_PROPERTY
String	getShortDescriptionProperty() Convenience accessor for SHORT_DESCRIPTION_PROPERTY
Icon	getSmallIconProperty() Convenience accessor for SMALL_ICON_PROPERTY
void	setAcceleratorKeystrokeProperty(KeyStroke value) Convenience mutator for ACCELERATOR_KEYSTROKE_PROPERTY
void	setDisabledProperty(boolean value) Convenience mutator for DISABLED_PROPERTY
void	setHiddenProperty(boolean value) Convenience mutator for HIDDEN_PROPERTY
void	setLongDescriptionProperty(String value) Convenience mutator for LONG_DESCRIPTION_PROPERTY
void	setMnemonicCodeProperty(int value) Convenience mutator for MNEMONIC_CODE_PROPERTY
void	setNameProperty(String value) Convenience mutator for NAME_PROPERTY
void	setSelectedChildProperty(CommandNode value) Convenience mutator for SELECTED_CHILD_PROPERTY
void	setSelectedNameProperty(String value) Convenience mutator for SELECTED_NAME_PROPERTY
void	setSelectedShortDescriptionProperty(String value) Convenience mutator for SELECTED_SHORT_DESCRIPTION_PROPERTY
void	setSelectedSmallIconProperty(Icon value) Convenience mutator for SELECTED_SMALL_ICON_PROPERTY
void	setSelectionStateProperty(boolean value) Convenience mutator for SELECTION_STATE_PROPERTY
void	setShortDescriptionProperty(String value) Convenience mutator for SHORT_DESCRIPTION_PROPERTY
void	setSmallIconProperty(Icon value) Convenience mutator for SMALL_ICON_PROPERTY

Methods inherited from class com.virtuosotechnologies.lib.command.AbstractCommandNode

addChild, addNodeListener, fireAllChildrenRemovedEvent, fireChildAddedEvent, fireChildRemovedEvent, getIndexOfChild, getNthChild, getNumChildren, insertChild, invoke, isChild, removeAllChildren, removeNodeListener, removeNthChild

Methods inherited from class com.virtuosotechnologies.lib.container.PseudoModifiablePropertySet

addPropertySetListener, firePropertySetEvent, getDefaultValue, getValue, putValue, removePropertySetListener, resetValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.virtuosotechnologies.lib.command.CommandNode

getFlavor

Methods inherited from interface com.virtuosotechnologies.lib.container.ModifiablePropertySet

putValue, resetValue

Methods inherited from interface com.virtuosotechnologies.lib.container.PropertySet

addPropertySetListener, getDefaultValue, getValue, removePropertySetListener

Methods inherited from interface com.virtuosotechnologies.lib.command.CommandListener

commandInvoked

Field Detail

NAME_PROPERTY

public static final ClassConstrainedKey NAME_PROPERTY

Property key for the command name property. Class is String.

SHORT_DESCRIPTION_PROPERTY

public static final ClassConstrainedKey SHORT_DESCRIPTION_PROPERTY

Property key for the short description property. Class is String.

LONG_DESCRIPTION_PROPERTY

public static final ClassConstrainedKey LONG_DESCRIPTION_PROPERTY

Property key for the long description property. Class is String.

ACCELERATOR_KEYSTROKE_PROPERTY

public static final ClassConstrainedKey ACCELERATOR_KEYSTROKE_PROPERTY

Property key for the keyboard accelerator property. Class is KeyStroke.

MNEMONIC_CODE_PROPERTY

public static final ClassConstrainedKey MNEMONIC_CODE_PROPERTY

Property key for the keyboard mnemonic property. Class is Integer.

SMALL_ICON_PROPERTY

public static final ClassConstrainedKey SMALL_ICON_PROPERTY

Property key for the icon property. Class is Icon.

DISABLED_PROPERTY

public static final ClassConstrainedKey DISABLED_PROPERTY

Property key for the "command disabled" property. Class is Boolean.

HIDDEN_PROPERTY

public static final ClassConstrainedKey HIDDEN_PROPERTY

Property key for the "command hidden" property. Class is Boolean.

SELECTION_STATE_PROPERTY

public static final ClassConstrainedKey SELECTION_STATE_PROPERTY

Property key for the selection state property. Class is Boolean.

SELECTED_CHILD_PROPERTY

public static final ClassConstrainedKey SELECTED_CHILD_PROPERTY

Property key for the selected child property. Class is CommandNode.

SELECTED_NAME_PROPERTY

public static final ClassConstrainedKey SELECTED_NAME_PROPERTY

Property key for the command name when selected property. Class is String.

SELECTED_SMALL_ICON_PROPERTY

public static final ClassConstrainedKey SELECTED_SMALL_ICON_PROPERTY

Property key for the icon when selected property. Class is Icon.

SELECTED_SHORT_DESCRIPTION_PROPERTY

public static final ClassConstrainedKey SELECTED_SHORT_DESCRIPTION_PROPERTY

Property key for the icon when selected property. Class is String.

NULL_FLAVOR

public static final CommandNodeFlavor NULL_FLAVOR

Null flavor. This flavor is defined to be a no-op. Builders must ignore CommandNodes with this flavor.

SEPARATOR_FLAVOR

public static final CommandNodeFlavor SEPARATOR_FLAVOR

Separator flavor.

ACTIONITEM_FLAVOR

public static final CommandNodeFlavor ACTIONITEM_FLAVOR

Action-item flavor.

TOGGLEITEM_FLAVOR

public static final CommandNodeFlavor TOGGLEITEM_FLAVOR

Toggle-item flavor.

APPEARANCECHANGING_TOGGLEITEM_FLAVOR

public static final CommandNodeFlavor APPEARANCECHANGING_TOGGLEITEM_FLAVOR

Special toggle-item flavor used for appearance-changing items. Subflavor of TOGGLEITEM.

GROUP_FLAVOR

public static final CommandNodeFlavor GROUP_FLAVOR

Group flavor.

CONTAINER_FLAVOR

public static final CommandNodeFlavor CONTAINER_FLAVOR

Container flavor.

RADIOMUTEX_FLAVOR

public static final CommandNodeFlavor RADIOMUTEX_FLAVOR

Radio mutex flavor. This is an "abstract" flavor never used directly, but it is a parent of all flavors that indicate radio mutexes.

RADIOGROUP_FLAVOR

public static final CommandNodeFlavor RADIOGROUP_FLAVOR

Radio group flavor. Subflavor of RADIOMUTEX and GROUP.

RADIOCONTAINER_FLAVOR

public static final CommandNodeFlavor RADIOCONTAINER_FLAVOR

Radio container flavor. Subflavor of RADIOMUTEX and CONTAINER.

Constructor Detail

BasicCommandNode

protected BasicCommandNode()

Constructor.

BasicCommandNode

protected BasicCommandNode(PropertySet defaults)

Constructor.

Parameters:

defaults - defaults for the PropertySet

Method Detail

getNameProperty

public String getNameProperty()

Convenience accessor for NAME_PROPERTY

setNameProperty

public void setNameProperty(String value)

Convenience mutator for NAME_PROPERTY

getShortDescriptionProperty

public String getShortDescriptionProperty()

Convenience accessor for SHORT_DESCRIPTION_PROPERTY

setShortDescriptionProperty

public void setShortDescriptionProperty(String value)

Convenience mutator for SHORT_DESCRIPTION_PROPERTY

getLongDescriptionProperty

public String getLongDescriptionProperty()

Convenience accessor for LONG_DESCRIPTION_PROPERTY

setLongDescriptionProperty

public void setLongDescriptionProperty(String value)

Convenience mutator for LONG_DESCRIPTION_PROPERTY

getAcceleratorKeystrokeProperty

public KeyStroke getAcceleratorKeystrokeProperty()

Convenience accessor for ACCELERATOR_KEYSTROKE_PROPERTY

setAcceleratorKeystrokeProperty

public void setAcceleratorKeystrokeProperty(KeyStroke value)

Convenience mutator for ACCELERATOR_KEYSTROKE_PROPERTY

getMnemonicCodeProperty

public int getMnemonicCodeProperty()

Convenience accessor for MNEMONIC_CODE_PROPERTY

setMnemonicCodeProperty

public void setMnemonicCodeProperty(int value)

Convenience mutator for MNEMONIC_CODE_PROPERTY

getSmallIconProperty

public Icon getSmallIconProperty()

Convenience accessor for SMALL_ICON_PROPERTY

setSmallIconProperty

public void setSmallIconProperty(Icon value)

Convenience mutator for SMALL_ICON_PROPERTY

getDisabledProperty

public boolean getDisabledProperty()

Convenience accessor for DISABLED_PROPERTY

setDisabledProperty

public void setDisabledProperty(boolean value)

Convenience mutator for DISABLED_PROPERTY

getHiddenProperty

public boolean getHiddenProperty()

Convenience accessor for HIDDEN_PROPERTY

setHiddenProperty

public void setHiddenProperty(boolean value)

Convenience mutator for HIDDEN_PROPERTY

getSelectionStateProperty

public boolean getSelectionStateProperty()

Convenience accessor for SELECTION_STATE_PROPERTY

setSelectionStateProperty

public void setSelectionStateProperty(boolean value)

Convenience mutator for SELECTION_STATE_PROPERTY

getSelectedChildProperty

public CommandNode getSelectedChildProperty()

Convenience accessor for SELECTED_CHILD_PROPERTY

setSelectedChildProperty

public void setSelectedChildProperty(CommandNode value)

Convenience mutator for SELECTED_CHILD_PROPERTY

getSelectedNameProperty

public String getSelectedNameProperty()

Convenience accessor for SELECTED_NAME_PROPERTY

setSelectedNameProperty

public void setSelectedNameProperty(String value)

Convenience mutator for SELECTED_NAME_PROPERTY

getSelectedSmallIconProperty

public Icon getSelectedSmallIconProperty()

Convenience accessor for SELECTED_SMALL_ICON_PROPERTY

setSelectedSmallIconProperty

public void setSelectedSmallIconProperty(Icon value)

Convenience mutator for SELECTED_SMALL_ICON_PROPERTY

getSelectedShortDescriptionProperty

public String getSelectedShortDescriptionProperty()

Convenience accessor for SELECTED_SHORT_DESCRIPTION_PROPERTY

setSelectedShortDescriptionProperty

public void setSelectedShortDescriptionProperty(String value)

Convenience mutator for SELECTED_SHORT_DESCRIPTION_PROPERTY

getDefaultProperties

public static PropertySet getDefaultProperties()

Get the default property set. This is a global immutable PropertySet.

Returns:

default PropertySet used by BasicCommandNodes

dump

public static void dump(CommandNode node)

Dump subgraph to standard error (for debugging)

Parameters:

node - CommandNode to dump