Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.virtuosotechnologies.lib.basiccommand
Class BasicCommandNode  view BasicCommandNode download BasicCommandNode.java

java.lang.Object
  extended bycom.virtuosotechnologies.lib.propertyset.BasicPropertySet
      extended bycom.virtuosotechnologies.lib.command.AbstractCommandNode
          extended bycom.virtuosotechnologies.lib.basiccommand.BasicCommandNode
All Implemented Interfaces:
com.virtuosotechnologies.lib.command.CommandListener, com.virtuosotechnologies.lib.command.CommandNode, com.virtuosotechnologies.lib.propertyset.PropertySet
Direct Known Subclasses:
BasicContainerCommandNode, BasicDecoratingCommandNode, BasicGroupCommandNode, BasicItemCommandNode, BasicRadioGroupCommandNode, BasicSeparatorCommandNode, BasicToggleItemCommandNode

public abstract class BasicCommandNode
extends com.virtuosotechnologies.lib.command.AbstractCommandNode

Base class for CommandNode implementations in basiccommand


Field Summary
static com.virtuosotechnologies.lib.base.ClassConstrainedKey ACCELERATOR_KEYSTROKE_PROPERTY
          Property key for the keyboard accelerator property.
static com.virtuosotechnologies.lib.command.CommandNodeFlavor ACTIONITEM_FLAVOR
          Action-item flavor.
static com.virtuosotechnologies.lib.command.CommandNodeFlavor APPEARANCECHANGING_TOGGLEITEM_FLAVOR
          Special toggle-item flavor used for appearance-changing items.
static com.virtuosotechnologies.lib.command.CommandNodeFlavor CONTAINER_FLAVOR
          Container flavor.
private static com.virtuosotechnologies.lib.propertyset.PropertySet defaultProperties_
           
static com.virtuosotechnologies.lib.base.ClassConstrainedKey DISABLED_PROPERTY
          Property key for the "command disabled" property.
static com.virtuosotechnologies.lib.command.CommandNodeFlavor GROUP_FLAVOR
          Group flavor.
static com.virtuosotechnologies.lib.base.ClassConstrainedKey HIDDEN_PROPERTY
          Property key for the "command hidden" property.
static com.virtuosotechnologies.lib.base.ClassConstrainedKey LONG_DESCRIPTION_PROPERTY
          Property key for the long description property.
static com.virtuosotechnologies.lib.base.ClassConstrainedKey MNEMONIC_CODE_PROPERTY
          Property key for the keyboard mnemonic property.
static com.virtuosotechnologies.lib.base.ClassConstrainedKey NAME_PROPERTY
          Property key for the command name property.
static com.virtuosotechnologies.lib.command.CommandNodeFlavor NULL_FLAVOR
          Null flavor.
static com.virtuosotechnologies.lib.command.CommandNodeFlavor RADIOCONTAINER_FLAVOR
          Radio container flavor.
static com.virtuosotechnologies.lib.command.CommandNodeFlavor RADIOGROUP_FLAVOR
          Radio group flavor.
static com.virtuosotechnologies.lib.command.CommandNodeFlavor RADIOMUTEX_FLAVOR
          Radio mutex flavor.
static com.virtuosotechnologies.lib.base.ClassConstrainedKey SELECTED_CHILD_PROPERTY
          Property key for the selected child property.
static com.virtuosotechnologies.lib.base.ClassConstrainedKey SELECTED_NAME_PROPERTY
          Property key for the command name when selected property.
static com.virtuosotechnologies.lib.base.ClassConstrainedKey SELECTED_SHORT_DESCRIPTION_PROPERTY
          Property key for the icon when selected property.
static com.virtuosotechnologies.lib.base.ClassConstrainedKey SELECTED_SMALL_ICON_PROPERTY
          Property key for the icon when selected property.
static com.virtuosotechnologies.lib.base.ClassConstrainedKey SELECTION_STATE_PROPERTY
          Property key for the selection state property.
static com.virtuosotechnologies.lib.command.CommandNodeFlavor SEPARATOR_FLAVOR
          Separator flavor.
static com.virtuosotechnologies.lib.base.ClassConstrainedKey SHORT_DESCRIPTION_PROPERTY
          Property key for the short description property.
