Class ToolBarLoader

java.lang.Object
   |
   +----ToolBarLoader

class ToolBarLoader
extends Object
Builds up a AWT toolbar by reading the settings from a resource file. A AWT toolbar is a simple Panel with Buttons, that can't get the focus. It's intended to use this class for loading toolbar's created with Magic Menu.


Variable Index

 o ACTION_SUFFIX
Suffix applied to the key used in resource file lookups for an action.
 o defaultAction
 o LABEL_SUFFIX
Suffix applied to the key used in resource file lookups for a label.
 o MNEMONIC_ESCAPE
The escape character to identify a mnemonic in a label.
 o resources
 o STRUT_BLANKS
The blanks for the label between separated AWT toolbar components.

Constructor Index

 o ToolBarLoader(ResourceBundle)
Create a new ToolBarLoader object.

Method Index

 o createTool(String)
Hook through which every toolbar item is created.
 o createToolBar(String)
Create the toolbar for the specified key.
 o createToolBarButton(String)
Create a button to go inside of the toolbar.
 o filterMnemonic(String, char[])
Filters the mnemonic identifiers out of a label string.
 o getAction(String)
Return the default action listener.
 o getDefaultActionListener()
Returns the default action listener.
 o getResourceString(String)
Read a string from the resource file containing the toolbar definition.
 o reportError(String)
This method will be called, if some errors occur.
 o setDefaultActionListener(ActionListener)
Set the default action listener.
 o tokenize(String)
Take the given string and chop it up into a series of strings on whitespace boundries.

Variables

 o LABEL_SUFFIX
 public static final String LABEL_SUFFIX
Suffix applied to the key used in resource file lookups for a label.

 o ACTION_SUFFIX
 public static final String ACTION_SUFFIX
Suffix applied to the key used in resource file lookups for an action.

 o MNEMONIC_ESCAPE
 public static final char MNEMONIC_ESCAPE
The escape character to identify a mnemonic in a label.

 o STRUT_BLANKS
 public static final String STRUT_BLANKS
The blanks for the label between separated AWT toolbar components.

 o resources
 private ResourceBundle resources
 o defaultAction
 private ActionListener defaultAction

Constructors

 o ToolBarLoader
 ToolBarLoader(ResourceBundle resources)
Create a new ToolBarLoader object.

Parameters:
resources - A resources bundle containing the toolbar settings.

Methods

 o filterMnemonic
 private static String filterMnemonic(String label,
                                      char ch[])
Filters the mnemonic identifiers out of a label string.

 o getDefaultActionListener
 public ActionListener getDefaultActionListener()
Returns the default action listener. This ActionListener is registered at every toolbar item.

 o setDefaultActionListener
 public void setDefaultActionListener(ActionListener al)
Set the default action listener. This action listener is registered at every toolbar item. If a ActionListener is set, this should be done before the first call to createToolBar, createTool or createMenuItem.

See Also:
createToolBar, createTool, createToolBarButton
 o createToolBarButton
 protected Button createToolBarButton(String key)
Create a button to go inside of the toolbar.

Parameters:
key - The key in the resource file to serve as the basis of lookups.
 o getAction
 protected ActionListener getAction(String cmd)
Return the default action listener. This Method should be overwritten, if not all tollbar buttons should register the same action listener.

Parameters:
cmd - The action command of the associated toolbar button.
 o getResourceString
 protected String getResourceString(String key)
Read a string from the resource file containing the toolbar definition.

 o tokenize
 protected String[] tokenize(String input)
Take the given string and chop it up into a series of strings on whitespace boundries. This is useful for trying to get an array of strings out of the resource file.

 o createToolBar
 protected Panel createToolBar(String key)
Create the toolbar for the specified key. This pulls the definition of the toolbar from the associated resource bundle.

 o createTool
 protected Component createTool(String key)
Hook through which every toolbar item is created. This method can be used to integrate custom gui elements into the toolbar.

 o reportError
 protected void reportError(String text)
This method will be called, if some errors occur. By default this will cause an output to stderr.