net.sf.cuf.ui

Class SwingDecoratorFunctionality

java.lang.Object

net.sf.cuf.ui.SwingDecoratorFunctionality

public class SwingDecoratorFunctionality
extends Object

This classes helps a lot for I18N management, and acts as a decorator for Swing components.
Instead of hard-coding a lot of resources (Tooltip, shortcut, name, ..) in Java code, use one or more resource files and SwingDecorator!
The keys in a resource file are called I18nID's, and various aspects of a component are addressed with various suffixes (.title, .text, .mnemonic, .accelerator, .tooltip, .iconname).
Example:
A resource file contains the following lines:
myButton.text=Hello
myButton.tooltip=just an example
myButton.icon=myImage
The code to initialize the button would be something like:
JButton b= new JButton();
b.setName("button");
SwingDecorator.initilize(b, "myButton");


Author:

Jürgen Zeller, jzeller@jzeller.eu

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SwingDecoratorFunctionality.MultiResourceBundle Helper class to support multiple ResourceBundles.

Constructor Summary

Constructors

Constructor and Description
SwingDecoratorFunctionality() Standard constructor.
SwingDecoratorFunctionality(boolean pEnforceSet, IconCache pIconCache) A public constructor for use in SwingXMLBuilder.

Method Summary

Methods

Modifier and Type	Method and Description
void	addBundle(ResourceBundle pResourceBundle) Adds all non-null String key/value pairs of a bundle to the SwingDecorator singleton.
void	addBundle(String pBaseName) Adds a property file to SwingDecorator, see ResourceBundle.getBundle() for the details how the property file is found.
KeyStroke	getAccelerator(String pI18nID) Returns null or a accelerator KeyStroke for the handed key.
Icon	getIcon(String pI18nID) Returns the normal Icon for the handed key or null.
ImageIcon	getIcon(String pI18nID, String pIconModifier) Loads an Icon for the handed key and modifier.
Character	getMnemonic(String pI18nID) Returns null or a Character that is the mnemonic for the handed key.
String	getText(String pI18nID) Returns the I18n text matching the handed key.
String	getText(String pI18nID, Object[] pParams) Returns the I18n text matching the handed key and parameters.
String	getTitle(String pI18nID) Returns the I18n title matching the handed key.
String	getTitle(String pI18nID, Object[] pParams) Returns the I18n title matching the handed key and parameters.
String	getToolTip(String pI18nID, Object[] pParams) Returns the I18n tool tip matching the handed key and parameters.
void	initialize(Action pAction, String pI18nID) Decorates an action by an I18n key.
void	initialize(Component pComponent, String pI18nID) Decorates a widget by an I18n key.
void	initialize(Component pComponent, String pI18nID, Object[] pParams) Decorates a widget by an I18n key.

Methods inherited from class java.lang.Object

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

Constructor Detail

SwingDecoratorFunctionality

public SwingDecoratorFunctionality()

Standard constructor.

SwingDecoratorFunctionality

public SwingDecoratorFunctionality(boolean pEnforceSet,
                           IconCache pIconCache)

A public constructor for use in SwingXMLBuilder.

Parameters:

pEnforceSet - flag if getString() is to always return a real string (and not null)

pIconCache - icon cache (may be null)

Method Detail

addBundle

public void addBundle(String pBaseName)

Adds a property file to SwingDecorator, see ResourceBundle.getBundle() for the details how the property file is found.

Parameters:

pBaseName - base name of the resource bundle

addBundle

public void addBundle(ResourceBundle pResourceBundle)

Adds all non-null String key/value pairs of a bundle to the SwingDecorator singleton.

Parameters:

pResourceBundle - the resource bundle to add, must not be null

getText

public String getText(String pI18nID)

Returns the I18n text matching the handed key. If there is no value for the key, the key is returned.

Parameters:

pI18nID - I18n key

Returns:

matching localized string or "", never null

getText

public String getText(String pI18nID,
             Object[] pParams)

Returns the I18n text matching the handed key and parameters. If there is no value for the key, the key is returned. See MessageFormat.format for the formatting details.

Parameters:

pI18nID - I18n key

pParams - parameters for the message

Returns:

matching localized string or "", never null

getToolTip

public String getToolTip(String pI18nID,
                Object[] pParams)

Returns the I18n tool tip matching the handed key and parameters. If there is no value for the key, the key is returned. See MessageFormat.format for the formatting details.

Parameters:

pI18nID - I18n key

pParams - parameters for the message

Returns:

matching tool tip or pI18nID, never null

getTitle

public String getTitle(String pI18nID)

Returns the I18n title matching the handed key. If there is no value for the key, the key is returned.

Parameters:

pI18nID - I18n key

Returns:

matching title or pI18nID, never null

getTitle

public String getTitle(String pI18nID,
              Object[] pParams)

Returns the I18n title matching the handed key and parameters. If there is no value for the key, the key is returned. See MessageFormat.format for the formatting details.

Parameters:

pI18nID - I18n key

pParams - parameters for the message

Returns:

matching title or "", never null

getMnemonic

public Character getMnemonic(String pI18nID)

Returns null or a Character that is the mnemonic for the handed key.

Parameters:

pI18nID - I18n key

Returns:

null or a Charector object containing the mnemonic

getAccelerator

public KeyStroke getAccelerator(String pI18nID)

Returns null or a accelerator KeyStroke for the handed key.

Parameters:

pI18nID - I18n key

Returns:

null or a KeyStroke containing the propper accelerator.

getIcon

public Icon getIcon(String pI18nID)

Returns the normal Icon for the handed key or null.

Parameters:

pI18nID - I18n key

Returns:

the icon, may be null

getIcon

public ImageIcon getIcon(String pI18nID,
                String pIconModifier)

Loads an Icon for the handed key and modifier. If no icon is found, null is returned.

Parameters:

pI18nID - I18n key

pIconModifier - modifier for the icon name

Returns:

an ImageIcon or null

initialize

public void initialize(Action pAction,
              String pI18nID)

Decorates an action by an I18n key.

Parameters:

pAction - the action to be initialised

pI18nID - I18n key

initialize

public void initialize(Component pComponent,
              String pI18nID)

Decorates a widget by an I18n key.

Parameters:

pComponent - das Widget, das initialisiert werden soll

pI18nID - I18n key

initialize

public void initialize(Component pComponent,
              String pI18nID,
              Object[] pParams)

Decorates a widget by an I18n key.

Parameters:

pComponent - das Widget, das initialisiert werden soll

pI18nID - I18n key

pParams - null or parameters