Commander

java.lang.Object
- xal.extension.application.Commander

Direct Known Subclasses:

AcceleratorCommander
```
public class Commander
extends java.lang.Object
```
The Commander manages the commands (actions and menu handlers) that are used in toolbars, menu items and menus. It creates and returns a menubar and a toolbar based on the menu definition for the application. A default menu definition provides the starting point. A custom menu definition can make changes as needed. This class may optionally be overriden to provide custom commands. Alternatively hooks in ApplicationAdaptor, XalDocument and XalWindow allow custom commands to be specified. The XalWindow creates a commander for its document. The commander builds the menu and toolbar and creates the associated actions. The commander is then disposed.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String MENU_DEFINITION_RESOURCE
name for the menu definition resource which may or may not exist

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`MENU_DEFINITION_RESOURCE` name for the menu definition resource which may or may not exist

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Commander(Application application)` Constructor for generating an application commander.
`protected`	`Commander(Commander appCommander, xal.extension.application.XalAbstractDocument document)` Primary Constructor for generating a document commander.
`protected`	`Commander(Commander appCommander, XalDocument document)` Constructor for generating a document commander.
`protected`	`Commander(Commander appCommander, XalInternalDocument document)` Constructor for generating a document commander.
`protected`	`Commander(DesktopApplication application)` Constructor for generating a desktop application commander.
`protected`	`Commander(XalInternalDocument document)` Constructor for generating a document commander.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`javax.swing.Action`	`getAction(java.lang.String actionName)` Get the action with the given name.
`java.lang.String`	`getActionKey(java.lang.String menuItemKey)` Get the action key for the specified menu or menu item by its ID.
`javax.swing.Icon`	`getIcon(java.lang.String itemID)` Get the icon for the specified item.
`java.lang.String[]`	`getItemsAfter(java.lang.String itemID)` Get the array of items following the specified item
`java.lang.String[]`	`getItemsBefore(java.lang.String itemID)` Get the array of items preceding the specified item
`java.lang.String`	`getLabel(java.lang.String itemID)` Get the label for the specified item by its ID.
`javax.swing.JMenuBar`	`getMenubar()` Make and return a new menubar based on the menu definition file.
`javax.swing.ButtonModel`	`getModel(java.lang.String actionKey)` Get the button model corresponding to the specified action key.
`xal.extension.application.ItemState`	`getState(java.lang.String itemID)` Get the state of the item.
`javax.swing.JToolBar`	`getToolbar()` Make and return a new toolbar based on the menu definition file.
`protected void`	`loadBundle(java.net.URL resourceURL)` Load a bundle at the specified URL.
`protected void`	`loadCustomBundle(Application application)` Load a custom bundle if one exists.
`protected void`	`loadCustomBundle(Application application, java.lang.String resourceName)` Load a custom bundle if one exists.
`protected void`	`loadCustomBundle(xal.extension.application.XalAbstractDocument document)` Load a custom bundle for the document if one exists.
`protected void`	`loadCustomDocumentBundle(XalInternalDocument document)` Load a custom bundle for the document if one exists.
`protected void`	`loadDefaultBundle()` Load the default bundle.
`void`	`registerAction(javax.swing.Action action)` Register the action to be used by the commander.
`void`	`registerAction(javax.swing.Action action, javax.swing.ButtonModel model)` Register the action and button model to be used by the commander.
`protected void`	`registerCommands()` Register all application commands (default and custom).
`protected void`	`registerCommands(XalDocument document)` Register all document commands (default and custom).
`protected void`	`registerCommands(XalInternalDocument document)` Register all document commands (default and custom).
`protected void`	`registerCustomCommands()` Subclasses may override this method to provide custom application commands.
`protected void`	`registerCustomCommands(XalDocument document)` Subclasses may override this method to provide custom document commands.
`protected void`	`registerCustomCommands(XalInternalDocument document)` Subclasses may override this method to provide custom document commands.
`protected void`	`registerDesktopCommands()` Register all application commands (default and custom).
`void`	`registerMenuHandler(javax.swing.event.MenuListener handler, java.lang.String name)` Register the menu handler to be used by the commander.
`void`	`registerModel(java.lang.String name, javax.swing.ButtonModel model)` Register the action to be used by the commander.
`protected void`	`registerTextCommands()` Register the actions associated with text components.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MENU_DEFINITION_RESOURCE
```
public static final java.lang.String MENU_DEFINITION_RESOURCE
```
    name for the menu definition resource which may or may not exist
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Commander
```
protected Commander(Commander appCommander,
                    xal.extension.application.XalAbstractDocument document)
