- All Implemented Interfaces:
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.
Specifying the look and feel
The look and feel can be specified in two distinct ways: by specifying the fully qualified name of the class for the look and feel, or by creating an instance ofLookAndFeel 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.
Default look and feel
The class used for the default look and feel is chosen in the following manner:- If the system property
swing.defaultlafisnon-null, use its value as the default look and feel class name. - If the
Propertiesfileswing.propertiesexists and contains the keyswing.defaultlaf, use its value as the default look and feel class name. The location that is checked forswing.propertiesmay vary depending upon the implementation of the Java platform. Typically theswing.propertiesfile is located in theconfsubdirectory of the Java installation directory. Refer to the release notes of the implementation being used for further details. - Otherwise use the cross platform look and feel.
Defaults
UIManager manages three sets of UIDefaults. In order, they
are:
- Developer defaults. With few exceptions Swing does not alter the developer defaults; these are intended to be modified and used by the developer.
- Look and feel defaults. The look and feel defaults are
supplied by the look and feel at the time it is installed as the
current look and feel (
setLookAndFeel()is invoked). The look and feel defaults can be obtained using thegetLookAndFeelDefaults()method. - System defaults. The system defaults are provided by Swing.
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.
- Since:
- 1.2
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classProvides a little information about an installedLookAndFeelfor the sake of configuring a menu or for initial application set up. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic voidAdds aLookAndFeelto the list of auxiliary look and feels.static voidAdds aPropertyChangeListenerto the listener list.static LookAndFeelcreateLookAndFeel(String name) Creates a supported built-in JavaLookAndFeelspecified by the givenL&F namename.static ObjectReturns an object from the defaults.static ObjectReturns an object from the defaults that is appropriate for the given locale.static LookAndFeel[]Returns the list of auxiliary look and feels (can benull).static booleangetBoolean(Object key) Returns a boolean from the defaults which is associated with the key value.static booleangetBoolean(Object key, Locale l) Returns a boolean from the defaults which is associated with the key value and the givenLocale.static BorderReturns a border from the defaults.static BorderReturns a border from the defaults that is appropriate for the given locale.static ColorReturns a color from the defaults.static ColorReturns a color from the defaults that is appropriate for the given locale.static StringReturns the name of theLookAndFeelclass that implements the default cross platform look and feel -- the Java Look and Feel (JLF).static UIDefaultsReturns the defaults.static DimensiongetDimension(Object key) Returns a dimension from the defaults.static DimensiongetDimension(Object key, Locale l) Returns a dimension from the defaults that is appropriate for the given locale.static FontReturns a font from the defaults.static FontReturns a font from the defaults that is appropriate for the given locale.static IconReturns anIconfrom the defaults.static IconReturns anIconfrom the defaults that is appropriate for the given locale.static InsetsReturns anInsetsobject from the defaults.static InsetsReturns anInsetsobject from the defaults that is appropriate for the given locale.static UIManager.LookAndFeelInfo[]Returns an array ofLookAndFeelInfos representing theLookAndFeelimplementations currently available.static intReturns an integer from the defaults.static intReturns an integer from the defaults that is appropriate for the given locale.static LookAndFeelReturns the current look and feel ornull.static UIDefaultsReturns theUIDefaultsfrom the current look and feel, that were obtained at the time the look and feel was installed.static PropertyChangeListener[]Returns an array of all thePropertyChangeListeners added to this UIManager with addPropertyChangeListener().static StringReturns a string from the defaults.static StringReturns a string from the defaults that is appropriate for the given locale.static StringReturns the name of theLookAndFeelclass that implements the native system look and feel if there is one, otherwise the name of the default cross platformLookAndFeelclass.static ComponentUIgetUI(JComponent target) Returns the appropriateComponentUIimplementation fortarget.static voidinstallLookAndFeel(String name, String className) Adds the specified look and feel to the set of available look and feels.static voidAdds the specified look and feel to the set of available look and feels.static ObjectStores an object in the developer defaults.static booleanRemoves aLookAndFeelfrom the list of auxiliary look and feels.static voidRemoves aPropertyChangeListenerfrom the listener list.static voidSets the set of available look and feels.static voidsetLookAndFeel(String className) Loads theLookAndFeelspecified by the given class name, using the current thread's context class loader, and passes it tosetLookAndFeel(LookAndFeel).static voidsetLookAndFeel(LookAndFeel newLookAndFeel) Sets the current look and feel tonewLookAndFeel.
-
Constructor Details
-
UIManager
public UIManager()Constructs aUIManager.
-
-
Method Details
-
getInstalledLookAndFeels
Returns an array ofLookAndFeelInfos representing theLookAndFeelimplementations currently available. TheLookAndFeelInfoobjects 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 numerousLookAndFeelobjects,LookAndFeelInfomaintains the class name of theLookAndFeelclass, not the actualLookAndFeelinstance.The following example illustrates setting the current look and feel from an instance of
LookAndFeelInfo:UIManager.setLookAndFeel(info.getClassName());
- Returns:
- an array of
LookAndFeelInfoobjects - See Also:
-
setInstalledLookAndFeels
public static void setInstalledLookAndFeels(UIManager.LookAndFeelInfo[] infos) throws SecurityException Sets the set of available look and feels. While this method does not check to ensure all of theLookAndFeelInfosarenon-null, it is strongly recommended that onlynon-nullvalues are supplied in theinfosarray.- Parameters:
infos- set ofLookAndFeelInfoobjects specifying the available look and feels- Throws:
NullPointerException- ifinfosisnullSecurityException- See Also:
-
installLookAndFeel
Adds the specified look and feel to the set of available look and feels. While this method allows anullinfo, it is strongly recommended that anon-nullvalue be used.- Parameters:
info- aLookAndFeelInfoobject that names the look and feel and identifies the class that implements it- See Also:
-
installLookAndFeel
Adds the specified look and feel to the set of available look and feels. While this method does not check the arguments in any way, it is strongly recommended thatnon-nullvalues be supplied.- Parameters:
name- descriptive name of the look and feelclassName- name of the class that implements the look and feel- See Also:
-
getLookAndFeel
Returns the current look and feel ornull.- Returns:
- current look and feel, or
null - See Also:
-
createLookAndFeel
Creates a supported built-in JavaLookAndFeelspecified by the givenL&F namename.- Parameters:
name- aStringspecifying the name of the built-in look and feel- Returns:
- the built-in
LookAndFeelobject - Throws:
NullPointerException- ifnameisnullUnsupportedLookAndFeelException- if the built-in JavaL&Fis not found for the given name or it is not supported by the underlying platform- Since:
- 9
- See Also:
-
setLookAndFeel
public static void setLookAndFeel(LookAndFeel newLookAndFeel) throws UnsupportedLookAndFeelException Sets the current look and feel tonewLookAndFeel. If the current look and feel isnon-nulluninitializeis invoked on it. IfnewLookAndFeelisnon-null,initializeis invoked on it followed bygetDefaults. The defaults returned fromnewLookAndFeel.getDefaults()replace those of the defaults from the previous look and feel. If thenewLookAndFeelisnull, the look and feel defaults are set tonull.A value of
nullcan be used to set the look and feel tonull. As theLookAndFeelis required for most of Swing to function, setting theLookAndFeeltonullis strongly discouraged.This is a JavaBeans bound property.
- Parameters:
newLookAndFeel-LookAndFeelto install- Throws:
UnsupportedLookAndFeelException- ifnewLookAndFeelisnon-nullandnewLookAndFeel.isSupportedLookAndFeel()returnsfalse- See Also:
-
setLookAndFeel
public static void setLookAndFeel(String className) throws ClassNotFoundException, InstantiationException, IllegalAccessException, UnsupportedLookAndFeelException Loads theLookAndFeelspecified by the given class name, using the current thread's context class loader, and passes it tosetLookAndFeel(LookAndFeel).- Parameters:
className- a string specifying the name of the class that implements the look and feel- Throws:
ClassNotFoundException- if theLookAndFeelclass could not be foundInstantiationException- if a new instance of the class couldn't be createdIllegalAccessException- if the class or initializer isn't accessibleUnsupportedLookAndFeelException- iflnf.isSupportedLookAndFeel()is falseClassCastException- ifclassNamedoes not identify a class that extendsLookAndFeelNullPointerException- ifclassNameisnull
-
getSystemLookAndFeelClassName
Returns the name of theLookAndFeelclass that implements the native system look and feel if there is one, otherwise the name of the default cross platformLookAndFeelclass. This value can be overriden by setting theswing.systemlafsystem property.- Returns:
- the
Stringof theLookAndFeelclass - See Also:
-
getCrossPlatformLookAndFeelClassName
Returns the name of theLookAndFeelclass that implements the default cross platform look and feel -- the Java Look and Feel (JLF). This value can be overriden by setting theswing.crossplatformlafsystem property.- Returns:
- a string with the JLF implementation-class
- See Also:
-
getDefaults
Returns the defaults. The returned defaults resolve using the logic specified in the class documentation.- Returns:
- a
UIDefaultsobject containing the default values
-
getFont
Returns a font from the defaults. If the value forkeyis not aFont,nullis returned.- Parameters:
key- anObjectspecifying the font- Returns:
- the
Fontobject - Throws:
NullPointerException- ifkeyisnull
-
getFont
Returns a font from the defaults that is appropriate for the given locale. If the value forkeyis not aFont,nullis returned.- Parameters:
key- anObjectspecifying the fontl- theLocalefor which the font is desired; refer toUIDefaultsfor details on how anullLocaleis handled- Returns:
- the
Fontobject - Throws:
NullPointerException- ifkeyisnull- Since:
- 1.4
-
getColor
Returns a color from the defaults. If the value forkeyis not aColor,nullis returned.- Parameters:
key- anObjectspecifying the color- Returns:
- the
Colorobject - Throws:
NullPointerException- ifkeyisnull
-
getColor
Returns a color from the defaults that is appropriate for the given locale. If the value forkeyis not aColor,nullis returned.- Parameters:
key- anObjectspecifying the colorl- theLocalefor which the color is desired; refer toUIDefaultsfor details on how anullLocaleis handled- Returns:
- the
Colorobject - Throws:
NullPointerException- ifkeyisnull- Since:
- 1.4
-
getIcon
Returns anIconfrom the defaults. If the value forkeyis not anIcon,nullis returned.- Parameters:
key- anObjectspecifying the icon- Returns:
- the
Iconobject - Throws:
NullPointerException- ifkeyisnull
-
getIcon
Returns anIconfrom the defaults that is appropriate for the given locale. If the value forkeyis not anIcon,nullis returned.- Parameters:
key- anObjectspecifying the iconl- theLocalefor which the icon is desired; refer toUIDefaultsfor details on how anullLocaleis handled- Returns:
- the
Iconobject - Throws:
NullPointerException- ifkeyisnull- Since:
- 1.4
-
getBorder
Returns a border from the defaults. If the value forkeyis not aBorder,nullis returned.- Parameters:
key- anObjectspecifying the border- Returns:
- the
Borderobject - Throws:
NullPointerException- ifkeyisnull
-
getBorder
Returns a border from the defaults that is appropriate for the given locale. If the value forkeyis not aBorder,nullis returned.- Parameters:
key- anObjectspecifying the borderl- theLocalefor which the border is desired; refer toUIDefaultsfor details on how anullLocaleis handled- Returns:
- the
Borderobject - Throws:
NullPointerException- ifkeyisnull- Since:
- 1.4
-
getString
Returns a string from the defaults. If the value forkeyis not aString,nullis returned.- Parameters:
key- anObjectspecifying the string- Returns:
- the
String - Throws:
NullPointerException- ifkeyisnull
-
getString
Returns a string from the defaults that is appropriate for the given locale. If the value forkeyis not aString,nullis returned.- Parameters:
key- anObjectspecifying the stringl- theLocalefor which the string is desired; refer toUIDefaultsfor details on how anullLocaleis handled- Returns:
- the
String - Throws:
NullPointerException- ifkeyisnull- Since:
- 1.4
-
getInt
Returns an integer from the defaults. If the value forkeyis not anInteger, or does not exist,0is returned.- Parameters:
key- anObjectspecifying the int- Returns:
- the int
- Throws:
NullPointerException- ifkeyisnull
-
getInt
Returns an integer from the defaults that is appropriate for the given locale. If the value forkeyis not anInteger, or does not exist,0is returned.- Parameters:
key- anObjectspecifying the intl- theLocalefor which the int is desired; refer toUIDefaultsfor details on how anullLocaleis handled- Returns:
- the int
- Throws:
NullPointerException- ifkeyisnull- Since:
- 1.4
-
getBoolean
Returns a boolean from the defaults which is associated with the key value. If the key is not found or the key doesn't represent a boolean value thenfalseis returned.- Parameters:
key- anObjectspecifying the key for the desired boolean value- Returns:
- the boolean value corresponding to the key
- Throws:
NullPointerException- ifkeyisnull- Since:
- 1.4
-
getBoolean
Returns a boolean from the defaults which is associated with the key value and the givenLocale. If the key is not found or the key doesn't represent a boolean value thenfalsewill be returned.- Parameters:
key- anObjectspecifying the key for the desired boolean valuel- theLocalefor which the boolean is desired; refer toUIDefaultsfor details on how anullLocaleis handled- Returns:
- the boolean value corresponding to the key
- Throws:
NullPointerException- ifkeyisnull- Since:
- 1.4
-
getInsets
Returns anInsetsobject from the defaults. If the value forkeyis not anInsets,nullis returned.- Parameters:
key- anObjectspecifying theInsetsobject- Returns:
- the
Insetsobject - Throws:
NullPointerException- ifkeyisnull
-
getInsets
Returns anInsetsobject from the defaults that is appropriate for the given locale. If the value forkeyis not anInsets,nullis returned.- Parameters:
key- anObjectspecifying theInsetsobjectl- theLocalefor which the object is desired; refer toUIDefaultsfor details on how anullLocaleis handled- Returns:
- the
Insetsobject - Throws:
NullPointerException- ifkeyisnull- Since:
- 1.4
-
getDimension
Returns a dimension from the defaults. If the value forkeyis not aDimension,nullis returned.- Parameters:
key- anObjectspecifying the dimension object- Returns:
- the
Dimensionobject - Throws:
NullPointerException- ifkeyisnull
-
getDimension
Returns a dimension from the defaults that is appropriate for the given locale. If the value forkeyis not aDimension,nullis returned.- Parameters:
key- anObjectspecifying the dimension objectl- theLocalefor which the object is desired; refer toUIDefaultsfor details on how anullLocaleis handled- Returns:
- the
Dimensionobject - Throws:
NullPointerException- ifkeyisnull- Since:
- 1.4
-
get
Returns an object from the defaults.- Parameters:
key- anObjectspecifying the desired object- Returns:
- the
Object - Throws:
NullPointerException- ifkeyisnull
-
get
Returns an object from the defaults that is appropriate for the given locale.- Parameters:
key- anObjectspecifying the desired objectl- theLocalefor which the object is desired; refer toUIDefaultsfor details on how anullLocaleis handled- Returns:
- the
Object - Throws:
NullPointerException- ifkeyisnull- Since:
- 1.4
-
put
Stores an object in the developer defaults. This is a cover method forgetDefaults().put(key, value). This only effects the developer defaults, not the system or look and feel defaults.- Parameters:
key- anObjectspecifying the retrieval keyvalue- theObjectto store; refer toUIDefaultsfor details on hownullis handled- Returns:
- the
Objectreturned byUIDefaults.put(java.lang.Object, java.lang.Object) - Throws:
NullPointerException- ifkeyisnull- See Also:
-
getUI
Returns the appropriateComponentUIimplementation fortarget. Typically, this is a cover forgetDefaults().getUI(target). However, if an auxiliary look and feel has been installed, this first invokesgetUI(target)on the multiplexing look and feel's defaults, and returns that value if it isnon-null.- Parameters:
target- theJComponentto return theComponentUIfor- Returns:
- the
ComponentUIobject fortarget - Throws:
NullPointerException- iftargetisnull- See Also:
-
getLookAndFeelDefaults
Returns theUIDefaultsfrom the current look and feel, that were obtained at the time the look and feel was installed.In general, developers should use the
UIDefaultsreturned fromgetDefaults(). As the current look and feel may expect certain values to exist, altering theUIDefaultsreturned from this method could have unexpected results.- Returns:
UIDefaultsfrom the current look and feel- See Also:
-
addAuxiliaryLookAndFeel
Adds aLookAndFeelto the list of auxiliary look and feels. The auxiliary look and feels tell the multiplexing look and feel what otherLookAndFeelclasses for a component instance are to be used in addition to the defaultLookAndFeelclass 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.
- Parameters:
laf- theLookAndFeelobject- See Also:
-
removeAuxiliaryLookAndFeel
Removes aLookAndFeelfrom the list of auxiliary look and feels. The auxiliary look and feels tell the multiplexing look and feel what otherLookAndFeelclasses for a component instance are to be used in addition to the defaultLookAndFeelclass 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.
- Parameters:
laf- theLookAndFeelto be removed- Returns:
- true if the
LookAndFeelwas removed from the list - See Also:
-
getAuxiliaryLookAndFeels
Returns the list of auxiliary look and feels (can benull). The auxiliary look and feels tell the multiplexing look and feel what otherLookAndFeelclasses 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.
- Returns:
- list of auxiliary
LookAndFeels ornull - See Also:
-
addPropertyChangeListener
Adds aPropertyChangeListenerto the listener list. The listener is registered for all properties.- Parameters:
listener- thePropertyChangeListenerto be added- See Also:
-
removePropertyChangeListener
Removes aPropertyChangeListenerfrom the listener list. This removes aPropertyChangeListenerthat was registered for all properties.- Parameters:
listener- thePropertyChangeListenerto be removed- See Also:
-
getPropertyChangeListeners
Returns an array of all thePropertyChangeListeners added to this UIManager with addPropertyChangeListener().- Returns:
- all of the
PropertyChangeListeners added or an empty array if no listeners have been added - Since:
- 1.4
-