translator
Class TranslatableGUIElement

java.lang.Object
  translator.TranslatableGUIElement

Direct Known Subclasses:

AnimalSpecificTranslatableGUIElement

public class TranslatableGUIElement
extends java.lang.Object

Provides a common interface for translatable GUI element generation Requires an appropriate resource file containing the message translations.

Version:

1.1 2000-01-11

Author:

Guido Rößling ( roessling@acm.org)

Field Summary

protected java.lang.Class<?>	animalImageDummy
protected java.lang.String	GRAPHICS_PATH The path where the graphics are, searched from the CLASSPATH

Constructor Summary

TranslatableGUIElement(Translator t)
Generate a new GUI generator using the concrete Translator passed in

Method Summary

ExtendedAction	generateAction(java.lang.String key, java.lang.Object[] params, java.lang.Object invocationTargetObject, java.lang.Object[] args, boolean isButton) Method for generating a new ExtendedAction insertable to a ToolBar or Menu
ExtendedActionButton	generateActionButton(java.lang.String key, javax.swing.Action theAction) Generate a button encapsulating a predefined Action element
ExtendedActionButton	generateActionButton(java.lang.String key, java.lang.Object[] params, javax.swing.Action theAction) Generate a button encapsulating a predefined Action element
javax.swing.border.Border	generateBorder(java.lang.String key, java.lang.Object[] params)
javax.swing.Box	generateBorderedBox(int alignment, java.lang.String key) Generates a bordered JPanel with the proper label
javax.swing.Box	generateBorderedBox(int alignment, java.lang.String key, java.lang.Object[] params) Generates a bordered JPanel with the proper label
javax.swing.JPanel	generateBorderedJPanel(java.lang.String key) Generates a bordered JPanel with the proper label
javax.swing.JPanel	generateBorderedJPanel(java.lang.String key, java.lang.Object[] params) Generates a bordered JPanel with the proper label
javax.swing.AbstractButton	generateJButton(java.lang.String key) Convenience wrapper for generating a new JButton Internally invokes generateJButton(key, null, false)
javax.swing.AbstractButton	generateJButton(java.lang.String key, java.lang.Object[] params, boolean isToggleButton) Method for generating a new JButton
javax.swing.AbstractButton	generateJButton(java.lang.String key, java.lang.Object[] params, boolean isToggleButton, java.awt.event.ActionListener listener) Method for generating a new JButton
javax.swing.AbstractButton	generateJButton(java.lang.String key, java.lang.Object[] params, boolean isToggleButton, java.awt.event.ActionListener listener, boolean hideLabel) Method for generating a new JButton
javax.swing.JCheckBox	generateJCheckBox(java.lang.String key) Convenience wrapper for generating a new JButton Internally invokes generateJButton(key, null, false)
javax.swing.JCheckBox	generateJCheckBox(java.lang.String key, java.lang.Object[] params, java.awt.event.ActionListener listener) Method for generating a new JCheckBox
javax.swing.JComboBox	generateJComboBox(java.lang.String key, java.lang.Object[] params, java.lang.String[] labels) Convenience wrapper for generating a new JComboBox Internally invokes generateJComboBox(key, params, labels, labels[0])
javax.swing.JComboBox	generateJComboBox(java.lang.String key, java.lang.Object[] params, java.lang.String[] labels, java.lang.String selectedItem) Method for generating a new JComboBox
javax.swing.JFrame	generateJFrame(java.lang.String key) Method for generating a new JFrame
javax.swing.JLabel	generateJLabel(java.lang.String key) Convenience wrapper for generating a new JLabel Internally invokes generateJLabel(key, null)
javax.swing.JLabel	generateJLabel(java.lang.String key, java.lang.Object[] params) Method for generating a new JLabel
javax.swing.JList	generateJList(java.lang.String key, java.lang.Object[] params, java.lang.Object[] labels, int selectionMode, javax.swing.event.ListSelectionListener listener, int selectedIndex) Method for generating a new JList
javax.swing.JMenu	generateJMenu(java.lang.String key) Convenience wrapper for generating a new JMenu Internally invokes generateJMenu(key, null)
javax.swing.JMenu	generateJMenu(java.lang.String key, java.lang.Object[] params) Method for generating a new JMenu
javax.swing.JMenuItem	generateJMenuItem(java.lang.String key) Convenience wrapper for generating a new JMenuItem Internally invokes generateJMenuItem(key, null)
javax.swing.JMenuItem	generateJMenuItem(java.lang.String key, boolean useIcon) Convenience wrapper for generating a new JMenuItem Internally invokes generateJMenuItem(key, null)
javax.swing.JMenuItem	generateJMenuItem(java.lang.String key, java.lang.Object[] params) Method for generating a new JMenuItem
javax.swing.JMenuItem	generateJMenuItem(java.lang.String key, java.lang.Object[] params, boolean useIcon) Method for generating a new JMenuItem
javax.swing.JPopupMenu	generateJPopupMenu(java.lang.String key) Method for generating a new JPopupMenu
javax.swing.JSlider	generateJSlider(java.lang.String key, java.lang.Object[] params, int min, int max, javax.swing.event.ChangeListener listener) Convenience wrapper for generating a new JSlider Internally invokes generateJSlider(key, params, min, max, min, (max-min)/5, (max-min)/20, false, listener)
javax.swing.JSlider	generateJSlider(java.lang.String key, java.lang.Object[] params, int min, int max, int defaultValue, boolean snapMode, javax.swing.event.ChangeListener listener) Convenience wrapper for generating a new JSlider Internally invokes generateJSlider(key, params, min, max, defaultValue, (max-min)/5, (max-min)/20, false, listener)
javax.swing.JSlider	generateJSlider(java.lang.String key, java.lang.Object[] params, int min, int max, int defaultValue, int majorSpacing, int minorSpacing, boolean snapMode, javax.swing.event.ChangeListener listener) Method for generating a new JSlider
javax.swing.JTextField	generateJTextField(java.lang.String key, java.lang.Object[] params, int width, java.lang.String defaultText) Method for generating a new JTextField
javax.swing.JToggleButton	generateJToggleButton(java.lang.String key, java.lang.Object[] params, java.awt.event.ActionListener listener, boolean isRadioButton)
javax.swing.border.Border	generateTitledBorder(java.lang.String key)
javax.swing.JMenuItem	generateToggleableJMenuItem(java.lang.String key, java.lang.Object[] params, boolean isCheckBox) Convenience wrapper for generating a new toggleable JMenuItem Internally invokes generateToggleableJMenuItem(key, params, isCheckBox, false)
javax.swing.JMenuItem	generateToggleableJMenuItem(java.lang.String key, java.lang.Object[] params, boolean isCheckBox, boolean isSelected) Method for generating a new toggleable JMenuItem
javax.swing.ImageIcon	getImageIcon(java.lang.String name) returns the imageIcon with the given name.
protected Translator	getTranslator()
javax.swing.AbstractButton	insertToMenu(java.lang.String key, java.lang.Object[] params, java.lang.Object invocationTargetObject, java.lang.Object[] args, javax.swing.JMenu menu) Convenience method for adding a new element to a menu Internally invokes insertMenuToolBar(key, params, invocationTargetObject, args, menu, null)
javax.swing.AbstractButton	insertToMenuAndToolBar(java.lang.String key, java.lang.Object[] params, java.lang.Object invocationTargetObject, java.lang.Object[] args, javax.swing.JMenu menu, javax.swing.JToolBar toolBar) Convenience method for adding a new element to a menu and toolbar Internally invokes insertMenuToolBar(key, params, invocationTargetObject, args, menu, toolBar)
javax.swing.AbstractButton	insertToMenuAndToolBar(java.lang.String key, java.lang.Object[] params, java.lang.Object invocationTargetObject, java.lang.Object[] args, javax.swing.JPopupMenu menu, javax.swing.JToolBar toolBar) Convenience method for adding a new element to a popup menu and toolbar Internally invokes insertMenuToolBar(key, params, invocationTargetObject, args, menu, toolBar)
javax.swing.AbstractButton	insertToPopupMenu(java.lang.String key, java.lang.Object[] params, java.lang.Object invocationTargetObject, java.lang.Object[] args, javax.swing.JPopupMenu menu) Convenience method for adding a new element to a popup menu Internally invokes insertMenuToolBar(key, params, invocationTargetObject, args, menu, null)
javax.swing.AbstractButton	insertToToolBar(java.lang.String key, java.lang.Object[] params, java.lang.Object invocationTargetObject, java.lang.Object[] args, javax.swing.JToolBar toolBar) Convenience method for adding a new element to a toolbar Internally invokes insertMenuToolBar(key, params, invocationTargetObject, args, null, toolBar)
void	insertTranslatableTab(java.lang.String tabKey, java.awt.Component component, javax.swing.JTabbedPane tabbedPane)
void	insertTranslatableTab(java.lang.String tabKey, java.lang.Object[] params, java.awt.Component component, javax.swing.JTabbedPane tabbedPane)
protected void	registerComponent(java.lang.String key, java.awt.Component component)
void	setGraphicsPath(java.lang.String path)
void	setTranslator(Translator t)
void	translateGUIElements() Translate all registered components using the resource file
void	unregisterComponent(java.lang.String key, java.awt.Component component)
protected void	updateComponent(java.lang.String key, java.awt.Component component)
protected void	updateVectorElements(java.lang.String key, java.util.Vector<java.lang.Object> elements)