```
    Primary Constructor for generating a document commander.
  - Commander
```
protected Commander(Commander appCommander,
                    XalDocument document)
```
    Constructor for generating a document commander.
  - Commander
```
protected Commander(Commander appCommander,
                    XalInternalDocument document)
```
    Constructor for generating a document commander.
  - Commander
```
protected Commander(XalInternalDocument document)
```
    Constructor for generating a document commander.
  - Commander
```
protected Commander(Application application)
```
    Constructor for generating an application commander.
  - Commander
```
protected Commander(DesktopApplication application)
```
    Constructor for generating a desktop application commander.
- Method Detail
  - loadDefaultBundle
```
protected void loadDefaultBundle()
```
    Load the default bundle.
  - loadCustomBundle
```
protected void loadCustomBundle(Application application)
```
    Load a custom bundle if one exists. If a custom bundle exists, it will override and extend the properties found in the default bundle. You can use it to customize your toolbar, menubar and menus.
    
    Parameters:
    
    application - the application for which to load the custom bundle.
  - loadCustomBundle
```
protected void loadCustomBundle(Application application,
                                java.lang.String resourceName)
```
    Load a custom bundle if one exists. If a custom bundle exists, it will override and extend the properties found in the default bundle. You can use it to customize your toolbar, menubar and menus.
    
    Parameters:
    
    application - the application for which to load the custom bundle.
    
    resourceName - name of the properites resource to load.
  - loadCustomBundle
```
protected void loadCustomBundle(xal.extension.application.XalAbstractDocument document)
```
    Load a custom bundle for the document if one exists. If a custom document bundle exists, it will override and extend the properties found in the application bundle. You can use it to customize your toolbar, menubar and menus.
    
    Parameters:
    
    document - the document for which to load the custom bundle.
  - loadCustomDocumentBundle
```
protected void loadCustomDocumentBundle(XalInternalDocument document)
```
    Load a custom bundle for the document if one exists. If a custom document bundle exists, it will override and extend the properties found in the application bundle. You can use it to customize your toolbar, menubar and menus.
    
    Parameters:
    
    document - the document for which to load the custom bundle.
  - loadBundle
```
protected void loadBundle(java.net.URL resourceURL)
```
    Load a bundle at the specified URL.
    
    Parameters:
    
    resourceURL - URL to the resource bundle to load
  - getMenubar
```
public javax.swing.JMenuBar getMenubar()
```
    Make and return a new menubar based on the menu definition file.
    
    Returns:
    
    The new menubar
  - getToolbar
```
public javax.swing.JToolBar getToolbar()
```
    Make and return a new toolbar based on the menu definition file.
    
    Returns:
    
    The new toolbar
  - getModel
```
public javax.swing.ButtonModel getModel(java.lang.String actionKey)
```
    Get the button model corresponding to the specified action key.
    
    Parameters:
    
    actionKey - the key for which to get the button model.
    
    Returns:
    
    the button model.
  - getActionKey
```
public java.lang.String getActionKey(java.lang.String menuItemKey)
```
    Get the action key for the specified menu or menu item by its ID.
    
    Parameters:
    
    menuItemKey - the ID of the menu item for which to get the label
    
    Returns:
    
    the action key for the menu item
  - getLabel
```
public java.lang.String getLabel(java.lang.String itemID)
```
    Get the label for the specified item by its ID. Look for a control entry with the item ID followed by ".label". If the label identifier cannot be found then default to the item ID itself as the label.
    
    Parameters:
    
    itemID - the ID of the menu item for which to get the label
    
    Returns:
    
    the label for the menu item
  - getItemsBefore
```
public java.lang.String[] getItemsBefore(java.lang.String itemID)
```
    Get the array of items preceding the specified item
  - getItemsAfter
```
public java.lang.String[] getItemsAfter(java.lang.String itemID)
```
    Get the array of items following the specified item
  - getIcon
```
public javax.swing.Icon getIcon(java.lang.String itemID)
```
    Get the icon for the specified item.
    
    Parameters:
    
    itemID - the ID of the menu item for which to get the label
    
    Returns:
    
    the icon for the menu or toolbar item
  - getState
```
public xal.extension.application.ItemState getState(java.lang.String itemID)
```
    Get the state of the item.
  - registerCommands
```
protected void registerCommands()
```
    Register all application commands (default and custom). Some of these commands may be associated with documents.
  - registerDesktopCommands
```
protected void registerDesktopCommands()
```
    Register all application commands (default and custom). Some of these commands may be associated with documents.
  - registerCommands
```
protected void registerCommands(XalDocument document)
```
    Register all document commands (default and custom). Some of these commands may be associated with documents.
    
    Parameters:
    
    document - The document for which some commands may need to be associated
  - registerCommands
```
protected void registerCommands(XalInternalDocument document)
```
    Register all document commands (default and custom). Some of these commands may be associated with documents.
    
    Parameters:
    
    document - The document for which some commands may need to be associated
  - registerCustomCommands
```
protected void registerCustomCommands()
```
    Subclasses may override this method to provide custom application commands. Alternatively custom commands may be specified in subclasses of XalDocument, XalWindow and ApplicationAdaptor for convenience.
    
    See Also:
    
    XalAbstractDocument.customizeCommands(xal.extension.application.Commander), XalWindow.customizeCommands(xal.extension.application.Commander), AbstractApplicationAdaptor.customizeCommands(xal.extension.application.Commander)
  - registerCustomCommands
```
protected void registerCustomCommands(XalDocument document)
```
    Subclasses may override this method to provide custom document commands. Alternatively custom commands may be specified in subclasses of XalDocument, XalWindow and ApplicationAdaptor for convenience.
    
    Parameters:
    
    document - The document for which some commands may need to be associated
    
    See Also:
    
    XalAbstractDocument.customizeCommands(xal.extension.application.Commander), XalWindow.customizeCommands(xal.extension.application.Commander), AbstractApplicationAdaptor.customizeCommands(xal.extension.application.Commander)
  - registerCustomCommands
```
protected void registerCustomCommands(XalInternalDocument document)
```
    Subclasses may override this method to provide custom document commands. Alternatively custom commands may be specified in subclasses of XalInternalDocument, XalInternalWindow and ApplicationAdaptor for convenience.
    
    Parameters:
    
    document - The document for which some commands may need to be associated
    
    See Also:
    
    XalAbstractDocument.customizeCommands(xal.extension.application.Commander), XalWindow.customizeCommands(xal.extension.application.Commander), AbstractApplicationAdaptor.customizeCommands(xal.extension.application.Commander)
  - getAction
```
public javax.swing.Action getAction(java.lang.String actionName)
```
    Get the action with the given name.
    
    Parameters:
    
    actionName - The name of the action to get.
    
    Returns:
    
    The action with the given name.
  - registerAction
```
public void registerAction(javax.swing.Action action)
```
    Register the action to be used by the commander. Every action should have a unique name because the commander fetches actions by name.
    
    Parameters:
    
    action - The action to register.
  - registerAction
```
public void registerAction(javax.swing.Action action,
                           javax.swing.ButtonModel model)
