public class UIManager extends Objectimplements Serializable
UIManager manages the current look and feel, the set of available look and feels,
PropertyChangeListeners that are notified when the look and feel changes, look and feel defaults, and convenience methods for obtaining various default values.
LookAndFeel and passing it to
setLookAndFeel. The following example illustrates setting the look and feel to the system look and feel:
UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());The following example illustrates setting the look and feel based on class name:
UIManager.setLookAndFeel("javax.swing.plaf.metal.MetalLookAndFeel");
Once the look and feel has been changed it is imperative to invoke
updateUI on all
JComponents. The method
SwingUtilities.updateComponentTreeUI(java.awt.Component) makes it easy to apply
updateUI to a containment hierarchy. Refer to it for details. The exact behavior of not invoking
updateUI after changing the look and feel is unspecified. It is very possible to receive unexpected exceptions, painting problems, or worse.
swing.defaultlaf is non-null, use its value as the default look and feel class name. Properties file swing.properties exists and contains the key swing.defaultlaf, use its value as the default look and feel class name. The location that is checked for swing.properties may vary depending upon the implementation of the Java platform. Typically the swing.properties file is located in the lib subdirectory of the Java installation directory. Refer to the release notes of the implementation being used for further details. UIManager manages three sets of
UIDefaults. In order, they are:
setLookAndFeel() is invoked). The look and feel defaults can be obtained using the getLookAndFeelDefaults() method. get methods results in checking each of the defaults, in order, returning the first
non-null value. For example, invoking
UIManager.getString("Table.foreground") results in first checking developer defaults. If the developer defaults contain a value for
"Table.foreground" it is returned, otherwise the look and feel defaults are checked, followed by the system defaults.
It's important to note that getDefaults returns a custom instance of UIDefaults with this resolution logic built into it. For example, UIManager.getDefaults().getString("Table.foreground") is equivalent to UIManager.getString("Table.foreground"). Both resolve using the algorithm just described. In many places the documentation uses the word defaults to refer to the custom instance of UIDefaults with the resolution logic as previously described.
When the look and feel is changed, UIManager alters only the look and feel defaults; the developer and system defaults are not altered by the UIManager in any way.
The set of defaults a particular look and feel supports is defined and documented by that look and feel. In addition, each look and feel, or ComponentUI provided by a look and feel, may access the defaults at different times in their life cycle. Some look and feels may aggressively look up defaults, so that changing a default may not have an effect after installing the look and feel. Other look and feels may lazily access defaults so that a change to the defaults may effect an existing look and feel. Finally, other look and feels might not configure themselves from the defaults table in any way. None-the-less it is usually the case that a look and feel expects certain defaults, so that in general a ComponentUI provided by one look and feel will not work with another look and feel.
Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans™ has been added to the java.beans package. Please see XMLEncoder.
| Modifier and Type | Class and Description |
|---|---|
static class |
UIManager
Provides a little information about an installed
LookAndFeel for the sake of configuring a menu or for initial application set up.
|
| Constructor and Description |
|---|
UIManager()
|
| Modifier and Type | Method and Description |
|---|---|
static void |
addAuxiliaryLookAndFeel(LookAndFeel
Adds a
LookAndFeel to the list of auxiliary look and feels.
|
static void |
addPropertyChangeListener(PropertyChangeListener
Adds a
PropertyChangeListener to the listener list.
|
static Object |
get(Object
Returns an object from the defaults.
|
static Object |
get(Object
Returns an object from the defaults that is appropriate for the given locale.
|
static LookAndFeel |
getAuxiliaryLookAndFeels()
Returns the list of auxiliary look and feels (can be
null).
|
static boolean |
getBoolean(Object
Returns a boolean from the defaults which is associated with the key value.
|
static boolean |
getBoolean(Object
Returns a boolean from the defaults which is associated with the key value and the given
Locale.
|
static Border |
getBorder(Object
Returns a border from the defaults.
|
static Border |
getBorder(Object
Returns a border from the defaults that is appropriate for the given locale.
|
static Color |
getColor(Object
Returns a color from the defaults.
|
static Color |
getColor(Object
Returns a color from the defaults that is appropriate for the given locale.
|
static String |
getCrossPlatformLookAndFeelClassName()
Returns the name of the
LookAndFeel class that implements the default cross platform look and feel -- the Java Look and Feel (JLF).
|
static UIDefaults |
getDefaults()
Returns the defaults.
|
static Dimension |
getDimension(Object
Returns a dimension from the defaults.
|
static Dimension |
getDimension(Object
Returns a dimension from the defaults that is appropriate for the given locale.
|
static Font |
getFont(Object
Returns a font from the defaults.
|
static Font |
getFont(Object
Returns a font from the defaults that is appropriate for the given locale.
|
static Icon |
getIcon(Object
Returns an
Icon from the defaults.
|
static Icon |
getIcon(Object
Returns an
Icon from the defaults that is appropriate for the given locale.
|
static Insets |
getInsets(Object
Returns an
Insets object from the defaults.
|
static Insets |
getInsets(Object
Returns an
Insets object from the defaults that is appropriate for the given locale.
|
static UIManager |
getInstalledLookAndFeels()
Returns an array of
LookAndFeelInfos representing the
LookAndFeel implementations currently available.
|
static int |
getInt(Object
Returns an integer from the defaults.
|
static int |
getInt(Object
Returns an integer from the defaults that is appropriate for the given locale.
|
static LookAndFeel |
getLookAndFeel()
Returns the current look and feel or
null.
|
static UIDefaults |
getLookAndFeelDefaults()
Returns the
UIDefaults from the current look and feel, that were obtained at the time the look and feel was installed.
|
static PropertyChangeListener |
getPropertyChangeListeners()
Returns an array of all the
PropertyChangeListeners added to this UIManager with addPropertyChangeListener().
|
static String |
getString(Object
Returns a string from the defaults.
|
static String |
getString(Object
Returns a string from the defaults that is appropriate for the given locale.
|
static String |
getSystemLookAndFeelClassName()
Returns the name of the
LookAndFeel class that implements the native system look and feel if there is one, otherwise the name of the default cross platform
LookAndFeel class.
|
static ComponentUI |
getUI(JComponent
Returns the appropriate
ComponentUI implementation for
target.
|
static void |
installLookAndFeel(String
Adds the specified look and feel to the set of available look and feels.
|
static void |
installLookAndFeel(UIManager
Adds the specified look and feel to the set of available look and feels.
|
static Object |
put(Object
Stores an object in the developer defaults.
|
static boolean |
removeAuxiliaryLookAndFeel(LookAndFeel
Removes a
LookAndFeel from the list of auxiliary look and feels.
|
static void |
removePropertyChangeListener(PropertyChangeListener
Removes a
PropertyChangeListener from the listener list.
|
static void |
setInstalledLookAndFeels(UIManager
Sets the set of available look and feels.
|
static void |
setLookAndFeel(LookAndFeel
Sets the current look and feel to
newLookAndFeel.
|
static void |
setLookAndFeel(String
Loads the
LookAndFeel specified by the given class name, using the current thread's context class loader, and passes it to
setLookAndFeel(LookAndFeel).
|
public static UIManager.LookAndFeelInfo [] getInstalledLookAndFeels()
LookAndFeelInfos representing the
LookAndFeel implementations currently available. The
LookAndFeelInfo objects can be used by an application to construct a menu of look and feel options for the user, or to determine which look and feel to set at startup time. To avoid the penalty of creating numerous
LookAndFeel objects,
LookAndFeelInfo maintains the class name of the
LookAndFeel class, not the actual
LookAndFeel instance.
The following example illustrates setting the current look and feel from an instance of LookAndFeelInfo:
UIManager.setLookAndFeel(info.getClassName());
LookAndFeelInfo objects
setLookAndFeel(javax.swing.LookAndFeel)
public static void setInstalledLookAndFeels(UIManager.LookAndFeelInfo [] infos) throws SecurityException
LookAndFeelInfos are
non-null, it is strongly recommended that only
non-null values are supplied in the
infos array.
infos - set of
LookAndFeelInfo objects specifying the available look and feels
NullPointerException - if
infos is
null
SecurityException
getInstalledLookAndFeels()
public static void installLookAndFeel(UIManager.LookAndFeelInfo info)
null
info, it is strongly recommended that a
non-null value be used.
info - a
LookAndFeelInfo object that names the look and feel and identifies the class that implements it
setInstalledLookAndFeels(javax.swing.UIManager.LookAndFeelInfo[])
public static void installLookAndFeel(Stringname, String className)
non-null values be supplied.
name - descriptive name of the look and feel
className - name of the class that implements the look and feel
setInstalledLookAndFeels(javax.swing.UIManager.LookAndFeelInfo[])
public static LookAndFeelgetLookAndFeel()
null.
null
setLookAndFeel(javax.swing.LookAndFeel)
public static void setLookAndFeel(LookAndFeelnewLookAndFeel) throws UnsupportedLookAndFeelException
newLookAndFeel. If the current look and feel is
non-null
uninitialize is invoked on it. If
newLookAndFeel is
non-null,
initialize is invoked on it followed by
getDefaults. The defaults returned from
newLookAndFeel.getDefaults() replace those of the defaults from the previous look and feel. If the
newLookAndFeel is
null, the look and feel defaults are set to
null.
A value of null can be used to set the look and feel to null. As the LookAndFeel is required for most of Swing to function, setting the LookAndFeel to null is strongly discouraged.
This is a JavaBeans bound property.
newLookAndFeel -
LookAndFeel to install
UnsupportedLookAndFeelException - if
newLookAndFeel is
non-null and
newLookAndFeel.isSupportedLookAndFeel() returns
false
getLookAndFeel()
public static void setLookAndFeel(StringclassName) throws ClassNotFoundException , InstantiationException , IllegalAccessException , UnsupportedLookAndFeelException
LookAndFeel specified by the given class name, using the current thread's context class loader, and passes it to
setLookAndFeel(LookAndFeel).
className - a string specifying the name of the class that implements the look and feel
ClassNotFoundException - if the
LookAndFeel class could not be found
InstantiationException - if a new instance of the class couldn't be created
IllegalAccessException - if the class or initializer isn't accessible
UnsupportedLookAndFeelException - if
lnf.isSupportedLookAndFeel() is false
ClassCastException - if
className does not identify a class that extends
LookAndFeel
public static StringgetSystemLookAndFeelClassName()
LookAndFeel class that implements the native system look and feel if there is one, otherwise the name of the default cross platform
LookAndFeel class. This value can be overriden by setting the
swing.systemlaf system property.
String of the
LookAndFeel class
setLookAndFeel(javax.swing.LookAndFeel),
getCrossPlatformLookAndFeelClassName()
public static StringgetCrossPlatformLookAndFeelClassName()
LookAndFeel class that implements the default cross platform look and feel -- the Java Look and Feel (JLF). This value can be overriden by setting the
swing.crossplatformlaf system property.
setLookAndFeel(javax.swing.LookAndFeel),
getSystemLookAndFeelClassName()
public static UIDefaultsgetDefaults()
UIDefaults object containing the default values
public static FontgetFont(Object key)
key is not a
Font,
null is returned.
key - an
Object specifying the font
Font object
NullPointerException - if
key is
null
public static FontgetFont(Object key, Locale l)
key is not a
Font,
null is returned.
key - an
Object specifying the font
l - the
Locale for which the font is desired; refer to
UIDefaults for details on how a
null
Locale is handled
Font object
NullPointerException - if
key is
null
public static ColorgetColor(Object key)
key is not a
Color,
null is returned.
key - an
Object specifying the color
Color object
NullPointerException - if
key is
null
public static ColorgetColor(Object key, Locale l)
key is not a
Color,
null is returned.
key - an
Object specifying the color
l - the
Locale for which the color is desired; refer to
UIDefaults for details on how a
null
Locale is handled
Color object
NullPointerException - if
key is
null
public static IcongetIcon(Object key)
Icon from the defaults. If the value for
key is not an
Icon,
null is returned.
key - an
Object specifying the icon
Icon object
NullPointerException - if
key is
null
public static IcongetIcon(Object key, Locale l)
Icon from the defaults that is appropriate for the given locale. If the value for
key is not an
Icon,
null is returned.
key - an
Object specifying the icon
l - the
Locale for which the icon is desired; refer to
UIDefaults for details on how a
null
Locale is handled
Icon object
NullPointerException - if
key is
null
public static BordergetBorder(Object key)
key is not a
Border,
null is returned.
key - an
Object specifying the border
Border object
NullPointerException - if
key is
null
public static BordergetBorder(Object key, Locale l)
key is not a
Border,
null is returned.
key - an
Object specifying the border
l - the
Locale for which the border is desired; refer to
UIDefaults for details on how a
null
Locale is handled
Border object
NullPointerException - if
key is
null
public static StringgetString(Object key)
key is not a
String,
null is returned.
key - an
Object specifying the string
String
NullPointerException - if
key is
null
public static StringgetString(Object key, Locale l)
key is not a
String,
null is returned.
key - an
Object specifying the string
l - the
Locale for which the string is desired; refer to
UIDefaults for details on how a
null
Locale is handled
String
NullPointerException - if
key is
null
public static int getInt(Objectkey)
key is not an
Integer, or does not exist,
0 is returned.
key - an
Object specifying the int
NullPointerException - if
key is
null
public static int getInt(Objectkey, Locale l)
key is not an
Integer, or does not exist,
0 is returned.
key - an
Object specifying the int
l - the
Locale for which the int is desired; refer to
UIDefaults for details on how a
null
Locale is handled
NullPointerException - if
key is
null
public static boolean getBoolean(Objectkey)
false is returned.
key - an
Object specifying the key for the desired boolean value
NullPointerException - if
key is
null
public static boolean getBoolean(Objectkey, Locale l)
Locale. If the key is not found or the key doesn't represent a boolean value then
false will be returned.
key - an
Object specifying the key for the desired boolean value
l - the
Locale for which the boolean is desired; refer to
UIDefaults for details on how a
null
Locale is handled
NullPointerException - if
key is
null
public static InsetsgetInsets(Object key)
Insets object from the defaults. If the value for
key is not an
Insets,
null is returned.
key - an
Object specifying the
Insets object
Insets object
NullPointerException - if
key is
null
public static InsetsgetInsets(Object key, Locale l)
Insets object from the defaults that is appropriate for the given locale. If the value for
key is not an
Insets,
null is returned.
key - an
Object specifying the
Insets object
l - the
Locale for which the object is desired; refer to
UIDefaults for details on how a
null
Locale is handled
Insets object
NullPointerException - if
key is
null
public static DimensiongetDimension(Object key)
key is not a
Dimension,
null is returned.
key - an
Object specifying the dimension object
Dimension object
NullPointerException - if
key is
null
public static DimensiongetDimension(Object key, Locale l)
key is not a
Dimension,
null is returned.
key - an
Object specifying the dimension object
l - the
Locale for which the object is desired; refer to
UIDefaults for details on how a
null
Locale is handled
Dimension object
NullPointerException - if
key is
null
public static Objectget(Object key)
key - an
Object specifying the desired object
Object
NullPointerException - if
key is
null
public static Objectget(Object key, Locale l)
key - an
Object specifying the desired object
l - the
Locale for which the object is desired; refer to
UIDefaults for details on how a
null
Locale is handled
Object
NullPointerException - if
key is
null
public static Objectput(Object key, Object value)
getDefaults().put(key, value). This only effects the developer defaults, not the system or look and feel defaults.
key - an
Object specifying the retrieval key
value - the
Object to store; refer to
UIDefaults for details on how
null is handled
Object returned by
UIDefaults.put(java.lang.Object, java.lang.Object)
NullPointerException - if
key is
null
UIDefaults.put(java.lang.Object, java.lang.Object)
public static ComponentUIgetUI(JComponent target)
ComponentUI implementation for
target. Typically, this is a cover for
getDefaults().getUI(target). However, if an auxiliary look and feel has been installed, this first invokes
getUI(target) on the multiplexing look and feel's defaults, and returns that value if it is
non-null.
target - the
JComponent to return the
ComponentUI for
ComponentUI object for
target
NullPointerException - if
target is
null
UIDefaults.getUI(javax.swing.JComponent)
public static UIDefaultsgetLookAndFeelDefaults()
UIDefaults from the current look and feel, that were obtained at the time the look and feel was installed.
In general, developers should use the UIDefaults returned from getDefaults(). As the current look and feel may expect certain values to exist, altering the UIDefaults returned from this method could have unexpected results.
UIDefaults from the current look and feel
getDefaults(),
setLookAndFeel(LookAndFeel),
LookAndFeel.getDefaults()
public static void addAuxiliaryLookAndFeel(LookAndFeellaf)
LookAndFeel to the list of auxiliary look and feels. The auxiliary look and feels tell the multiplexing look and feel what other
LookAndFeel classes for a component instance are to be used in addition to the default
LookAndFeel class when creating a multiplexing UI. The change will only take effect when a new UI class is created or when the default look and feel is changed on a component instance.
Note these are not the same as the installed look and feels.
laf - the
LookAndFeel object
removeAuxiliaryLookAndFeel(javax.swing.LookAndFeel),
setLookAndFeel(javax.swing.LookAndFeel),
getAuxiliaryLookAndFeels(),
getInstalledLookAndFeels()
public static boolean removeAuxiliaryLookAndFeel(LookAndFeellaf)
LookAndFeel from the list of auxiliary look and feels. The auxiliary look and feels tell the multiplexing look and feel what other
LookAndFeel classes for a component instance are to be used in addition to the default
LookAndFeel class when creating a multiplexing UI. The change will only take effect when a new UI class is created or when the default look and feel is changed on a component instance.
Note these are not the same as the installed look and feels.
LookAndFeel was removed from the list
removeAuxiliaryLookAndFeel(javax.swing.LookAndFeel),
getAuxiliaryLookAndFeels(),
setLookAndFeel(javax.swing.LookAndFeel),
getInstalledLookAndFeels()
public static LookAndFeel[] getAuxiliaryLookAndFeels()
null). The auxiliary look and feels tell the multiplexing look and feel what other
LookAndFeel classes for a component instance are to be used in addition to the default LookAndFeel class when creating a multiplexing UI.
Note these are not the same as the installed look and feels.
LookAndFeels or
null
addAuxiliaryLookAndFeel(javax.swing.LookAndFeel),
removeAuxiliaryLookAndFeel(javax.swing.LookAndFeel),
setLookAndFeel(javax.swing.LookAndFeel),
getInstalledLookAndFeels()
public static void addPropertyChangeListener(PropertyChangeListenerlistener)
PropertyChangeListener to the listener list. The listener is registered for all properties.
listener - the
PropertyChangeListener to be added
PropertyChangeSupport
public static void removePropertyChangeListener(PropertyChangeListenerlistener)
PropertyChangeListener from the listener list. This removes a
PropertyChangeListener that was registered for all properties.
listener - the
PropertyChangeListener to be removed
PropertyChangeSupport
public static PropertyChangeListener[] getPropertyChangeListeners()
PropertyChangeListeners added to this UIManager with addPropertyChangeListener().
PropertyChangeListeners added or an empty array if no listeners have been added