Methods inherited from class java.lang.Object

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

Field Detail

GRAPHICS_PATH

protected java.lang.String GRAPHICS_PATH

The path where the graphics are, searched from the CLASSPATH

animalImageDummy

protected java.lang.Class<?> animalImageDummy

Constructor Detail

TranslatableGUIElement

public TranslatableGUIElement(Translator t)

Generate a new GUI generator using the concrete Translator passed in

Parameters:

t - the current Translator for this object

Method Detail

getImageIcon

public javax.swing.ImageIcon getImageIcon(java.lang.String name)

returns the imageIcon with the given name. Note: The preffered approach is to create a directory "graphics", which includes a class "AnimalGraphicsDummy" (which may be empty), and place all icons there. In this way, they will also be loaded if the program is packaged into a JAR file.

Returns:

null if the Icon could not be found or read,
the Icon otherwise.

setGraphicsPath

public void setGraphicsPath(java.lang.String path)

setTranslator

public void setTranslator(Translator t)

getTranslator

protected Translator getTranslator()

generateAction

public ExtendedAction generateAction(java.lang.String key,
                                     java.lang.Object[] params,
                                     java.lang.Object invocationTargetObject,
                                     java.lang.Object[] args,
                                     boolean isButton)

Method for generating a new ExtendedAction insertable to a ToolBar or Menu