```
    Register the action and button model to be used by the commander. Every action should have a unique name because the commander fetches actions by name.
    
    Parameters:
    
    action - The action to register.
    
    model - The button model to associate with the action.
  - registerModel
```
public void registerModel(java.lang.String name,
                          javax.swing.ButtonModel model)
```
    Register the action to be used by the commander. Every action should have a unique name because the commander fetches actions by name.
    
    Parameters:
    
    name - The name to key the model with a button or menu item.
    
    model - The button model to associate with the action.
  - registerMenuHandler
```
public void registerMenuHandler(javax.swing.event.MenuListener handler,
                                java.lang.String name)
```
    Register the menu handler to be used by the commander. Associate the specified name with the menu handler.
    
    Parameters:
    
    handler - The handler to register
    
    name - The unique name to associate with the handler
  - registerTextCommands
```
protected void registerTextCommands()
```
    Register the actions associated with text components.

Class Commander

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MENU_DEFINITION_RESOURCE

Constructor Detail

Commander

Commander

Commander

Commander

Commander

Commander

Method Detail

loadDefaultBundle

loadCustomBundle

loadCustomBundle

loadCustomBundle

loadCustomDocumentBundle

loadBundle

getMenubar

getToolbar

getModel

getActionKey

getLabel

getItemsBefore

getItemsAfter

getIcon

getState

registerCommands

registerDesktopCommands

registerCommands

registerCommands

registerCustomCommands

registerCustomCommands

registerCustomCommands

getAction

registerAction

registerAction

registerModel

registerMenuHandler

registerTextCommands