- Direct Known Subclasses:
BasicLookAndFeel
,MultiLookAndFeel
LookAndFeel
, as the name implies, encapsulates a look and
feel. Beyond installing a look and feel most developers never need to
interact directly with LookAndFeel
. In general only developers
creating a custom look and feel need to concern themselves with this class.
Swing is built upon the foundation that each JComponent
subclass has an implementation of a specific ComponentUI
subclass. The ComponentUI
is often referred to as "the ui",
"component ui", or "look and feel delegate". The ComponentUI
subclass is responsible for providing the look and feel specific
functionality of the component. For example, JTree
requires
an implementation of the ComponentUI
subclass
TreeUI
. The implementation of the specific
ComponentUI
subclass is provided by the LookAndFeel
. Each
JComponent
subclass identifies the ComponentUI
subclass it requires by way of the JComponent
method
getUIClassID
.
Each LookAndFeel
implementation must provide
an implementation of the appropriate ComponentUI
subclass by
specifying a value for each of Swing's ui class ids in the
UIDefaults
object returned from getDefaults
. For example,
BasicLookAndFeel
uses BasicTreeUI
as the concrete
implementation for TreeUI
. This is accomplished by
BasicLookAndFeel
providing the key-value pair
"TreeUI"-"javax.swing.plaf.basic.BasicTreeUI"
, in the
UIDefaults
returned from getDefaults
. Refer to
UIDefaults.getUI(JComponent)
for details on how the implementation
of the ComponentUI
subclass is obtained.
When a LookAndFeel
is installed the UIManager
does
not check that an entry exists for all ui class ids. As such,
random exceptions will occur if the current look and feel has not
provided a value for a particular ui class id and an instance of
the JComponent
subclass is created.
Recommendations for Look and Feels
As noted inUIManager
each LookAndFeel
has the opportunity
to provide a set of defaults that are layered in with developer and
system defaults. Some of Swing's components require the look and feel
to provide a specific set of defaults. These are documented in the
classes that require the specific default.
ComponentUIs and defaults
AllComponentUIs
typically need to set various properties
on the JComponent
the ComponentUI
is providing the
look and feel for. This is typically done when the
ComponentUI
is installed on the JComponent
. Setting a
property should only be done if the developer has not set the
property. For non-primitive values it is recommended that the
ComponentUI
only change the property on the
JComponent
if the current value is null
or implements
UIResource
. If the current value is null
or
implements UIResource
it indicates the property has not
been set by the developer, and the ui is free to change it. For
example, BasicButtonUI.installDefaults
only changes the
font on the JButton
if the return value from
button.getFont()
is null
or implements
UIResource
. On the other hand if button.getFont()
returned
a non-null
value that did not implement UIResource
then BasicButtonUI.installDefaults
would not change the
JButton
's font.
For primitive values, such as opaque
, the method
installProperty
should be invoked. installProperty
only changes
the corresponding property if the value has not been changed by the
developer.
ComponentUI
implementations should use the various install methods
provided by this class as they handle the necessary checking and install
the property using the recommended guidelines.
Exceptions
All of the install methods provided byLookAndFeel
need to
access the defaults if the value of the property being changed is
null
or a UIResource
. For example, installing the
font does the following:
JComponent c; Font font = c.getFont(); if (font == null || (font instanceof UIResource)) { c.setFont(UIManager.getFont("fontKey")); }If the font is
null
or a UIResource
, the
defaults table is queried with the key fontKey
. All of
UIDefault's
get methods throw a
NullPointerException
if passed in null
. As such, unless
otherwise noted each of the various install methods of
LookAndFeel
throw a NullPointerException
if the current
value is null
or a UIResource
and the supplied
defaults key is null
. In addition, unless otherwise specified
all of the install
methods throw a NullPointerException
if
a null
component is passed in.- Since:
- 1.2
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionReturns the look and feel defaults.abstract String
Return a one line description of this look and feel implementation, e.g.static Object
getDesktopPropertyValue
(String systemPropertyName, Object fallbackValue) Returns the value of the specified system desktop property by invokingToolkit.getDefaultToolkit().getDesktopProperty()
.getDisabledIcon
(JComponent component, Icon icon) Returns anIcon
with a disabled appearance.getDisabledSelectedIcon
(JComponent component, Icon icon) Returns anIcon
for use by disabled components that are also selected.abstract String
getID()
Return a string that identifies this look and feel.Returns theLayoutStyle
for this look and feel.abstract String
getName()
Return a short string that identifies this look and feel, e.g.boolean
Returnstrue
if theLookAndFeel
returnedRootPaneUI
instances support providingWindow
decorations in aJRootPane
.void
Initializes the look and feel.static void
installBorder
(JComponent c, String defaultBorderName) Convenience method for setting a component's border property with a value from the defaults.static void
installColors
(JComponent c, String defaultBgName, String defaultFgName) Convenience method for setting a component's foreground and background color properties with values from the defaults.static void
installColorsAndFont
(JComponent c, String defaultBgName, String defaultFgName, String defaultFontName) Convenience method for setting a component's foreground, background and font properties with values from the defaults.static void
installProperty
(JComponent c, String propertyName, Object propertyValue) Convenience method for installing a property with the specified name and value on a component if that property has not already been set by the developer.abstract boolean
If the underlying platform has a "native" look and feel, and this is an implementation of it, returntrue
.abstract boolean
Returntrue
if the underlying platform supports and or permits this look and feel.static void
loadKeyBindings
(InputMap retMap, Object[] keys) Populates anInputMap
with the specified bindings.static ComponentInputMap
makeComponentInputMap
(JComponent c, Object[] keys) Creates aComponentInputMapUIResource
fromkeys
.static Object
Creates and returns aUIDefault.LazyValue
that loads an image.static InputMap
makeInputMap
(Object[] keys) Creates anInputMapUIResource
fromkeys
.static JTextComponent.KeyBinding[]
makeKeyBindings
(Object[] keyBindingList) Convenience method for building an array ofKeyBindings
.void
provideErrorFeedback
(Component component) Invoked when the user attempts an invalid operation, such as pasting into an uneditableJTextField
that has focus.toString()
Returns a string that displays and identifies this object's properties.void
Uninitializes the look and feel.static void
Convenience method for uninstalling a border.
-
Constructor Details
-
LookAndFeel
protected LookAndFeel()Constructor for subclasses to call.
-
-
Method Details
-
installColors
Convenience method for setting a component's foreground and background color properties with values from the defaults. The properties are only set if the current value is eithernull
or aUIResource
.- Parameters:
c
- component to set the colors ondefaultBgName
- key for the backgrounddefaultFgName
- key for the foreground- Throws:
NullPointerException
- as described in exceptions- See Also:
-
installColorsAndFont
public static void installColorsAndFont(JComponent c, String defaultBgName, String defaultFgName, String defaultFontName) Convenience method for setting a component's foreground, background and font properties with values from the defaults. The properties are only set if the current value is eithernull
or aUIResource
.- Parameters:
c
- component set to the colors and font ondefaultBgName
- key for the backgrounddefaultFgName
- key for the foregrounddefaultFontName
- key for the font- Throws:
NullPointerException
- as described in exceptions- See Also:
-
installBorder
Convenience method for setting a component's border property with a value from the defaults. The border is only set if the border isnull
or an instance ofUIResource
.- Parameters:
c
- component to set the border ondefaultBorderName
- key specifying the border- Throws:
NullPointerException
- as described in exceptions
-
uninstallBorder
Convenience method for uninstalling a border. If the border of the component is aUIResource
, it is set tonull
.- Parameters:
c
- component to uninstall the border on- Throws:
NullPointerException
- ifc
isnull
-
installProperty
Convenience method for installing a property with the specified name and value on a component if that property has not already been set by the developer. This method is intended to be used by ui delegate instances that need to specify a default value for a property of primitive type (boolean, int, ..), but do not wish to override a value set by the client. Since primitive property values cannot be wrapped with theUIResource
marker, this method uses private state to determine whether the property has been set by the client.- Parameters:
c
- target component to set the property onpropertyName
- name of the property to setpropertyValue
- value of the property- Throws:
IllegalArgumentException
- if the specified property is not one which can be set using this methodClassCastException
- if the property value has not been set by the developer and the type does not match the property's typeNullPointerException
- ifc
isnull
, or the named property has not been set by the developer andpropertyValue
isnull
- Since:
- 1.5
-
makeKeyBindings
Convenience method for building an array ofKeyBindings
. While this method is not deprecated, developers should instead useActionMap
andInputMap
for supplying key bindings.This method returns an array of
KeyBindings
, one for each alternatingkey-action
pair inkeyBindingList
. Akey
can either be aString
in the format specified by theKeyStroke.getKeyStroke
method, or aKeyStroke
. Theaction
part of the pair is aString
that corresponds to the name of theAction
.The following example illustrates creating a
KeyBinding
array from six alternatingkey-action
pairs:JTextComponent.KeyBinding[] multilineBindings = makeKeyBindings( new Object[] { "UP", DefaultEditorKit.upAction, "DOWN", DefaultEditorKit.downAction, "PAGE_UP", DefaultEditorKit.pageUpAction, "PAGE_DOWN", DefaultEditorKit.pageDownAction, "ENTER", DefaultEditorKit.insertBreakAction, "TAB", DefaultEditorKit.insertTabAction });
IfkeyBindingList's
length is odd, the last element is ignored.Supplying a
null
value for either thekey
oraction
part of thekey-action
pair results in creating aKeyBinding
with the corresponding valuenull
. As other parts of Swing's expectnon-null
values in aKeyBinding
, you should avoid supplyingnull
as either thekey
oraction
part of thekey-action
pair.- Parameters:
keyBindingList
- an array ofkey-action
pairs- Returns:
- an array of
KeyBindings
- Throws:
NullPointerException
- ifkeyBindingList
isnull
ClassCastException
- if thekey
part of the pair is not aKeyStroke
orString
, or theaction
part of the pair is not aString
- See Also:
-
makeInputMap
Creates anInputMapUIResource
fromkeys
. This is a convenience method for creating a newInputMapUIResource
, invokingloadKeyBindings(map, keys)
, and returning theInputMapUIResource
.- Parameters:
keys
- alternating pairs ofkeystroke-action key
pairs as described inloadKeyBindings(javax.swing.InputMap, java.lang.Object[])
- Returns:
- newly created and populated
InputMapUIResource
- Since:
- 1.3
- See Also:
-
makeComponentInputMap
Creates aComponentInputMapUIResource
fromkeys
. This is a convenience method for creating a newComponentInputMapUIResource
, invokingloadKeyBindings(map, keys)
, and returning theComponentInputMapUIResource
.- Parameters:
c
- component to create theComponentInputMapUIResource
withkeys
- alternating pairs ofkeystroke-action key
pairs as described inloadKeyBindings(javax.swing.InputMap, java.lang.Object[])
- Returns:
- newly created and populated
InputMapUIResource
- Throws:
IllegalArgumentException
- ifc
isnull
- Since:
- 1.3
- See Also:
-
loadKeyBindings
Populates anInputMap
with the specified bindings. The bindings are supplied as a list of alternatingkeystroke-action key
pairs. Thekeystroke
is either an instance ofKeyStroke
, or aString
that identifies theKeyStroke
for the binding. Refer toKeyStroke.getKeyStroke(String)
for the specific format. Theaction key
part of the pair is the key registered in theInputMap
for theKeyStroke
.The following illustrates loading an
InputMap
with twokey-action
pairs:LookAndFeel.loadKeyBindings(inputMap, new Object[] { "control X", "cut", "control V", "paste" });
Supplying a
null
list of bindings (keys
) does not changeretMap
in any way.Specifying a
null
action key
results in removing thekeystroke's
entry from theInputMap
. Anull
keystroke
is ignored.- Parameters:
retMap
-InputMap
to add thekey-action
pairs tokeys
- bindings to add toretMap
- Throws:
NullPointerException
- ifkeys
isnon-null
, not empty, andretMap
isnull
- Since:
- 1.3
- See Also:
-
makeIcon
Creates and returns aUIDefault.LazyValue
that loads an image. The returned value is an implementation ofUIDefaults.LazyValue
. WhencreateValue
is invoked on the returned object, the image is loaded. If the image isnon-null
, it is then wrapped in anIcon
that implementsUIResource
. The image is loaded usingClass.getResourceAsStream(gifFile)
.This method does not check the arguments in any way. It is strongly recommended that
non-null
values are supplied else exceptions may occur whencreateValue
is invoked on the returned object.- Parameters:
baseClass
-Class
used to load the resourcegifFile
- path to the image to load- Returns:
- a
UIDefaults.LazyValue
; when resolved theLazyValue
loads the specified image - See Also:
-
getLayoutStyle
Returns theLayoutStyle
for this look and feel. This never returnsnull
.You generally don't use the
LayoutStyle
from the look and feel, instead use theLayoutStyle
methodgetInstance
.- Returns:
- the
LayoutStyle
for this look and feel - Since:
- 1.6
- See Also:
-
provideErrorFeedback
Invoked when the user attempts an invalid operation, such as pasting into an uneditableJTextField
that has focus. The default implementation beeps. Subclasses that wish different behavior should override this and provide the additional feedback.- Parameters:
component
- theComponent
the error occurred in, may benull
indicating the error condition is not directly associated with aComponent
- Since:
- 1.4
-
getDesktopPropertyValue
Returns the value of the specified system desktop property by invokingToolkit.getDefaultToolkit().getDesktopProperty()
. If the value of the specified property isnull
,fallbackValue
is returned.- Parameters:
systemPropertyName
- the name of the system desktop property being queriedfallbackValue
- the object to be returned as the value if the system value is null- Returns:
- the current value of the desktop property
- Since:
- 1.4
- See Also:
-
getDisabledIcon
Returns anIcon
with a disabled appearance. This method is used to generate a disabledIcon
when one has not been specified. For example, if you create aJButton
and only specify anIcon
viasetIcon
this method will be called to generate the disabledIcon
. Ifnull
is passed asicon
this method returnsnull
.Some look and feels might not render the disabled
Icon
, in which case they will ignore this.- Parameters:
component
-JComponent
that will display theIcon
, may benull
icon
-Icon
to generate the disabled icon from- Returns:
- disabled
Icon
, ornull
if a suitableIcon
can not be generated - Since:
- 1.5
-
getDisabledSelectedIcon
Returns anIcon
for use by disabled components that are also selected. This method is used to generate anIcon
for components that are in both the disabled and selected states but do not have a specificIcon
for this state. For example, if you create aJButton
and only specify anIcon
viasetIcon
this method will be called to generate the disabled and selectedIcon
. Ifnull
is passed asicon
this methods returnsnull
.Some look and feels might not render the disabled and selected
Icon
, in which case they will ignore this.- Parameters:
component
-JComponent
that will display theIcon
, may benull
icon
-Icon
to generate disabled and selected icon from- Returns:
- disabled and selected icon, or
null
if a suitableIcon
can not be generated. - Since:
- 1.5
-
getName
Return a short string that identifies this look and feel, e.g. "CDE/Motif". This string should be appropriate for a menu item. Distinct look and feels should have different names, e.g. a subclass of MotifLookAndFeel that changes the way a few components are rendered should be called "CDE/Motif My Way"; something that would be useful to a user trying to select a L&F from a list of names.- Returns:
- short identifier for the look and feel
-
getID
Return a string that identifies this look and feel. This string will be used by applications/services that want to recognize well known look and feel implementations. Presently the well known names are "Motif", "Windows", "Mac", "Metal". Note that a LookAndFeel derived from a well known superclass that doesn't make any fundamental changes to the look or feel shouldn't override this method.- Returns:
- identifier for the look and feel
-
getDescription
Return a one line description of this look and feel implementation, e.g. "The CDE/Motif Look and Feel". This string is intended for the user, e.g. in the title of a window or in a ToolTip message.- Returns:
- short description for the look and feel
-
getSupportsWindowDecorations
public boolean getSupportsWindowDecorations()Returnstrue
if theLookAndFeel
returnedRootPaneUI
instances support providingWindow
decorations in aJRootPane
.The default implementation returns
false
, subclasses that supportWindow
decorations should override this and returntrue
.- Returns:
true
if theRootPaneUI
instances created by this look and feel support client side decorations- Since:
- 1.4
- See Also:
-
isNativeLookAndFeel
public abstract boolean isNativeLookAndFeel()If the underlying platform has a "native" look and feel, and this is an implementation of it, returntrue
. For example, when the underlying platform is Solaris running CDE a CDE/Motif look and feel implementation would returntrue
.- Returns:
true
if this look and feel represents the underlying platform look and feel
-
isSupportedLookAndFeel
public abstract boolean isSupportedLookAndFeel()Returntrue
if the underlying platform supports and or permits this look and feel. This method returnsfalse
if the look and feel depends on special resources or legal agreements that aren't defined for the current platform.- Returns:
true
if this is a supported look and feel- See Also:
-
initialize
public void initialize()Initializes the look and feel. While this method is public, it should only be invoked by theUIManager
when a look and feel is installed as the current look and feel. This method is invoked before theUIManager
invokesgetDefaults
. This method is intended to perform any initialization for the look and feel. Subclasses should do any one-time setup they need here, rather than in a static initializer, because look and feel class objects may be loaded just to discover thatisSupportedLookAndFeel()
returnsfalse
.- See Also:
-
uninitialize
public void uninitialize()Uninitializes the look and feel. While this method is public, it should only be invoked by theUIManager
when the look and feel is uninstalled. For example,UIManager.setLookAndFeel
invokes this when the look and feel is changed.Subclasses may choose to free up some resources here.
- See Also:
-
getDefaults
Returns the look and feel defaults. While this method is public, it should only be invoked by theUIManager
when the look and feel is set as the current look and feel and afterinitialize
has been invoked.- Returns:
- the look and feel defaults
- See Also:
-
toString
-