Parameters:

key - the key for the ExtendedAction

params - the objects used for determining the message -- see Translator.translateMessage(String, Object[])

invocationTargetObject - the object on which the method defined in the resource file is to be executed

args - the arguments for the method call

isButton - if true, generate without label ("button" semantics)

Returns:

the generated ExtendedAction

See Also:

Translator.translateMessage(String, Object[])

generateActionButton

public ExtendedActionButton generateActionButton(java.lang.String key,
                                                 javax.swing.Action theAction)

Generate a button encapsulating a predefined Action element

Parameters:

key - the key for this button

theAction - the action to be encapsulated

Returns:

the created object

generateActionButton

public ExtendedActionButton generateActionButton(java.lang.String key,
                                                 java.lang.Object[] params,
                                                 javax.swing.Action theAction)

Generate a button encapsulating a predefined Action element

Parameters:

key - the key for this button

params - the parameters needed for formatting the text of the button

theAction - the action to be encapsulated

Returns:

the created object

generateJButton

public javax.swing.AbstractButton generateJButton(java.lang.String key)

Convenience wrapper for generating a new JButton Internally invokes generateJButton(key, null, false)

Parameters:

key - the key for the JButton

Returns:

the generated AbstractButton

See Also:

generateJButton(String, Object[], boolean)

generateJButton

public javax.swing.AbstractButton generateJButton(java.lang.String key,
                                                  java.lang.Object[] params,
                                                  boolean isToggleButton)

Method for generating a new JButton

Parameters:

key - the key for the JButton

params - the objects used for determining the message -- see Translator.translateMessage(String, Object[])

isToggleButton - if true, button is toggleable

Returns:

the generated AbstractButton

See Also:

Translator.translateMessage(String, Object[])

generateJButton

public javax.swing.AbstractButton generateJButton(java.lang.String key,
                                                  java.lang.Object[] params,
                                                  boolean isToggleButton,
                                                  java.awt.event.ActionListener listener)

Method for generating a new JButton

Parameters:

key - the key for the JButton

params - the objects used for determining the message -- see Translator.translateMessage(String, Object[])

isToggleButton - if true, button is toggleable

listener - the ActionListener to be registered with the component

Returns:

the generated AbstractButton

See Also:

Translator.translateMessage(String, Object[])

generateJButton

public javax.swing.AbstractButton generateJButton(java.lang.String key,
                                                  java.lang.Object[] params,
                                                  boolean isToggleButton,
                                                  java.awt.event.ActionListener listener,
                                                  boolean hideLabel)

Method for generating a new JButton

Parameters:

key - the key for the JButton

params - the objects used for determining the message -- see Translator.translateMessage(String, Object[])

isToggleButton - if true, button is toggleable

listener - the ActionListener to be registered with the component

hideLabel - if true, hide the label even if it exists (e.g., for a Toolbar)

Returns:

the generated AbstractButton

See Also:

Translator.translateMessage(String, Object[])

generateJCheckBox

public javax.swing.JCheckBox generateJCheckBox(java.lang.String key)

Convenience wrapper for generating a new JButton Internally invokes generateJButton(key, null, false)

Parameters:

key - the key for the JButton

Returns:

the generated AbstractButton

See Also:

generateJButton(String, Object[], boolean)

generateJCheckBox

public javax.swing.JCheckBox generateJCheckBox(java.lang.String key,
                                               java.lang.Object[] params,
                                               java.awt.event.ActionListener listener)

Method for generating a new JCheckBox

Parameters:

key - the key for the JCheckBox

params - the objects used for determining the message -- see Translator.translateMessage(String, Object[])

listener - the ActionListener to be registered with the component

Returns:

the generated JCheckBox

See Also:

Translator.translateMessage(String, Object[])

generateJToggleButton

public javax.swing.JToggleButton generateJToggleButton(java.lang.String key,
                                                       java.lang.Object[] params,
                                                       java.awt.event.ActionListener listener,
                                                       boolean isRadioButton)

generateJComboBox

public javax.swing.JComboBox generateJComboBox(java.lang.String key,
                                               java.lang.Object[] params,
                                               java.lang.String[] labels)

Convenience wrapper for generating a new JComboBox Internally invokes generateJComboBox(key, params, labels, labels[0])

Parameters:

key - the key for the JComboBox

params - the objects used for determining the message -- see Translator.translateMessage(String, Object[])

labels - the labels for the JComboBox

Returns:

the generated JComboBox

See Also:

generateJComboBox(String, Object[], String[], String), Translator.translateMessage(String, Object[])

generateJComboBox

public javax.swing.JComboBox generateJComboBox(java.lang.String key,
                                               java.lang.Object[] params,
                                               java.lang.String[] labels,
                                               java.lang.String selectedItem)

Method for generating a new JComboBox

Parameters:

key - the key for the JComboBox

params - the objects used for determining the message -- see Translator.translateMessage(String, Object[])

labels - the labels for the JComboBox

selectedItem - the default item

Returns:

the generated JComboBox

See Also:

Translator.translateMessage(String, Object[])

generateJPopupMenu

public javax.swing.JPopupMenu generateJPopupMenu(java.lang.String key)

Method for generating a new JPopupMenu

Parameters:

key - the key for the JPopupMenu

Returns:

the generated JPopupMenu

generateJFrame

public javax.swing.JFrame generateJFrame(java.lang.String key)

Method for generating a new JFrame

Parameters:

key - the key for the JFrame

Returns:

the generated JFrame

generateJLabel

public javax.swing.JLabel generateJLabel(java.lang.String key)

Convenience wrapper for generating a new JLabel Internally invokes generateJLabel(key, null)

Parameters:

key - the key for the JLabel

Returns:

the generated JLabel

See Also:

generateJLabel(String, Object[])

generateJLabel

public javax.swing.JLabel generateJLabel(java.lang.String key,
                                         java.lang.Object[] params)

Method for generating a new JLabel

Parameters:

key - the key for the JLabel

params - the objects used for determining the message -- see Translator.translateMessage(String, Object[])

Returns:

the generated JLabel

See Also:

Translator.translateMessage(String, Object[])

generateJList

public javax.swing.JList generateJList(java.lang.String key,
                                       java.lang.Object[] params,
                                       java.lang.Object[] labels,
                                       int selectionMode,
                                       javax.swing.event.ListSelectionListener listener,
                                       int selectedIndex)

Method for generating a new JList

Parameters:

key - the key for the JList

params - the objects used for determining the message -- see Translator.translateMessage(String, Object[])

labels - the labels for the JComboBox

selectionMode - the selection mode for the list

