Class JToolBarLoader
java.lang.Object
|
+----JToolBarLoader
- class JToolBarLoader
- extends Object
Builds up a Swing toolbar by reading the settings from a resource file.
It's intended to use this class for loading toolbar's created with
Magic Menu.
-
ACTION_SUFFIX
- Suffix applied to the key used in resource file
lookups for an action.
-
commands
-
-
defaultAction
-
-
IMAGE_SUFFIX
- Suffix applied to the key used in resource file
lookups for an image.
-
LABEL_SUFFIX
- Suffix applied to the key used in resource file
lookups for a label.
-
MNEMONIC_ESCAPE
- The escape character to identify a mnemonic in a label.
-
resources
-
-
STRUT_SIZE
- The distance between separated toolbar components.
-
TOOLTIP_SUFFIX
- Suffix applied to the key used in resource file
lookups for a tooltip.
-
JToolBarLoader(ResourceBundle)
- Create a new JToolBarLoader object.
-
createTool(String)
- Hook through which every toolbar item is created.
-
createToolBar(String)
- Create the toolbar for the specified key.
-
createToolBarButton(String)
- Create a button to go inside of the toolbar.
-
filterMnemonic(String, char[])
- Filters the mnemonic identifiers out of a label string.
-
getAction(String)
- Return the Action with name cmd stored in the command hashtable.
-
getCommands()
- Returns a hashtable containing the toolbar commands.
-
getDefaultActionListener()
- Return the default action listener.
-
getResource(String)
- Read the name of an image from the resource bundle and convert
if to an URL.
-
getResourceString(String)
- Read a string from the resource file containing the toolbar
definition.
-
loadImageIcon(URL)
- Hook through which ImageIcons are loaded.
-
reportError(String)
- This method will be called, if some errors occur.
-
setCommands(Hashtable)
- Set the hashtable containing the toolbar commands.
-
setDefaultActionListener(ActionListener)
- Set the default action listener.
-
tokenize(String)
- Take the given string and chop it up into a series
of strings on whitespace boundries.
IMAGE_SUFFIX
public static final String IMAGE_SUFFIX
- Suffix applied to the key used in resource file
lookups for an image.
LABEL_SUFFIX
public static final String LABEL_SUFFIX
- Suffix applied to the key used in resource file
lookups for a label.
ACTION_SUFFIX
public static final String ACTION_SUFFIX
- Suffix applied to the key used in resource file
lookups for an action.
TOOLTIP_SUFFIX
public static final String TOOLTIP_SUFFIX
- Suffix applied to the key used in resource file
lookups for a tooltip.
MNEMONIC_ESCAPE
public static final char MNEMONIC_ESCAPE
- The escape character to identify a mnemonic in a label.
STRUT_SIZE
public static final int STRUT_SIZE
- The distance between separated toolbar components.
resources
private ResourceBundle resources
commands
private Hashtable commands
defaultAction
private ActionListener defaultAction
JToolBarLoader
JToolBarLoader(ResourceBundle resources)
- Create a new JToolBarLoader object.
- Parameters:
- resources - A resources bundle containing the toolbar settings.
filterMnemonic
private static String filterMnemonic(String label,
char ch[])
- Filters the mnemonic identifiers out of a label string.
getCommands
public Hashtable getCommands()
- Returns a hashtable containing the toolbar commands. The hashtable
contains pairs of action name and Action object.
setCommands
public void setCommands(Hashtable commands)
- Set the hashtable containing the toolbar commands. This hashtable should
contain pairs of action name and Action object. If a commands hashtable
is set, this should be done before the first call to createToolBar,
createTool or createMenuItem.
- See Also:
- createToolBar, createTool, createToolBarButton
getDefaultActionListener
public ActionListener getDefaultActionListener()
- Return the default action listener. This action listener is registered
at every toolbar item, which has no associated command in the commands
hashtable.
setDefaultActionListener
public void setDefaultActionListener(ActionListener al)
- Set the default action listener. This action listener is registered at
every toolbar item,which has no associated command in the commands
hashtable. If a ActionListener is set, this should be done before the
first call to createToolBar, createTool or createMenuToolBarButton.
- See Also:
- createToolBar, createTool, createToolBarButton
createToolBarButton
protected JButton createToolBarButton(String key)
- Create a button to go inside of the toolbar. By default this
will load an image resource.
- Parameters:
- key - The key in the resource file to serve as the basis
of lookups.
getAction
protected ActionListener getAction(String cmd)
- Return the Action with name cmd stored in the command hashtable.
If it doesn't exist, return the default action listener.
- Parameters:
- cmd - The action command of the associated toolbar button.
getResourceString
protected String getResourceString(String key)
- Read a string from the resource file containing the toolbar
definition.
getResource
protected URL getResource(String key)
- Read the name of an image from the resource bundle and convert
if to an URL. The name in the resource bundle must be a relative
path. It's relative to the location of this class.
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.
createToolBar
protected JToolBar createToolBar(String key)
- Create the toolbar for the specified key. This pulls the
definition of the toolbar from the associated resource bundle.
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.
loadImageIcon
protected ImageIcon loadImageIcon(URL url)
- Hook through which ImageIcons are loaded. If some kind of
image cache should be implemented, this method can be
overwritten.
reportError
protected void reportError(String text)
- This method will be called, if some errors occur. By default this
will cause an output to stderr.