public class ResourceBundleSupport extends Object
The class support references within the resource bundle set to minimize the occurence of duplicate keys. References are given in the format:
a.key.name=@referenced.key
A lookup to a key in an other resource bundle should be written by
a.key.name=@@resourcebundle_name@referenced.key
Modifier | Constructor and Description |
---|---|
|
ResourceBundleSupport(Locale locale,
ResourceBundle resourceBundle)
Creates a new instance.
|
protected |
ResourceBundleSupport(Locale locale,
ResourceBundle resourceBundle,
String baseName)
Creates a new instance.
|
|
ResourceBundleSupport(Locale locale,
String baseName)
Creates a new instance.
|
|
ResourceBundleSupport(ResourceBundle resourceBundle)
Creates a new instance.
|
protected |
ResourceBundleSupport(ResourceBundle resourceBundle,
String baseName)
Creates a new instance.
|
|
ResourceBundleSupport(String baseName)
Creates a new instance.
|
Modifier and Type | Method and Description |
---|---|
JMenu |
createMenu(String keyPrefix)
Returns a JMenu created from a resource bundle definition.
|
Icon |
createTransparentIcon(int width,
int height)
Creates a transparent icon.
|
String |
formatMessage(String key,
Object parameter)
Formats the message stored in the resource bundle (using a
MessageFormat).
|
String |
formatMessage(String key,
Object[] parameters)
Formats the message stored in the resource bundle (using a
MessageFormat).
|
String |
formatMessage(String key,
Object par1,
Object par2)
Formats the message stored in the resource bundle (using a
MessageFormat).
|
Icon |
getIcon(String key)
Returns an unscaled icon.
|
Icon |
getIcon(String key,
boolean large)
Returns an scaled icon suitable for buttons or menus.
|
KeyStroke |
getKeyStroke(String key)
Returns the keystroke stored at the given resourcebundle key.
|
KeyStroke |
getKeyStroke(String key,
int mask)
Returns the keystroke stored at the given resourcebundle key.
|
Locale |
getLocale()
Returns the current locale for this resource bundle.
|
Integer |
getMnemonic(String key)
Returns the mnemonic stored at the given resourcebundle key.
|
KeyStroke |
getOptionalKeyStroke(String key)
Returns an optional key stroke.
|
KeyStroke |
getOptionalKeyStroke(String key,
int mask)
Returns an optional key stroke.
|
Integer |
getOptionalMnemonic(String key)
Returns an optional mnemonic.
|
protected String |
getResourceBase()
The base name of the resource bundle.
|
URL |
getResourceURL(String key)
Returns a URL pointing to a resource located in the classpath.
|
String |
getString(String key)
Gets a string for the given key from this resource bundle or one of its
parents.
|
protected String |
internalGetString(String key)
Performs the lookup for the given key.
|
public ResourceBundleSupport(Locale locale, String baseName)
locale
- the locale.baseName
- the base name of the resource bundle, a fully qualified
class nameprotected ResourceBundleSupport(Locale locale, ResourceBundle resourceBundle, String baseName)
locale
- the locale for which this resource bundle is
created.resourceBundle
- the resourcebundlebaseName
- the base name of the resource bundle, a fully
qualified class namepublic ResourceBundleSupport(Locale locale, ResourceBundle resourceBundle)
locale
- the locale for which the resource bundle is
created.resourceBundle
- the resourcebundlepublic ResourceBundleSupport(String baseName)
baseName
- the base name of the resource bundle, a fully qualified
class nameprotected ResourceBundleSupport(ResourceBundle resourceBundle, String baseName)
resourceBundle
- the resourcebundlebaseName
- the base name of the resource bundle, a fully
qualified class namepublic ResourceBundleSupport(ResourceBundle resourceBundle)
resourceBundle
- the resourcebundleprotected final String getResourceBase()
public String getString(String key)
key
- the key for the desired stringNullPointerException
- if key
is null
MissingResourceException
- if no object for the given key can be
foundClassCastException
- if the object found for the given key is
not a stringprotected String internalGetString(String key)
key
- the key for the stringpublic Icon getIcon(String key, boolean large)
key
- the name of the resource bundle keylarge
- true, if the image should be scaled to 24x24, or false for
16x16public Icon getIcon(String key)
key
- the name of the resource bundle keypublic Integer getMnemonic(String key)
For the enter key, the resource bundle would therefore either contain "ENTER" or "\n".
a.resourcebundle.key=ENTER an.other.resourcebundle.key=\n
key
- the resourcebundle keypublic Integer getOptionalMnemonic(String key)
key
- the key.public KeyStroke getKeyStroke(String key)
The keystroke will be composed of a simple key press and the platform's MenuKeyMask.
The keystrokes character key should be either the symbolic name of one of the KeyEvent.VK_* constants or the character for that key.
For the 'A' key, the resource bundle would therefore either contain "VK_A" or "a".
a.resourcebundle.key=VK_A an.other.resourcebundle.key=a
key
- the resourcebundle keyToolkit.getMenuShortcutKeyMask()
public KeyStroke getOptionalKeyStroke(String key)
key
- the key.public KeyStroke getKeyStroke(String key, int mask)
The keystroke will be composed of a simple key press and the given KeyMask. If the KeyMask is zero, a plain Keystroke is returned.
The keystrokes character key should be either the symbolic name of one of the KeyEvent.VK_* constants or the character for that key.
For the 'A' key, the resource bundle would therefore either contain "VK_A" or "a".
a.resourcebundle.key=VK_A an.other.resourcebundle.key=a
key
- the resourcebundle key.mask
- the mask.Toolkit.getMenuShortcutKeyMask()
public KeyStroke getOptionalKeyStroke(String key, int mask)
key
- the key.mask
- the mask.public JMenu createMenu(String keyPrefix)
The menu definition consists of two keys, the name of the menu and the mnemonic for that menu. Both keys share a common prefix, which is extended by ".name" for the name of the menu and ".mnemonic" for the mnemonic.
# define the file menu menu.file.name=File menu.file.mnemonic=FThe menu definition above can be used to create the menu by calling
createMenu ("menu.file")
.keyPrefix
- the common prefix for that menupublic URL getResourceURL(String key)
Example: The load a file named 'logo.gif' which is stored in a java package named 'org.jfree.resources':
mainmenu.logo=org/jfree/resources/logo.gifThe URL for that file can be queried with:
getResource("mainmenu.logo");
.key
- the key for the resourcepublic Icon createTransparentIcon(int width, int height)
width
- the width of the new iconheight
- the height of the new iconpublic String formatMessage(String key, Object parameter)
key
- the resourcebundle keyparameter
- the parameter for the messagepublic String formatMessage(String key, Object par1, Object par2)
key
- the resourcebundle keypar1
- the first parameter for the messagepar2
- the second parameter for the messagepublic String formatMessage(String key, Object[] parameters)
key
- the resourcebundle keyparameters
- the parameter collection for the messagepublic Locale getLocale()
Copyright © 2001–2018 JFree.org. All rights reserved.