public class UIManager extends Object implements 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.LookAndFeelInfo
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 laf)
Adds a
LookAndFeel to the list of auxiliary look and feels. |
static void |
addPropertyChangeListener(PropertyChangeListener listener)
Adds a
PropertyChangeListener to the listener list. |
static Object |
get(Object key)
Returns an object from the defaults.
|
static Object |
get(Object key,
Locale l)
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 key)
Returns a boolean from the defaults which is associated with
the key value.
|
static boolean |
getBoolean(Object key,
Locale l)
Returns a boolean from the defaults which is associated with
the key value and the given
Locale. |
static Border |
getBorder(Object key)
Returns a border from the defaults.
|
static Border |
getBorder(Object key,
Locale l)
Returns a border from the defaults that is appropriate
for the given locale.
|
static Color |
getColor(Object key)
Returns a color from the defaults.
|
static Color |
getColor(Object key,
Locale l)
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 key)
Returns a dimension from the defaults.
|
static Dimension |
getDimension(Object key,
Locale l)
Returns a dimension from the defaults that is appropriate
for the given locale.
|
static Font |
getFont(Object key)
Returns a font from the defaults.
|
static Font |
getFont(Object key,
Locale l)
Returns a font from the defaults that is appropriate
for the given locale.
|
static Icon |
getIcon(Object key)
Returns an
Icon from the defaults. |
static Icon |
getIcon(Object key,
Locale l)
Returns an
Icon from the defaults that is appropriate
for the given locale. |
static Insets |
getInsets(Object key)
Returns an
Insets object from the defaults. |
static Insets |
getInsets(Object key,
Locale l)
Returns an
Insets object from the defaults that is
appropriate for the given locale. |
static UIManager.LookAndFeelInfo[] |
getInstalledLookAndFeels()
Returns an array of
LookAndFeelInfos representing the
LookAndFeel implementations currently available. |
static int |
getInt(Object key)
Returns an integer from the defaults.
|
static int |
getInt(Object key,
Locale l)
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 key)
Returns a string from the defaults.
|
static String |
getString(Object key,
Locale l)
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 target)
Returns the appropriate
ComponentUI implementation for
target. |
static void |
installLookAndFeel(String name,
String className)
Adds the specified look and feel to the set of available look
and feels.
|
static void |
installLookAndFeel(UIManager.LookAndFeelInfo info)
Adds the specified look and feel to the set of available look
and feels.
|
static Object |
put(Object key,
Object value)
Stores an object in the developer defaults.
|
static boolean |
removeAuxiliaryLookAndFeel(LookAndFeel laf)
Removes a
LookAndFeel from the list of auxiliary look and feels. |
static void |
removePropertyChangeListener(PropertyChangeListener listener)
Removes a
PropertyChangeListener from the listener list. |
static void |
setInstalledLookAndFeels(UIManager.LookAndFeelInfo[] infos)
Sets the set of available look and feels.
|
static void |
setLookAndFeel(LookAndFeel newLookAndFeel)
Sets the current look and feel to
newLookAndFeel. |
static void |
setLookAndFeel(String className)
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 objectssetLookAndFeel(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 feelsNullPointerException - if infos is nullSecurityExceptiongetInstalledLookAndFeels()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 itsetInstalledLookAndFeels(javax.swing.UIManager.LookAndFeelInfo[])public static void installLookAndFeel(String name, String className)
non-null values be supplied.name - descriptive name of the look and feelclassName - name of the class that implements the look and feelsetInstalledLookAndFeels(javax.swing.UIManager.LookAndFeelInfo[])public static LookAndFeel getLookAndFeel()
null.nullsetLookAndFeel(javax.swing.LookAndFeel)public static void setLookAndFeel(LookAndFeel newLookAndFeel) 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 installUnsupportedLookAndFeelException - if
newLookAndFeel is non-null and
newLookAndFeel.isSupportedLookAndFeel() returns
falsegetLookAndFeel()public static void setLookAndFeel(String className) 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 feelClassNotFoundException - if the LookAndFeel
class could not be foundInstantiationException - if a new instance of the class
couldn't be createdIllegalAccessException - if the class or initializer isn't accessibleUnsupportedLookAndFeelException - if
lnf.isSupportedLookAndFeel() is falseClassCastException - if className does not identify
a class that extends LookAndFeelpublic static String getSystemLookAndFeelClassName()
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
classsetLookAndFeel(javax.swing.LookAndFeel),
getCrossPlatformLookAndFeelClassName()public static String getCrossPlatformLookAndFeelClassName()
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 UIDefaults getDefaults()
UIDefaults object containing the default valuespublic static Font getFont(Object key)
key is
not a Font, null is returned.key - an Object specifying the fontFont objectNullPointerException - if key is nullpublic static Font getFont(Object key, Locale l)
key is
not a Font, null is returned.key - an Object specifying the fontl - the Locale for which the font is desired; refer
to UIDefaults for details on how a null
Locale is handledFont objectNullPointerException - if key is nullpublic static Color getColor(Object key)
key is
not a Color, null is returned.key - an Object specifying the colorColor objectNullPointerException - if key is nullpublic static Color getColor(Object key, 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 handledColor objectNullPointerException - if key is nullpublic static Icon getIcon(Object key)
Icon from the defaults. If the value for
key is not an Icon, null is returned.key - an Object specifying the iconIcon objectNullPointerException - if key is nullpublic static Icon getIcon(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 iconl - the Locale for which the icon is desired; refer
to UIDefaults for details on how a null
Locale is handledIcon objectNullPointerException - if key is nullpublic static Border getBorder(Object key)
key is not a Border, null is returned.key - an Object specifying the borderBorder objectNullPointerException - if key is nullpublic static Border getBorder(Object key, Locale l)
key is not a Border, null is returned.key - an Object specifying the borderl - the Locale for which the border is desired; refer
to UIDefaults for details on how a null
Locale is handledBorder objectNullPointerException - if key is nullpublic static String getString(Object key)
key is not a String, null is returned.key - an Object specifying the stringStringNullPointerException - if key is nullpublic static String getString(Object key, Locale l)
key is not a String, null is returned.key - an Object specifying the stringl - the Locale for which the string is desired; refer
to UIDefaults for details on how a null
Locale is handledStringNullPointerException - if key is nullpublic static int getInt(Object key)
key is not an Integer, or does not exist,
0 is returned.key - an Object specifying the intNullPointerException - if key is nullpublic static int getInt(Object key, Locale l)
key is not an Integer, or does not exist,
0 is returned.key - an Object specifying the intl - the Locale for which the int is desired; refer
to UIDefaults for details on how a null
Locale is handledNullPointerException - if key is nullpublic static boolean getBoolean(Object key)
false is returned.key - an Object specifying the key for the desired boolean valueNullPointerException - if key is nullpublic static boolean getBoolean(Object key, 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 valuel - the Locale for which the boolean is desired; refer
to UIDefaults for details on how a null
Locale is handledNullPointerException - if key is nullpublic static Insets getInsets(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 objectInsets objectNullPointerException - if key is nullpublic static Insets getInsets(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 objectl - the Locale for which the object is desired; refer
to UIDefaults for details on how a null
Locale is handledInsets objectNullPointerException - if key is nullpublic static Dimension getDimension(Object key)
key is not a Dimension, null is returned.key - an Object specifying the dimension objectDimension objectNullPointerException - if key is nullpublic static Dimension getDimension(Object key, Locale l)
key is not a Dimension, null is returned.key - an Object specifying the dimension objectl - the Locale for which the object is desired; refer
to UIDefaults for details on how a null
Locale is handledDimension objectNullPointerException - if key is nullpublic static Object get(Object key)
key - an Object specifying the desired objectObjectNullPointerException - if key is nullpublic static Object get(Object key, Locale l)
key - an Object specifying the desired objectl - the Locale for which the object is desired; refer
to UIDefaults for details on how a null
Locale is handledObjectNullPointerException - if key is nullpublic static Object put(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 keyvalue - the Object to store; refer to
UIDefaults for details on how null is
handledObject returned by UIDefaults.put(java.lang.Object, java.lang.Object)NullPointerException - if key is nullUIDefaults.put(java.lang.Object, java.lang.Object)public static ComponentUI getUI(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 forComponentUI object for targetNullPointerException - if target is nullUIDefaults.getUI(javax.swing.JComponent)public static UIDefaults getLookAndFeelDefaults()
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 feelgetDefaults(),
setLookAndFeel(LookAndFeel),
LookAndFeel.getDefaults()public static void addAuxiliaryLookAndFeel(LookAndFeel laf)
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 objectremoveAuxiliaryLookAndFeel(javax.swing.LookAndFeel),
setLookAndFeel(javax.swing.LookAndFeel),
getAuxiliaryLookAndFeels(),
getInstalledLookAndFeels()public static boolean removeAuxiliaryLookAndFeel(LookAndFeel laf)
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 listremoveAuxiliaryLookAndFeel(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 nulladdAuxiliaryLookAndFeel(javax.swing.LookAndFeel),
removeAuxiliaryLookAndFeel(javax.swing.LookAndFeel),
setLookAndFeel(javax.swing.LookAndFeel),
getInstalledLookAndFeels()public static void addPropertyChangeListener(PropertyChangeListener listener)
PropertyChangeListener to the listener list.
The listener is registered for all properties.listener - the PropertyChangeListener to be addedPropertyChangeSupportpublic static void removePropertyChangeListener(PropertyChangeListener listener)
PropertyChangeListener from the listener list.
This removes a PropertyChangeListener that was registered
for all properties.listener - the PropertyChangeListener to be removedPropertyChangeSupportpublic static PropertyChangeListener[] getPropertyChangeListeners()
PropertyChangeListeners added
to this UIManager with addPropertyChangeListener().PropertyChangeListeners added or an empty
array if no listeners have been added Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.