listener - the ListSelectionListener for the events

selectedIndex - the index of the default item

Returns:

the generated JList

See Also:

Translator.translateMessage(String, Object[])

generateJMenu

public javax.swing.JMenu generateJMenu(java.lang.String key)

Convenience wrapper for generating a new JMenu Internally invokes generateJMenu(key, null)

Parameters:

key - the key for the JMenu

Returns:

the generated JMenu

See Also:

generateJMenu(String, Object[])

generateJMenu

public javax.swing.JMenu generateJMenu(java.lang.String key,
                                       java.lang.Object[] params)

Method for generating a new JMenu

Parameters:

key - the key for the JMenu

params - the objects used for determining the message -- see Translator.translateMessage(String, Object[])

Returns:

the generated JMenu

See Also:

Translator.translateMessage(String, Object[])

generateJMenuItem

public javax.swing.JMenuItem generateJMenuItem(java.lang.String key)

Convenience wrapper for generating a new JMenuItem Internally invokes generateJMenuItem(key, null)

Parameters:

key - the key for the JMenuItem

Returns:

the generated JMenuItem

See Also:

generateJMenuItem(String, Object[])

generateJMenuItem

public javax.swing.JMenuItem generateJMenuItem(java.lang.String key,
                                               boolean useIcon)

Convenience wrapper for generating a new JMenuItem Internally invokes generateJMenuItem(key, null)

Parameters:

key - the key for the JMenuItem

useIcon - if true, show an associated icon

Returns:

the generated JMenuItem

See Also:

generateJMenuItem(String, Object[])

generateJMenuItem

public javax.swing.JMenuItem generateJMenuItem(java.lang.String key,
                                               java.lang.Object[] params)

Method for generating a new JMenuItem

Parameters:

key - the key for the JMenuItem

params - the objects used for determining the message -- see Translator.translateMessage(String, Object[])

Returns:

the generated JMenuItem

See Also:

Translator.translateMessage(String, Object[])

generateJMenuItem

public javax.swing.JMenuItem generateJMenuItem(java.lang.String key,
                                               java.lang.Object[] params,
                                               boolean useIcon)

Method for generating a new JMenuItem

Parameters:

key - the key for the JMenuItem

params - the objects used for determining the message -- see Translator.translateMessage(String, Object[])

useIcon - if true, show an associated icon

Returns:

the generated JMenuItem

See Also:

Translator.translateMessage(String, Object[])

generateBorderedJPanel

public javax.swing.JPanel generateBorderedJPanel(java.lang.String key)

Generates a bordered JPanel with the proper label

Parameters:

key - the key for looking up the title of the bordered panel

Returns:

a bordered JPanel with the proper title

generateBorderedJPanel

public javax.swing.JPanel generateBorderedJPanel(java.lang.String key,
                                                 java.lang.Object[] params)

Generates a bordered JPanel with the proper label

Parameters:

key - the key for looking up the title of the bordered panel

params - optional parameters (may be null) for defining the title

Returns:

a bordered JPanel with the proper title

generateTitledBorder

public javax.swing.border.Border generateTitledBorder(java.lang.String key)

generateBorder

public javax.swing.border.Border generateBorder(java.lang.String key,
                                                java.lang.Object[] params)

generateBorderedBox

public javax.swing.Box generateBorderedBox(int alignment,
                                           java.lang.String key)

Generates a bordered JPanel with the proper label

Parameters:

key - the key for looking up the title of the bordered panel

Returns:

a bordered JPanel with the proper title

generateBorderedBox

public javax.swing.Box generateBorderedBox(int alignment,
                                           java.lang.String key,
                                           java.lang.Object[] params)

Generates a bordered JPanel with the proper label

Parameters:

key - the key for looking up the title of the bordered panel

params - optional parameters (may be null) for defining the title

Returns:

a bordered JPanel with the proper title

generateJSlider

public javax.swing.JSlider generateJSlider(java.lang.String key,
                                           java.lang.Object[] params,
                                           int min,
                                           int max,
                                           javax.swing.event.ChangeListener listener)

Convenience wrapper for generating a new JSlider Internally invokes generateJSlider(key, params, min, max, min, (max-min)/5, (max-min)/20, false, listener)

Parameters:

key - the key for the JSlider

params - the objects used for determining the message -- see Translator.translateMessage(String, Object[])

min - the minimum value for the JSlider

max - the maximum value for the JSlider

