org.apache.batik.util.gui.resource

Class ButtonFactory

java.lang.Object

org.apache.batik.util.resources.ResourceManager

org.apache.batik.util.gui.resource.ButtonFactory

public class ButtonFactory
extends ResourceManager

This class represents a button factory which builds buttons from the content of a resource bundle.
The resource entries format is (for a button named 'Button'):

   Button.text      = text
   Button.icon      = icon_name
   Button.mnemonic  = mnemonic
   Button.action    = action_name
   Button.selected  = true | false
   Button.tooltip   = tool tip text
 where
   text, icon_name and action_name are strings
   mnemonic is a character
 

Version:

$Id: ButtonFactory.java 1733416 2016-03-03 07:07:13Z gadams $

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	ACTION_SUFFIX
private ActionMap	actions The table which contains the actions
private static java.lang.String	ICON_SUFFIX
private static java.lang.String	MNEMONIC_SUFFIX
private static java.lang.String	SELECTED_SUFFIX
private static java.lang.String	TEXT_SUFFIX
private static java.lang.String	TOOLTIP_SUFFIX

Fields inherited from class org.apache.batik.util.resources.ResourceManager

bundle

Constructor Summary

Constructors

Constructor and Description
ButtonFactory(java.util.ResourceBundle rb, ActionMap am) Creates a new button factory

Method Summary

Modifier and Type	Method and Description
javax.swing.JButton	createJButton(java.lang.String name) Creates and returns a new swing button
javax.swing.JCheckBox	createJCheckBox(java.lang.String name) Creates and returns a new swing check box
javax.swing.JRadioButton	createJRadioButton(java.lang.String name) Creates and returns a new swing radio button
javax.swing.JButton	createJToolbarButton(java.lang.String name) Creates and returns a new swing button initialised to be used as a toolbar button
javax.swing.JToggleButton	createJToolbarToggleButton(java.lang.String name) Creates and returns a new swing button initialised to be used as a toolbar toggle button
private void	initializeButton(javax.swing.AbstractButton b, java.lang.String name) Initializes a button

Methods inherited from class org.apache.batik.util.resources.ResourceManager

getBoolean, getCharacter, getInteger, getString, getStringList, getStringList, getStringList

Methods inherited from class java.lang.Object

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

Field Detail

ICON_SUFFIX

private static final java.lang.String ICON_SUFFIX

See Also:

Constant Field Values

TEXT_SUFFIX

private static final java.lang.String TEXT_SUFFIX

See Also:

Constant Field Values

MNEMONIC_SUFFIX

private static final java.lang.String MNEMONIC_SUFFIX

See Also:

Constant Field Values

ACTION_SUFFIX

private static final java.lang.String ACTION_SUFFIX

See Also:

Constant Field Values

SELECTED_SUFFIX

private static final java.lang.String SELECTED_SUFFIX

See Also:

Constant Field Values

TOOLTIP_SUFFIX

private static final java.lang.String TOOLTIP_SUFFIX

See Also:

Constant Field Values

actions

private ActionMap actions

The table which contains the actions

Constructor Detail

ButtonFactory

public ButtonFactory(java.util.ResourceBundle rb,
                     ActionMap am)

Creates a new button factory

Parameters:

rb - the resource bundle that contains the buttons description.

am - the actions to bind to the button

Method Detail

createJButton

public javax.swing.JButton createJButton(java.lang.String name)
                                  throws java.util.MissingResourceException,
                                         ResourceFormatException,
                                         MissingListenerException

Creates and returns a new swing button

Parameters:

name - the name of the button in the resource bundle

Throws:

java.util.MissingResourceException - if key is not the name of a button. It is not thrown if the mnemonic and the action keys are missing

ResourceFormatException - if the mnemonic is not a single character

MissingListenerException - if the button action is not found in the action map

createJToolbarButton

public javax.swing.JButton createJToolbarButton(java.lang.String name)
                                         throws java.util.MissingResourceException,
                                                ResourceFormatException,
                                                MissingListenerException

Creates and returns a new swing button initialised to be used as a toolbar button

Parameters:

name - the name of the button in the resource bundle

Throws:

java.util.MissingResourceException - if key is not the name of a button. It is not thrown if the mnemonic and the action keys are missing

ResourceFormatException - if the mnemonic is not a single character

MissingListenerException - if the button action is not found in the action map

createJToolbarToggleButton

public javax.swing.JToggleButton createJToolbarToggleButton(java.lang.String name)
                                                     throws java.util.MissingResourceException,
                                                            ResourceFormatException,
                                                            MissingListenerException

Creates and returns a new swing button initialised to be used as a toolbar toggle button

Parameters:

name - the name of the button in the resource bundle

Throws:

java.util.MissingResourceException - if key is not the name of a button. It is not thrown if the mnemonic and the action keys are missing

ResourceFormatException - if the mnemonic is not a single character

MissingListenerException - if the button action is not found in the action map

createJRadioButton

public javax.swing.JRadioButton createJRadioButton(java.lang.String name)
                                            throws java.util.MissingResourceException,
                                                   ResourceFormatException,
                                                   MissingListenerException

Creates and returns a new swing radio button

Parameters:

name - the name of the button in the resource bundle

Throws:

java.util.MissingResourceException - if key is not the name of a button. It is not thrown if the mnemonic and the action keys are missing.

ResourceFormatException - if the mnemonic is not a single character.

MissingListenerException - if the button action is not found in the action map.

createJCheckBox

public javax.swing.JCheckBox createJCheckBox(java.lang.String name)
                                      throws java.util.MissingResourceException,
                                             ResourceFormatException,
                                             MissingListenerException

Creates and returns a new swing check box

Parameters:

name - the name of the button in the resource bundle

Throws:

java.util.MissingResourceException - if key is not the name of a button. It is not thrown if the mnemonic and the action keys are missing

ResourceFormatException - if the mnemonic is not a single character.

MissingListenerException - if the button action is not found in the action map.

initializeButton

private void initializeButton(javax.swing.AbstractButton b,
                              java.lang.String name)
                       throws ResourceFormatException,
                              MissingListenerException

Initializes a button

Parameters:

b - the button to initialize

name - the button's name

Throws:

ResourceFormatException - if the mnemonic is not a single character.

MissingListenerException - if the button action is not found in the action map.