- 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.defaultlaf
isnon-null
, use its value as the default look and feel class name. - If the
Properties
fileswing.properties
exists and contains the keyswing.defaultlaf
, use its value as the default look and feel class name. The location that is checked forswing.properties
may vary depending upon the implementation of the Java platform. Typically theswing.properties
file is located in theconf
subdirectory 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
Modifier and TypeClassDescriptionstatic class
Provides a little information about an installedLookAndFeel
for the sake of configuring a menu or for initial application set up. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic void
Adds aLookAndFeel
to the list of auxiliary look and feels.static void
Adds aPropertyChangeListener
to the listener list.static LookAndFeel
createLookAndFeel
(String name) Creates a supported built-in JavaLookAndFeel
specified by the givenL&F name
name.static Object
Returns an object from the defaults.static Object
Returns 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 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 givenLocale
.static Border
Returns a border from the defaults.static Border
Returns a border from the defaults that is appropriate for the given locale.static Color
Returns a color from the defaults.static Color
Returns a color from the defaults that is appropriate for the given locale.static String
Returns the name of theLookAndFeel
class that implements the default cross platform look and feel -- the Java Look and Feel (JLF).static UIDefaults
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
Returns a font from the defaults.static Font
Returns a font from the defaults that is appropriate for the given locale.static Icon
Returns anIcon
from the defaults.static Icon
Returns anIcon
from the defaults that is appropriate for the given locale.static Insets
Returns anInsets
object from the defaults.static Insets
Returns anInsets
object from the defaults that is appropriate for the given locale.static UIManager.LookAndFeelInfo[]
Returns an array ofLookAndFeelInfo
s representing theLookAndFeel
implementations currently available.static int
Returns an integer from the defaults.static int
Returns an integer from the defaults that is appropriate for the given locale.static LookAndFeel
Returns the current look and feel ornull
.static UIDefaults
Returns theUIDefaults
from the current look and feel, that were obtained at the time the look and feel was installed.static PropertyChangeListener[]
Returns an array of all thePropertyChangeListener
s added to this UIManager with addPropertyChangeListener().static String
Returns a string from the defaults.static String
Returns a string from the defaults that is appropriate for the given locale.static String
Returns the name of theLookAndFeel
class that implements the native system look and feel if there is one, otherwise the name of the default cross platformLookAndFeel
class.static ComponentUI
getUI
(JComponent target) Returns the appropriateComponentUI
implementation fortarget
.static void
installLookAndFeel
(String name, String className) Adds the specified look and feel to the set of available look and feels.static void
Adds the specified look and feel to the set of available look and feels.static Object
Stores an object in the developer defaults.static boolean
Removes aLookAndFeel
from the list of auxiliary look and feels.static void
Removes aPropertyChangeListener
from the listener list.static void
Sets the set of available look and feels.static void
setLookAndFeel
(String className) Loads theLookAndFeel
specified by the given class name, using the current thread's context class loader, and passes it tosetLookAndFeel(LookAndFeel)
.static void
setLookAndFeel
(LookAndFeel newLookAndFeel) Sets the current look and feel tonewLookAndFeel
.
-
Constructor Details
-
UIManager
public UIManager()Constructs aUIManager
.
-
-
Method Details
-
getInstalledLookAndFeels
Returns an array ofLookAndFeelInfo
s representing theLookAndFeel
implementations currently available. TheLookAndFeelInfo
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 numerousLookAndFeel
objects,LookAndFeelInfo
maintains the class name of theLookAndFeel
class, not the actualLookAndFeel
instance.The following example illustrates setting the current look and feel from an instance of
LookAndFeelInfo
:UIManager.setLookAndFeel(info.getClassName());
- Returns:
- an array of
LookAndFeelInfo
objects - 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 theLookAndFeelInfos
arenon-null
, it is strongly recommended that onlynon-null
values are supplied in theinfos
array.- Parameters:
infos
- set ofLookAndFeelInfo
objects specifying the available look and feels- Throws:
NullPointerException
- ifinfos
isnull
SecurityException
- See Also:
-
installLookAndFeel
Adds the specified look and feel to the set of available look and feels. While this method allows anull
info
, it is strongly recommended that anon-null
value be used.- Parameters:
info
- aLookAndFeelInfo
object 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-null
values 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 JavaLookAndFeel
specified by the givenL&F name
name.- Parameters:
name
- aString
specifying the name of the built-in look and feel- Returns:
- the built-in
LookAndFeel
object - Throws:
NullPointerException
- ifname
isnull
UnsupportedLookAndFeelException
- if the built-in JavaL&F
is 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-null
uninitialize
is invoked on it. IfnewLookAndFeel
isnon-null
,initialize
is invoked on it followed bygetDefaults
. The defaults returned fromnewLookAndFeel.getDefaults()
replace those of the defaults from the previous look and feel. If thenewLookAndFeel
isnull
, the look and feel defaults are set tonull
.A value of
null
can be used to set the look and feel tonull
. As theLookAndFeel
is required for most of Swing to function, setting theLookAndFeel
tonull
is strongly discouraged.This is a JavaBeans bound property.
- Parameters:
newLookAndFeel
-LookAndFeel
to install- Throws:
UnsupportedLookAndFeelException
- ifnewLookAndFeel
isnon-null
andnewLookAndFeel.isSupportedLookAndFeel()
returnsfalse
- See Also:
-
setLookAndFeel
public static void setLookAndFeel(String className) throws ClassNotFoundException, InstantiationException, IllegalAccessException, UnsupportedLookAndFeelException Loads theLookAndFeel
specified 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 theLookAndFeel
class 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
- ifclassName
does not identify a class that extendsLookAndFeel
NullPointerException
- ifclassName
isnull
-
getSystemLookAndFeelClassName
Returns the name of theLookAndFeel
class that implements the native system look and feel if there is one, otherwise the name of the default cross platformLookAndFeel
class. This value can be overriden by setting theswing.systemlaf
system property.- Returns:
- the
String
of theLookAndFeel
class - See Also:
-
getCrossPlatformLookAndFeelClassName
Returns the name of theLookAndFeel
class that implements the default cross platform look and feel -- the Java Look and Feel (JLF). This value can be overriden by setting theswing.crossplatformlaf
system 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
UIDefaults
object containing the default values
-
getFont
Returns a font from the defaults. If the value forkey
is not aFont
,null
is returned.- Parameters:
key
- anObject
specifying the font- Returns:
- the
Font
object - Throws:
NullPointerException
- ifkey
isnull
-
getFont
Returns a font from the defaults that is appropriate for the given locale. If the value forkey
is not aFont
,null
is returned.- Parameters:
key
- anObject
specifying the fontl
- theLocale
for which the font is desired; refer toUIDefaults
for details on how anull
Locale
is handled- Returns:
- the
Font
object - Throws:
NullPointerException
- ifkey
isnull
- Since:
- 1.4
-
getColor
Returns a color from the defaults. If the value forkey
is not aColor
,null
is returned.- Parameters:
key
- anObject
specifying the color- Returns:
- the
Color
object - Throws:
NullPointerException
- ifkey
isnull
-
getColor
Returns a color from the defaults that is appropriate for the given locale. If the value forkey
is not aColor
,null
is returned.- Parameters:
key
- anObject
specifying the colorl
- theLocale
for which the color is desired; refer toUIDefaults
for details on how anull
Locale
is handled- Returns:
- the
Color
object - Throws:
NullPointerException
- ifkey
isnull
- Since:
- 1.4
-
getIcon
Returns anIcon
from the defaults. If the value forkey
is not anIcon
,null
is returned.- Parameters:
key
- anObject
specifying the icon- Returns:
- the
Icon
object - Throws:
NullPointerException
- ifkey
isnull
-
getIcon
Returns anIcon
from the defaults that is appropriate for the given locale. If the value forkey
is not anIcon
,null
is returned.- Parameters:
key
- anObject
specifying the iconl
- theLocale
for which the icon is desired; refer toUIDefaults
for details on how anull
Locale
is handled- Returns:
- the
Icon
object - Throws:
NullPointerException
- ifkey
isnull
- Since:
- 1.4
-
getBorder
Returns a border from the defaults. If the value forkey
is not aBorder
,null
is returned.- Parameters:
key
- anObject
specifying the border- Returns:
- the
Border
object - Throws:
NullPointerException
- ifkey
isnull
-
getBorder
Returns a border from the defaults that is appropriate for the given locale. If the value forkey
is not aBorder
,null
is returned.- Parameters:
key
- anObject
specifying the borderl
- theLocale
for which the border is desired; refer toUIDefaults
for details on how anull
Locale
is handled- Returns:
- the
Border
object - Throws:
NullPointerException
- ifkey
isnull
- Since:
- 1.4
-
getString
Returns a string from the defaults. If the value forkey
is not aString
,null
is returned.- Parameters:
key
- anObject
specifying the string- Returns:
- the
String
- Throws:
NullPointerException
- ifkey
isnull
-
getString
Returns a string from the defaults that is appropriate for the given locale. If the value forkey
is not aString
,null
is returned.- Parameters:
key
- anObject
specifying the stringl
- theLocale
for which the string is desired; refer toUIDefaults
for details on how anull
Locale
is handled- Returns:
- the
String
- Throws:
NullPointerException
- ifkey
isnull
- Since:
- 1.4
-
getInt
Returns an integer from the defaults. If the value forkey
is not anInteger
, or does not exist,0
is returned.- Parameters:
key
- anObject
specifying the int- Returns:
- the int
- Throws:
NullPointerException
- ifkey
isnull
-
getInt
Returns an integer from the defaults that is appropriate for the given locale. If the value forkey
is not anInteger
, or does not exist,0
is returned.- Parameters:
key
- anObject
specifying the intl
- theLocale
for which the int is desired; refer toUIDefaults
for details on how anull
Locale
is handled- Returns:
- the int
- Throws:
NullPointerException
- ifkey
isnull
- 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 thenfalse
is returned.- Parameters:
key
- anObject
specifying the key for the desired boolean value- Returns:
- the boolean value corresponding to the key
- Throws:
NullPointerException
- ifkey
isnull
- 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 thenfalse
will be returned.- Parameters:
key
- anObject
specifying the key for the desired boolean valuel
- theLocale
for which the boolean is desired; refer toUIDefaults
for details on how anull
Locale
is handled- Returns:
- the boolean value corresponding to the key
- Throws:
NullPointerException
- ifkey
isnull
- Since:
- 1.4
-
getInsets
Returns anInsets
object from the defaults. If the value forkey
is not anInsets
,null
is returned.- Parameters:
key
- anObject
specifying theInsets
object- Returns:
- the
Insets
object - Throws:
NullPointerException
- ifkey
isnull
-
getInsets
Returns anInsets
object from the defaults that is appropriate for the given locale. If the value forkey
is not anInsets
,null
is returned.- Parameters:
key
- anObject
specifying theInsets
objectl
- theLocale
for which the object is desired; refer toUIDefaults
for details on how anull
Locale
is handled- Returns:
- the
Insets
object - Throws:
NullPointerException
- ifkey
isnull
- Since:
- 1.4
-
getDimension
Returns a dimension from the defaults. If the value forkey
is not aDimension
,null
is returned.- Parameters:
key
- anObject
specifying the dimension object- Returns:
- the
Dimension
object - Throws:
NullPointerException
- ifkey
isnull
-
getDimension
Returns a dimension from the defaults that is appropriate for the given locale. If the value forkey
is not aDimension
,null
is returned.- Parameters:
key
- anObject
specifying the dimension objectl
- theLocale
for which the object is desired; refer toUIDefaults
for details on how anull
Locale
is handled- Returns:
- the
Dimension
object - Throws:
NullPointerException
- ifkey
isnull
- Since:
- 1.4
-
get
Returns an object from the defaults.- Parameters:
key
- anObject
specifying the desired object- Returns:
- the
Object
- Throws:
NullPointerException
- ifkey
isnull
-
get
Returns an object from the defaults that is appropriate for the given locale.- Parameters:
key
- anObject
specifying the desired objectl
- theLocale
for which the object is desired; refer toUIDefaults
for details on how anull
Locale
is handled- Returns:
- the
Object
- Throws:
NullPointerException
- ifkey
isnull
- 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
- anObject
specifying the retrieval keyvalue
- theObject
to store; refer toUIDefaults
for details on hownull
is handled- Returns:
- the
Object
returned byUIDefaults.put(java.lang.Object, java.lang.Object)
- Throws:
NullPointerException
- ifkey
isnull
- See Also:
-
getUI
Returns the appropriateComponentUI
implementation 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
- theJComponent
to return theComponentUI
for- Returns:
- the
ComponentUI
object fortarget
- Throws:
NullPointerException
- iftarget
isnull
- See Also:
-
getLookAndFeelDefaults
Returns theUIDefaults
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 fromgetDefaults()
. As the current look and feel may expect certain values to exist, altering theUIDefaults
returned from this method could have unexpected results.- Returns:
UIDefaults
from the current look and feel- See Also:
-
addAuxiliaryLookAndFeel
Adds aLookAndFeel
to the list of auxiliary look and feels. The auxiliary look and feels tell the multiplexing look and feel what otherLookAndFeel
classes for a component instance are to be used in addition to the defaultLookAndFeel
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.
- Parameters:
laf
- theLookAndFeel
object- See Also:
-
removeAuxiliaryLookAndFeel
Removes aLookAndFeel
from the list of auxiliary look and feels. The auxiliary look and feels tell the multiplexing look and feel what otherLookAndFeel
classes for a component instance are to be used in addition to the defaultLookAndFeel
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.
- Parameters:
laf
- theLookAndFeel
to be removed- Returns:
- true if the
LookAndFeel
was 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 otherLookAndFeel
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.
- Returns:
- list of auxiliary
LookAndFeel
s ornull
- See Also:
-
addPropertyChangeListener
Adds aPropertyChangeListener
to the listener list. The listener is registered for all properties.- Parameters:
listener
- thePropertyChangeListener
to be added- See Also:
-
removePropertyChangeListener
Removes aPropertyChangeListener
from the listener list. This removes aPropertyChangeListener
that was registered for all properties.- Parameters:
listener
- thePropertyChangeListener
to be removed- See Also:
-
getPropertyChangeListeners
Returns an array of all thePropertyChangeListener
s added to this UIManager with addPropertyChangeListener().- Returns:
- all of the
PropertyChangeListener
s added or an empty array if no listeners have been added - Since:
- 1.4
-