listener - the ChangeListener for the JSlider

Returns:

the generated JSlider

See Also:

generateJSlider(String, Object[], int, int, int, int, int, boolean, ChangeListener), Translator.translateMessage(String, Object[])

generateJSlider

public javax.swing.JSlider generateJSlider(java.lang.String key,
                                           java.lang.Object[] params,
                                           int min,
                                           int max,
                                           int defaultValue,
                                           boolean snapMode,
                                           javax.swing.event.ChangeListener listener)

Convenience wrapper for generating a new JSlider Internally invokes generateJSlider(key, params, min, max, defaultValue, (max-min)/5, (max-min)/20, false, listener)

Parameters:

key - the key for the JSlider

params - the objects used for determining the message -- see Translator.translateMessage(String, Object[])

min - the minimum value for the JSlider

max - the maximum value for the JSlider

defaultValue - the default value for the JSlider

snapMode - determines if the "snap" is on: user can only select ticks

listener - the ChangeListener for the JSlider

Returns:

the generated JSlider

See Also:

generateJSlider(String, Object[], int, int, int, int, int, boolean, ChangeListener), Translator.translateMessage(String, Object[])

generateJSlider

public javax.swing.JSlider generateJSlider(java.lang.String key,
                                           java.lang.Object[] params,
                                           int min,
                                           int max,
                                           int defaultValue,
                                           int majorSpacing,
                                           int minorSpacing,
                                           boolean snapMode,
                                           javax.swing.event.ChangeListener listener)

Method for generating a new JSlider

Parameters:

key - the key for the JSlider

params - the objects used for determining the message -- see Translator.translateMessage(String, Object[])

min - the minimum value for the JSlider

max - the maximum value for the JSlider

defaultValue - the default value for the JSlider

majorSpacing - the spacing for 'major' ticks

minorSpacing - the spacing for 'minor' ticks

snapMode - determines if the "snap" is on: user can only select ticks

listener - the ChangeListener for the JSlider

Returns:

the generated JSlider

See Also:

Translator.translateMessage(String, Object[])

generateJTextField

public javax.swing.JTextField generateJTextField(java.lang.String key,
                                                 java.lang.Object[] params,
                                                 int width,
                                                 java.lang.String defaultText)

Method for generating a new JTextField

Parameters:

key - the key for the JTextField

params - the objects used for determining the message -- see Translator.translateMessage(String, Object[])

width - the width of the text field

defaultText - the default text

Returns:

the generated JTextField

See Also:

Translator.translateMessage(String, Object[])

insertTranslatableTab

public void insertTranslatableTab(java.lang.String tabKey,
                                  java.awt.Component component,
                                  javax.swing.JTabbedPane tabbedPane)

insertTranslatableTab

public void insertTranslatableTab(java.lang.String tabKey,
                                  java.lang.Object[] params,
                                  java.awt.Component component,
                                  javax.swing.JTabbedPane tabbedPane)

generateToggleableJMenuItem

public javax.swing.JMenuItem generateToggleableJMenuItem(java.lang.String key,
                                                         java.lang.Object[] params,
                                                         boolean isCheckBox)

Convenience wrapper for generating a new toggleable JMenuItem Internally invokes generateToggleableJMenuItem(key, params, isCheckBox, false)

Parameters:

key - the key for the JMenuItem

params - the objects used for determining the message -- see Translator.translateMessage(String, Object[])

isCheckBox - if true, use Checkbox semantics, otherwise use radio button semantics

Returns:

the generated JMenuItem

See Also:

generateToggleableJMenuItem(String, Object[], boolean, boolean)

generateToggleableJMenuItem

public javax.swing.JMenuItem generateToggleableJMenuItem(java.lang.String key,
                                                         java.lang.Object[] params,
                                                         boolean isCheckBox,
                                                         boolean isSelected)

Method for generating a new toggleable JMenuItem

Parameters:

key - the key for the JMenuItem

params - the objects used for determining the message -- see Translator.translateMessage(String, Object[])

isCheckBox - if true, use Checkbox semantics, otherwise use radio button semantics

isSelected - if true, mark as selected.

Returns:

the generated JMenuItem

insertToMenu

public javax.swing.AbstractButton insertToMenu(java.lang.String key,
                                               java.lang.Object[] params,
                                               java.lang.Object invocationTargetObject,
                                               java.lang.Object[] args,
                                               javax.swing.JMenu menu)

