|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.jdesktop.swingx.plaf.UIManagerExt
public class UIManagerExt
A utility class for obtaining configuration properties from the
UIDefaults. This class handles SwingX-specific L&F needs, such as
the installation of painters and shapes. There are several categories of
utility methods:
UIResources.UIResource types, such as
PainterUIResource.UIDefaults.String localizations from
ResourceBundles.
The getSafeXXX methods are designed for use with
LookAndFeelAddons. Any addon that attempts to obtain a property
defined in the defaults (available from UIManager.get) to set a
property that will be added to the defaults for the addon should use the
"safe" methods. The methods ensure that a valid value is always returned and
that value is a UIResource.
UIManagerExt supports the retrieval of new UIResource types.
There is a getXXX method for every UIResource subtype in the
org.jdesktop.swingx.plaf package.
UIManagerExt enables dynamic localization by supporting
ResourceBundles. The
UIDefaults.addResourceBundle(String) allows resource bundles to
be added to the UIDefaults. While there is support for this feature
in core, there is a bug with the class loader that prevents user added
bundles from working correctly when used via Web Start. Therefore,
UIManagerExt defines methods to add and remove resource bundles.
These are the only methods that SwingX classes should use when adding
resource bundles to the defaults. Since UIManagerExt is maintaining
the bundles, any localized Strings must be retrieved from
the getString methods in this class.
String Localization Values
All methods work by first determining if the value is present
UIDefaults. If the value is not present, then the installed
ResourceBundles are queried. UIManagerExt will attempt to
convert any returned value to the appropriate type. For instance,
getInt uses Integer.decode to convert Strings
returned from the bundle into ints.
UIManager,
UIDefaults| Method Summary | |
|---|---|
static void |
addResourceBundle(java.lang.String bundleName)
Adds a resource bundle to the list of resource bundles that are searched for localized values. |
static boolean |
getBoolean(java.lang.Object key)
Returns an Boolean from the defaults. |
static boolean |
getBoolean(java.lang.Object key,
java.util.Locale l)
Returns an Boolean from the defaults. |
static java.awt.Color |
getColor(java.lang.Object key)
Returns a color from the defaults. |
static java.awt.Color |
getColor(java.lang.Object key,
java.util.Locale l)
Returns a color from the defaults. |
static int |
getInt(java.lang.Object key)
Returns an integer from the defaults. |
static int |
getInt(java.lang.Object key,
java.util.Locale l)
Returns an integer from the defaults. |
static Painter<?> |
getPainter(java.lang.Object key)
Returns a painter from the defaults. |
static Painter<?> |
getPainter(java.lang.Object key,
java.util.Locale l)
Returns a painter from the defaults that is appropriate for the given locale. |
static javax.swing.border.Border |
getSafeBorder(java.lang.Object key,
javax.swing.border.Border defaultBorder)
Returns a border from the defaults. |
static java.awt.Color |
getSafeColor(java.lang.Object key,
java.awt.Color defaultColor)
Returns a color from the defaults. |
static java.awt.Dimension |
getSafeDimension(java.lang.Object key,
java.awt.Dimension defaultDimension)
Returns a dimension from the defaults. |
static java.awt.Font |
getSafeFont(java.lang.Object key,
java.awt.Font defaultFont)
Returns a font from the defaults. |
static javax.swing.Icon |
getSafeIcon(java.lang.Object key,
javax.swing.Icon defaultIcon)
Returns an icon from the defaults. |
static java.awt.Insets |
getSafeInsets(java.lang.Object key,
java.awt.Insets defaultInsets)
Returns an insets from the defaults. |
static java.awt.Shape |
getShape(java.lang.Object key)
Returns a shape from the defaults. |
static java.awt.Shape |
getShape(java.lang.Object key,
java.util.Locale l)
Returns a shape from the defaults that is appropriate for the given locale. |
static java.lang.String |
getString(java.lang.Object key)
Returns a string from the defaults. |
static java.lang.String |
getString(java.lang.Object key,
java.util.Locale l)
Returns a string from the defaults. |
static void |
removeResourceBundle(java.lang.String bundleName)
Removes a resource bundle from the list of resource bundles that are searched for localized defaults. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Method Detail |
|---|
public static void addResourceBundle(java.lang.String bundleName)
bundleName - the base name of the resource bundle to be addedResourceBundle,
removeResourceBundle(java.lang.String)public static void removeResourceBundle(java.lang.String bundleName)
bundleName - the base name of the resource bundle to be removedResourceBundle,
addResourceBundle(java.lang.String)public static java.lang.String getString(java.lang.Object key)
key is not a
String, null is returned.
key - an Object specifying the string
String object
java.lang.NullPointerException - if key is null
public static java.lang.String getString(java.lang.Object key,
java.util.Locale l)
key is not a
String, null is returned.
key - an Object specifying the stringl - the Locale for which the painter is desired; refer
to UIDefaults for details on how a null
Locale is handled
String object
java.lang.NullPointerException - if key is nullpublic static int getInt(java.lang.Object key)
key is not
an int, 0 is returned.
key - an Object specifying the integer
int
java.lang.NullPointerException - if key is null
public static int getInt(java.lang.Object key,
java.util.Locale l)
key is not
an int, 0 is returned.
key - an Object specifying the integerl - the Locale for which the integer is desired; refer
to UIDefaults for details on how a null
Locale is handled
int
java.lang.NullPointerException - if key is nullpublic static boolean getBoolean(java.lang.Object key)
key is not
a boolean, false is returned.
key - an Object specifying the Boolean
boolean
java.lang.NullPointerException - if key is null
public static boolean getBoolean(java.lang.Object key,
java.util.Locale l)
key is not
a boolean, false is returned.
key - an Object specifying the Booleanl - the Locale for which the Boolean is desired; refer
to UIDefaults for details on how a null
Locale is handled
boolean
java.lang.NullPointerException - if key is nullpublic static java.awt.Color getColor(java.lang.Object key)
key is not
a Color, null is returned.
key - an Object specifying the color
Color object
java.lang.NullPointerException - if key is null
public static java.awt.Color getColor(java.lang.Object key,
java.util.Locale l)
key is not
a Color, null is returned.
key - an Object specifying the colorl - the Locale for which the color is desired; refer
to UIDefaults for details on how a null
Locale is handled
Color object
java.lang.NullPointerException - if key is nullpublic static java.awt.Shape getShape(java.lang.Object key)
key is not a
Shape, null is returned.
key - an Object specifying the shape
Shape object
java.lang.NullPointerException - if key is null
public static java.awt.Shape getShape(java.lang.Object key,
java.util.Locale l)
key is not a Shape,
null is returned.
key - an Object specifying the shapel - the Locale for which the shape is desired; refer
to UIDefaults for details on how a null
Locale is handled
Shape object
java.lang.NullPointerException - if key is nullpublic static Painter<?> getPainter(java.lang.Object key)
key is not
a Painter, null is returned.
key - an Object specifying the painter
Painter object
java.lang.NullPointerException - if key is null
public static Painter<?> getPainter(java.lang.Object key,
java.util.Locale l)
key is not a Painter,
null is returned.
key - an Object specifying the painterl - the Locale for which the painter is desired; refer
to UIDefaults for details on how a null
Locale is handled
Painter object
java.lang.NullPointerException - if key is null
public static javax.swing.border.Border getSafeBorder(java.lang.Object key,
javax.swing.border.Border defaultBorder)
key is not a
Border, defaultBorder is returned.
key - an Object specifying the borderdefaultBorder - the border to return if the border specified by
key does not exist
Border object
java.lang.NullPointerException - if key or defaultBorder is null
public static java.awt.Color getSafeColor(java.lang.Object key,
java.awt.Color defaultColor)
key is not a
Color, defaultColor is returned.
key - an Object specifying the colordefaultColor - the color to return if the color specified by key
does not exist
Color object
java.lang.NullPointerException - if key or defaultColor is null
public static java.awt.Dimension getSafeDimension(java.lang.Object key,
java.awt.Dimension defaultDimension)
key is
not a Dimension, defaultDimension is returned.
key - an Object specifying the dimensiondefaultDimension - the dimension to return if the dimension specified by
key does not exist
Dimension object
java.lang.NullPointerException - if key or defaultColor is null
public static java.awt.Font getSafeFont(java.lang.Object key,
java.awt.Font defaultFont)
key is not a
Font, defaultFont is returned.
key - an Object specifying the fontdefaultFont - the font to return if the font specified by key
does not exist
Font object
java.lang.NullPointerException - if key or defaultFont is null
public static javax.swing.Icon getSafeIcon(java.lang.Object key,
javax.swing.Icon defaultIcon)
key is not a
Icon, defaultIcon is returned.
key - an Object specifying the icondefaultIcon - the icon to return if the icon specified by key
does not exist
Icon object
java.lang.NullPointerException - if key or defaultIcon is null
public static java.awt.Insets getSafeInsets(java.lang.Object key,
java.awt.Insets defaultInsets)
key is not
a Insets, defaultInsets is returned.
key - an Object specifying the insetsdefaultInsets - the insets to return if the insets specified by
key does not exist
Insets object
java.lang.NullPointerException - if key or defaultInsets is null
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||