SwingDecorator (CUF2 Parent Project 2.0.8 API)

java.lang.Object
- net.sf.cuf.ui.SwingDecorator

```
public class SwingDecorator
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

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCELERATOR_SUFFIX` Suffix for Accelerators
`static String`	`ICON_MODIFIER_DISABLED` Suffix for the disabled icon
`static String`	`ICON_MODIFIER_NORMAL` Suffix for the normal icon
`static String`	`ICON_MODIFIER_PRESSED` Suffix for the pressed icon
`static String`	`ICON_MODIFIER_ROLLOVER` Suffix for the rollover icon
`static String`	`ICON_MODIFIER_SMALL` Suffix for the small icon
`static String`	`ICON_PREFIX` Prefix for the the icon files
`static String`	`ICON_SUFFIX1` Suffix1 for the the icon files
`static String`	`ICON_SUFFIX2` Suffix2 for the the icon files
`static String`	`ICONNAME_SUFFIX` Suffix for icon (file) names
`static String`	`MNEMONIC_SUFFIX` Suffic for Mnemonics
`static String`	`TEXT_SUFFIX` Suffix for text
`static String`	`TITLE_SUFFIX` Suffix for JFrame and JDialog titles
`static String`	`TOOLTIP_SUFFIX` Suffix for Tooltips

Method Summary

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

- Field Detail
  - TITLE_SUFFIX
```
public static final String TITLE_SUFFIX
```
    Suffix for JFrame and JDialog titles
    
    See Also:
    Constant Field Values
  - TEXT_SUFFIX
```
public static final String TEXT_SUFFIX
```
    Suffix for text
    
    See Also:
    Constant Field Values
  - MNEMONIC_SUFFIX
```
public static final String MNEMONIC_SUFFIX
```
    Suffic for Mnemonics
    
    See Also:
    Constant Field Values
  - ACCELERATOR_SUFFIX
```
public static final String ACCELERATOR_SUFFIX
```
    Suffix for Accelerators
    
    See Also:
    Constant Field Values
  - TOOLTIP_SUFFIX
```
public static final String TOOLTIP_SUFFIX
```
    Suffix for Tooltips
    
    See Also:
    Constant Field Values
  - ICONNAME_SUFFIX
```
public static final String ICONNAME_SUFFIX
```
    Suffix for icon (file) names
    
    See Also:
    Constant Field Values
  - ICON_PREFIX
```
public static final String ICON_PREFIX
```
    Prefix for the the icon files
    
    See Also:
    Constant Field Values
  - ICON_SUFFIX1
```
public static final String ICON_SUFFIX1
```
    Suffix1 for the the icon files
    
    See Also:
    Constant Field Values
  - ICON_SUFFIX2
```
public static final String ICON_SUFFIX2
```
    Suffix2 for the the icon files
    
    See Also:
    Constant Field Values
  - ICON_MODIFIER_NORMAL
```
public static final String ICON_MODIFIER_NORMAL
```
    Suffix for the normal icon
    
    See Also:
    Constant Field Values
  - ICON_MODIFIER_DISABLED
```
public static final String ICON_MODIFIER_DISABLED
```
    Suffix for the disabled icon
    
    See Also:
    Constant Field Values
  - ICON_MODIFIER_PRESSED
```
public static final String ICON_MODIFIER_PRESSED
```
    Suffix for the pressed icon
    
    See Also:
    Constant Field Values
  - ICON_MODIFIER_ROLLOVER
```
public static final String ICON_MODIFIER_ROLLOVER
```
    Suffix for the rollover icon
    
    See Also:
    Constant Field Values
  - ICON_MODIFIER_SMALL
```
public static final String ICON_MODIFIER_SMALL
```
    Suffix for the small icon
    
    See Also:
    Constant Field Values
- Method Detail
  - addBundle
```
public static 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 static 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 static 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 static 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 static 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 static 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 static 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 static 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 Character object containing the mnemonic
  - getAccelerator
```
public static 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 static 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 static 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 static 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 static 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

Class SwingDecorator

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TITLE_SUFFIX

TEXT_SUFFIX

MNEMONIC_SUFFIX

ACCELERATOR_SUFFIX

TOOLTIP_SUFFIX

ICONNAME_SUFFIX

ICON_PREFIX

ICON_SUFFIX1

ICON_SUFFIX2

ICON_MODIFIER_NORMAL

ICON_MODIFIER_DISABLED

ICON_MODIFIER_PRESSED

ICON_MODIFIER_ROLLOVER

ICON_MODIFIER_SMALL

Method Detail

addBundle

addBundle

getText

getText

getToolTip

getTitle

getTitle

getMnemonic

getAccelerator

getIcon

getIcon

initialize

initialize