Convenience method for adding a new element to a menu Internally invokes insertMenuToolBar(key, params, invocationTargetObject, args, menu, null)

Parameters:

key - the key for the element

params - the objects used for determining the message -- see Translator.translateMessage(String, Object[])

invocationTargetObject - the object on which the method defined in the resource file is to be executed

args - the arguments for the method call

menu - the JMenu to which the element is to be added

Returns:

the generated AbtractButton

See Also:

Translator.translateMessage(String, Object[])

insertToPopupMenu

public javax.swing.AbstractButton insertToPopupMenu(java.lang.String key,
                                                    java.lang.Object[] params,
                                                    java.lang.Object invocationTargetObject,
                                                    java.lang.Object[] args,
                                                    javax.swing.JPopupMenu menu)

Convenience method for adding a new element to a popup menu Internally invokes insertMenuToolBar(key, params, invocationTargetObject, args, menu, null)

Parameters:

key - the key for the element

params - the objects used for determining the message -- see Translator.translateMessage(String, Object[])

invocationTargetObject - the object on which the method defined in the resource file is to be executed

args - the arguments for the method call

menu - the JPopupMenu to which the element is to be added

Returns:

the generated AbstractButton

See Also:

Translator.translateMessage(String, Object[])

insertToToolBar

public javax.swing.AbstractButton insertToToolBar(java.lang.String key,
                                                  java.lang.Object[] params,
                                                  java.lang.Object invocationTargetObject,
                                                  java.lang.Object[] args,
                                                  javax.swing.JToolBar toolBar)

Convenience method for adding a new element to a toolbar Internally invokes insertMenuToolBar(key, params, invocationTargetObject, args, null, toolBar)

Parameters:

key - the key for the element

params - the objects used for determining the message -- see Translator.translateMessage(String, Object[])

invocationTargetObject - the object on which the method defined in the resource file is to be executed

args - the arguments for the method call

toolBar - the JToolBar to which the element is to be added

Returns:

the generated AbstractButton

See Also:

Translator.translateMessage(String, Object[])

insertToMenuAndToolBar

public javax.swing.AbstractButton insertToMenuAndToolBar(java.lang.String key,
                                                         java.lang.Object[] params,
                                                         java.lang.Object invocationTargetObject,
                                                         java.lang.Object[] args,
                                                         javax.swing.JMenu menu,
                                                         javax.swing.JToolBar toolBar)

Convenience method for adding a new element to a menu and toolbar Internally invokes insertMenuToolBar(key, params, invocationTargetObject, args, menu, toolBar)

Parameters:

key - the key for the element

params - the objects used for determining the message -- see Translator.translateMessage(String, Object[])

invocationTargetObject - the object on which the method defined in the resource file is to be executed

args - the arguments for the method call

menu - the JMenu to which the element is to be added

toolBar - the JToolBar to which the element is to be added

Returns:

the generated AbstractButton

See Also:

Translator.translateMessage(String, Object[])

insertToMenuAndToolBar

public javax.swing.AbstractButton insertToMenuAndToolBar(java.lang.String key,
                                                         java.lang.Object[] params,
                                                         java.lang.Object invocationTargetObject,
                                                         java.lang.Object[] args,
                                                         javax.swing.JPopupMenu menu,
                                                         javax.swing.JToolBar toolBar)

Convenience method for adding a new element to a popup menu and toolbar Internally invokes insertMenuToolBar(key, params, invocationTargetObject, args, menu, toolBar)

Parameters:

key - the key for the element

params - the objects used for determining the message -- see Translator.translateMessage(String, Object[])

invocationTargetObject - the object on which the method defined in the resource file is to be executed

args - the arguments for the method call

menu - the JPopupMenu to which the element is to be added

toolBar - the JToolBar to which the element is to be added

Returns:

the generated AbstractButton

See Also:

Translator.translateMessage(String, Object[])

registerComponent

protected void registerComponent(java.lang.String key,
                                 java.awt.Component component)

unregisterComponent

public void unregisterComponent(java.lang.String key,
                                java.awt.Component component)

translateGUIElements

public void translateGUIElements()

Translate all registered components using the resource file

updateComponent

protected void updateComponent(java.lang.String key,
                               java.awt.Component component)

updateVectorElements

protected void updateVectorElements(java.lang.String key,
                                    java.util.Vector<java.lang.Object> elements)