static com.virtuosotechnologies.lib.base.ClassConstrainedKey SMALL_ICON_PROPERTY
          Property key for the icon property.
static com.virtuosotechnologies.lib.command.CommandNodeFlavor TOGGLEITEM_FLAVOR
          Toggle-item flavor.
 
Fields inherited from class com.virtuosotechnologies.lib.command.AbstractCommandNode
 
Fields inherited from class com.virtuosotechnologies.lib.propertyset.BasicPropertySet
 
Fields inherited from interface com.virtuosotechnologies.lib.command.CommandListener
COMMAND_INVOKED_METHOD
 
Constructor Summary
protected BasicCommandNode()
          Constructor.
protected BasicCommandNode(com.virtuosotechnologies.lib.propertyset.PropertySet defaults)
          Constructor.
 
Method Summary
static void dump(com.virtuosotechnologies.lib.command.CommandNode node)
          Dump subgraph to standard error
private static void dump(com.virtuosotechnologies.lib.command.CommandNode node, java.lang.String indent)
          Dump subgraph to standard error
 javax.swing.KeyStroke getAcceleratorKeystrokeProperty()
          Convenience accessor for ACCELERATOR_KEYSTROKE_PROPERTY
static com.virtuosotechnologies.lib.propertyset.PropertySet getDefaultProperties()
          Get the default property set
 boolean getDisabledProperty()
          Convenience accessor for DISABLED_PROPERTY
 boolean getHiddenProperty()
          Convenience accessor for HIDDEN_PROPERTY
 java.lang.String getLongDescriptionProperty()
          Convenience accessor for LONG_DESCRIPTION_PROPERTY
 int getMnemonicCodeProperty()
          Convenience accessor for MNEMONIC_CODE_PROPERTY
 java.lang.String getNameProperty()
          Convenience accessor for NAME_PROPERTY
 com.virtuosotechnologies.lib.command.CommandNode getSelectedChildProperty()
          Convenience accessor for SELECTED_CHILD_PROPERTY
 java.lang.String getSelectedNameProperty()
          Convenience accessor for SELECTED_NAME_PROPERTY
 java.lang.String getSelectedShortDescriptionProperty()
          Convenience accessor for SELECTED_SHORT_DESCRIPTION_PROPERTY
 javax.swing.Icon getSelectedSmallIconProperty()
          Convenience accessor for SELECTED_SMALL_ICON_PROPERTY
 boolean getSelectionStateProperty()
          Convenience accessor for SELECTION_STATE_PROPERTY
 java.lang.String getShortDescriptionProperty()
          Convenience accessor for SHORT_DESCRIPTION_PROPERTY
 javax.swing.Icon getSmallIconProperty()
          Convenience accessor for SMALL_ICON_PROPERTY
 void setAcceleratorKeystrokeProperty(javax.swing.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(java.lang.String value)
          Convenience mutator for LONG_DESCRIPTION_PROPERTY
 void setMnemonicCodeProperty(int value)
          Convenience mutator for MNEMONIC_CODE_PROPERTY
 void setNameProperty(java.lang.String value)
          Convenience mutator for NAME_PROPERTY
 void setSelectedChildProperty(com.virtuosotechnologies.lib.command.CommandNode value)
          Convenience mutator for SELECTED_CHILD_PROPERTY
 void setSelectedNameProperty(java.lang.String value)
          Convenience mutator for SELECTED_NAME_PROPERTY
 void setSelectedShortDescriptionProperty(java.lang.String value)
          Convenience mutator for SELECTED_SHORT_DESCRIPTION_PROPERTY
 void setSelectedSmallIconProperty(javax.swing.Icon value)
          Convenience mutator for SELECTED_SMALL_ICON_PROPERTY
 void setSelectionStateProperty(boolean value)
          Convenience mutator for SELECTION_STATE_PROPERTY
 void setShortDescriptionProperty(java.lang.String value)
          Convenience mutator for SHORT_DESCRIPTION_PROPERTY
 void setSmallIconProperty(javax.swing.Icon value)
          Convenience mutator for SMALL_ICON_PROPERTY
 
Methods inherited from class com.virtuosotechnologies.lib.command.AbstractCommandNode
addChild, addNodeListener, fireAllChildrenRemovedEvent, fireChildAddedEvent, fireChildRemovedEvent, getNthChild, getNumChildren, insertChild, invoke, isChild, removeAllChildren, removeNodeListener, removeNthChild
 
Methods inherited from class com.virtuosotechnologies.lib.propertyset.BasicPropertySet
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.propertyset.PropertySet
addPropertySetListener, getDefaultValue, getValue, putValue, removePropertySetListener, resetValue
 
Methods inherited from interface com.virtuosotechnologies.lib.command.CommandListener
commandInvoked
 

Field Detail

NAME_PROPERTY

public static final com.virtuosotechnologies.lib.base.ClassConstrainedKey NAME_PROPERTY
Property key for the command name property.


SHORT_DESCRIPTION_PROPERTY

public static final com.virtuosotechnologies.lib.base.ClassConstrainedKey SHORT_DESCRIPTION_PROPERTY
Property key for the short description property.


LONG_DESCRIPTION_PROPERTY

public static final com.virtuosotechnologies.lib.base.ClassConstrainedKey LONG_DESCRIPTION_PROPERTY
Property key for the long description property.


ACCELERATOR_KEYSTROKE_PROPERTY

public static final com.virtuosotechnologies.lib.base.ClassConstrainedKey ACCELERATOR_KEYSTROKE_PROPERTY
Property key for the keyboard accelerator property.


MNEMONIC_CODE_PROPERTY

public static final com.virtuosotechnologies.lib.base.ClassConstrainedKey MNEMONIC_CODE_PROPERTY
Property key for the keyboard mnemonic property.


SMALL_ICON_PROPERTY

public static final com.virtuosotechnologies.lib.base.ClassConstrainedKey SMALL_ICON_PROPERTY
Property key for the icon property.


DISABLED_PROPERTY

public static final com.virtuosotechnologies.lib.base.ClassConstrainedKey DISABLED_PROPERTY
Property key for the "command disabled" property.


HIDDEN_PROPERTY

public static final com.virtuosotechnologies.lib.base.ClassConstrainedKey HIDDEN_PROPERTY
Property key for the "command hidden" property.


SELECTION_STATE_PROPERTY

public static final com.virtuosotechnologies.lib.base.ClassConstrainedKey SELECTION_STATE_PROPERTY
Property key for the selection state property.


SELECTED_CHILD_PROPERTY

public static final com.virtuosotechnologies.lib.base.ClassConstrainedKey SELECTED_CHILD_PROPERTY
Property key for the selected child property.


SELECTED_NAME_PROPERTY

public static final com.virtuosotechnologies.lib.base.ClassConstrainedKey SELECTED_NAME_PROPERTY
Property key for the command name when selected property.


SELECTED_SMALL_ICON_PROPERTY

public static final com.virtuosotechnologies.lib.base.ClassConstrainedKey SELECTED_SMALL_ICON_PROPERTY
Property key for the icon when selected property.


SELECTED_SHORT_DESCRIPTION_PROPERTY

public static final com.virtuosotechnologies.lib.base.ClassConstrainedKey SELECTED_SHORT_DESCRIPTION_PROPERTY
Property key for the icon when selected property.


NULL_FLAVOR

public static final com.virtuosotechnologies.lib.command.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 com.virtuosotechnologies.lib.command.CommandNodeFlavor SEPARATOR_FLAVOR
Separator flavor.


ACTIONITEM_FLAVOR

public static final com.virtuosotechnologies.lib.command.CommandNodeFlavor ACTIONITEM_FLAVOR
Action-item flavor.


TOGGLEITEM_FLAVOR

public static final com.virtuosotechnologies.lib.command.CommandNodeFlavor TOGGLEITEM_FLAVOR
Toggle-item flavor.


APPEARANCECHANGING_TOGGLEITEM_FLAVOR

public static final com.virtuosotechnologies.lib.command.CommandNodeFlavor APPEARANCECHANGING_TOGGLEITEM_FLAVOR
Special toggle-item flavor used for appearance-changing items. Subflavor of TOGGLEITEM.


GROUP_FLAVOR

public static final com.virtuosotechnologies.lib.command.CommandNodeFlavor GROUP_FLAVOR
Group flavor.


CONTAINER_FLAVOR

public static final com.virtuosotechnologies.lib.command.CommandNodeFlavor CONTAINER_FLAVOR
Container flavor.


RADIOMUTEX_FLAVOR

public static final com.virtuosotechnologies.lib.command.CommandNodeFlavor RADIOMUTEX_FLAVOR
Radio mutex flavor. An "abstract" flavor never used directly, but it is a parent of all flavors that indicate radio mutexes.


RADIOGROUP_FLAVOR

public static final com.virtuosotechnologies.lib.command.CommandNodeFlavor RADIOGROUP_FLAVOR
Radio group flavor. Subflavor of RADIOMUTEX and GROUP.


RADIOCONTAINER_FLAVOR

public static final com.virtuosotechnologies.lib.command.CommandNodeFlavor RADIOCONTAINER_FLAVOR
Radio container flavor. Subflavor of RADIOMUTEX and CONTAINER.


defaultProperties_

private static com.virtuosotechnologies.lib.propertyset.PropertySet defaultProperties_
Constructor Detail

BasicCommandNode

protected BasicCommandNode()
Constructor.


BasicCommandNode

protected BasicCommandNode(com.virtuosotechnologies.lib.propertyset.PropertySet defaults)
Constructor.

Method Detail

getNameProperty

public java.lang.String getNameProperty()
Convenience accessor for NAME_PROPERTY


setNameProperty

public void setNameProperty(java.lang.String value)
Convenience mutator for NAME_PROPERTY


getShortDescriptionProperty

public java.lang.String getShortDescriptionProperty()
Convenience accessor for SHORT_DESCRIPTION_PROPERTY


setShortDescriptionProperty

public void setShortDescriptionProperty(java.lang.String value)
Convenience mutator for SHORT_DESCRIPTION_PROPERTY


getLongDescriptionProperty

public java.lang.String getLongDescriptionProperty()
Convenience accessor for LONG_DESCRIPTION_PROPERTY


setLongDescriptionProperty

public void setLongDescriptionProperty(java.lang.String value)
Convenience mutator for LONG_DESCRIPTION_PROPERTY


getAcceleratorKeystrokeProperty

public javax.swing.KeyStroke getAcceleratorKeystrokeProperty()
Convenience accessor for ACCELERATOR_KEYSTROKE_PROPERTY


setAcceleratorKeystrokeProperty

public void setAcceleratorKeystrokeProperty(javax.swing.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 javax.swing.Icon getSmallIconProperty()
Convenience accessor for SMALL_ICON_PROPERTY


setSmallIconProperty

public void setSmallIconProperty(javax.swing.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 com.virtuosotechnologies.lib.command.CommandNode getSelectedChildProperty()
Convenience accessor for SELECTED_CHILD_PROPERTY


setSelectedChildProperty

public void setSelectedChildProperty(com.virtuosotechnologies.lib.command.CommandNode value)
Convenience mutator for SELECTED_CHILD_PROPERTY


getSelectedNameProperty

public java.lang.String getSelectedNameProperty()
Convenience accessor for SELECTED_NAME_PROPERTY


setSelectedNameProperty

public void setSelectedNameProperty(java.lang.String value)
Convenience mutator for SELECTED_NAME_PROPERTY


getSelectedSmallIconProperty

public javax.swing.Icon getSelectedSmallIconProperty()
Convenience accessor for SELECTED_SMALL_ICON_PROPERTY


setSelectedSmallIconProperty

public void setSelectedSmallIconProperty(javax.swing.Icon value)
Convenience mutator for SELECTED_SMALL_ICON_PROPERTY


getSelectedShortDescriptionProperty

public java.lang.String getSelectedShortDescriptionProperty()
Convenience accessor for SELECTED_SHORT_DESCRIPTION_PROPERTY


setSelectedShortDescriptionProperty

public void setSelectedShortDescriptionProperty(java.lang.String value)
Convenience mutator for SELECTED_SHORT_DESCRIPTION_PROPERTY


getDefaultProperties

public static com.virtuosotechnologies.lib.propertyset.PropertySet getDefaultProperties()
Get the default property set


dump

public static void dump(com.virtuosotechnologies.lib.command.CommandNode node)
Dump subgraph to standard error


dump

private static void dump(com.virtuosotechnologies.lib.command.CommandNode node,
                         java.lang.String indent)
Dump subgraph to standard error