Summary: Ctors | Methods | Protected Methods | Inherited Methods | [Expand All]

public class

NimbusLookAndFeel

extends SynthLookAndFeel

java.lang.Object
↳	javax.swing.LookAndFeel
	↳	javax.swing.plaf.basic.BasicLookAndFeel
		↳	javax.swing.plaf.synth.SynthLookAndFeel
			↳	com.sun.java.swing.plaf.nimbus.NimbusLookAndFeel

Class Overview

The NimbusLookAndFeel class.

Summary

Public Constructors
	NimbusLookAndFeel() Create a new NimbusLookAndFeel.

Public Methods
UIDefaults	getDefaults() Returns the defaults for this SynthLookAndFeel.
Color	getDerivedColor(String uiDefaultParentName, float hOffset, float sOffset, float bOffset, int aOffset, boolean uiResource) Get a derived color, derived colors are shared instances and is color value will change when its parent UIDefault color changes.
String	getDescription() Returns a textual description of this look and feel.
Icon	getDisabledIcon(JComponent component, Icon icon) Returns an `Icon` with a disabled appearance.
String	getID() Return a string that identifies this look and feel.
String	getName() Return a short string that identifies this look and feel.
static NimbusStyle	getStyle(JComponent c, Region r) Gets the style associated with the given component and region.
void	initialize() Called by UIManager when this look and feel is installed.
void	register(Region region, String prefix) Registers a third party component with the NimbusLookAndFeel.
boolean	shouldUpdateStyleOnAncestorChanged() @inheritDoc
boolean	shouldUpdateStyleOnEvent(PropertyChangeEvent ev) Returns whether or not the UIs should update their styles when a particular event occurs.
void	uninitialize() Called by UIManager when this look and feel is uninstalled.

Protected Methods
final Color	getDerivedColor(Color color1, Color color2, float midPoint) Decodes and returns a color, which is derived from a offset between two other colors.
final Color	getDerivedColor(Color color1, Color color2, float midPoint, boolean uiResource) Decodes and returns a color, which is derived from an offset between two other colors.

[Expand]

Inherited Methods

From class javax.swing.plaf.synth.SynthLookAndFeel

static ComponentUI	createUI(JComponent c) Creates the Synth look and feel `ComponentUI` for the passed in `JComponent`.
UIDefaults	getDefaults() Returns the defaults for this SynthLookAndFeel.
String	getDescription() Returns a textual description of SynthLookAndFeel.
String	getID() Return a string that identifies this look and feel.
String	getName() Return a short string that identifies this look and feel.
static Region	getRegion(JComponent c) Returns the Region for the JComponent `c`.
static SynthStyle	getStyle(JComponent c, Region region) Gets a SynthStyle for the specified region of the specified component.
static SynthStyleFactory	getStyleFactory() Returns the current SynthStyleFactory.
void	initialize() Called by UIManager when this look and feel is installed.
boolean	isNativeLookAndFeel() Returns false, SynthLookAndFeel is not a native look and feel.
boolean	isSupportedLookAndFeel() Returns true, SynthLookAndFeel is always supported.
void	load(InputStream input, Class<?> resourceBase) Loads the set of `SynthStyle`s that will be used by this `SynthLookAndFeel`.
void	load(URL url) Loads the set of `SynthStyle`s that will be used by this `SynthLookAndFeel`.
static void	setStyleFactory(SynthStyleFactory cache) Sets the SynthStyleFactory that the UI classes provided by synth will use to obtain a SynthStyle.
boolean	shouldUpdateStyleOnAncestorChanged() Returns whether or not the UIs should update their `SynthStyles` from the `SynthStyleFactory` when the ancestor of the `JComponent` changes.
void	uninitialize() Called by UIManager when this look and feel is uninstalled.
static void	updateStyles(Component c) Updates the style associated with `c`, and all its children.

From class javax.swing.plaf.basic.BasicLookAndFeel

Action	createAudioAction(Object key) Creates and returns an `Action` used to play a sound.
ActionMap	getAudioActionMap() Returns an `ActionMap` containing the audio actions for this look and feel.
UIDefaults	getDefaults() Returns the look and feel defaults.
void	initClassDefaults(UIDefaults table) Populates `table` with mappings from `uiClassID` to the fully qualified name of the ui class.
void	initComponentDefaults(UIDefaults table) Populates `table` with the defaults for the basic look and feel.
void	initSystemColorDefaults(UIDefaults table) Populates `table` with system colors.
void	initialize() Initializes the look and feel.
void	loadSystemColors(UIDefaults table, String[] systemColors, boolean useNative) Populates `table` with the `name-color` pairs in `systemColors`.
void	playSound(Action audioAction) If necessary, invokes `actionPerformed` on `audioAction` to play a sound.
void	uninitialize() Uninitializes the look and feel.

From class javax.swing.LookAndFeel

UIDefaults	getDefaults() Returns the look and feel defaults.
abstract String	getDescription() 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 invoking `Toolkit.getDefaultToolkit().getDesktopProperty()`.
Icon	getDisabledIcon(JComponent component, Icon icon) Returns an `Icon` with a disabled appearance.
Icon	getDisabledSelectedIcon(JComponent component, Icon icon) Returns an `Icon` for use by disabled components that are also selected.
abstract String	getID() Return a string that identifies this look and feel.
LayoutStyle	getLayoutStyle() Returns the `LayoutStyle` for this look and feel.
abstract String	getName() Return a short string that identifies this look and feel, e.g.
boolean	getSupportsWindowDecorations() Returns `true` if the `LookAndFeel` returned `RootPaneUI` instances support providing `Window` decorations in a `JRootPane`.
void	initialize() 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	isNativeLookAndFeel() If the underlying platform has a "native" look and feel, and this is an implementation of it, return `true`.
abstract boolean	isSupportedLookAndFeel() Return `true` if the underlying platform supports and or permits this look and feel.
static void	loadKeyBindings(InputMap retMap, Object[] keys) Populates an `InputMap` with the specified bindings.
static ComponentInputMap	makeComponentInputMap(JComponent c, Object[] keys) Creates a `ComponentInputMapUIResource` from `keys`.
static Object	makeIcon(Class<?> baseClass, String gifFile) Creates and returns a `UIDefault.LazyValue` that loads an image.
static InputMap	makeInputMap(Object[] keys) Creates a `InputMapUIResource` from `keys`.
static KeyBinding[]	makeKeyBindings(Object[] keyBindingList) Convenience method for building an array of `KeyBindings`.
void	provideErrorFeedback(Component component) Invoked when the user attempts an invalid operation, such as pasting into an uneditable `JTextField` that has focus.
String	toString() Returns a string that displays and identifies this object's properties.
void	uninitialize() Uninitializes the look and feel.
static void	uninstallBorder(JComponent c) Convenience method for uninstalling a border.

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

Public Constructors

public NimbusLookAndFeel ()

Create a new NimbusLookAndFeel.

Public Methods

public UIDefaults getDefaults ()

Returns the defaults for this SynthLookAndFeel.

Returns

Defaults table.

public Color getDerivedColor (String uiDefaultParentName, float hOffset, float sOffset, float bOffset, int aOffset, boolean uiResource)

Get a derived color, derived colors are shared instances and is color value will change when its parent UIDefault color changes.

Parameters

uiDefaultParentName	The parent UIDefault key
hOffset	The hue offset
sOffset	The saturation offset
bOffset	The brightness offset
aOffset	The alpha offset
uiResource	True if the derived color should be a UIResource, false if it should not be

Returns

The stored derived color

public String getDescription ()

Returns a textual description of this look and feel.

Returns

textual description of this look and feel.

public Icon getDisabledIcon (JComponent component, Icon icon)

Returns an Icon with a disabled appearance. This method is used to generate a disabled Icon when one has not been specified. For example, if you create a JButton and only specify an Icon via setIcon this method will be called to generate the disabled Icon. If null is passed as icon this method returns null.

Some look and feels might not render the disabled Icon, in which case they will ignore this.

Parameters

component	`JComponent` that will display the `Icon`, may be `null`
icon	`Icon` to generate the disabled icon from

Returns

disabled Icon, or null if a suitable Icon can not be generated

public String getID ()

Return a string that identifies this look and feel. This String will be the unquoted String "Nimbus".

Returns

a short string identifying this look and feel.

public String getName ()

Return a short string that identifies this look and feel. This String will be the unquoted String "Nimbus".

Returns

a short string identifying this look and feel.

public static NimbusStyle getStyle (JComponent c, Region r)

Gets the style associated with the given component and region. This will never return null. If an appropriate component and region cannot be determined, then a default style is returned.

Parameters

c	a non-null reference to a JComponent
r	a non-null reference to the region of the component c

Returns

a non-null reference to a NimbusStyle.

public void initialize ()

Called by UIManager when this look and feel is installed.

public void register (Region region, String prefix)

Registers a third party component with the NimbusLookAndFeel.

Regions represent Components and areas within Components that act as independent painting areas. Once registered with the NimbusLookAndFeel, NimbusStyles for these Regions can be retrieved via the getStyle method.

The NimbusLookAndFeel uses a standard naming scheme for entries in the UIDefaults table. The key for each property, state, painter, and other default registered in UIDefaults for a specific Region will begin with the specified prefix

For example, suppose I had a component named JFoo. Suppose I then registered this component with the NimbusLookAndFeel in this manner:


     laf.register(NimbusFooUI.FOO_REGION, "Foo");

In this case, I could then register properties for this component with UIDefaults in the following manner:


     UIManager.put("Foo.background", new ColorUIResource(Color.BLACK));
     UIManager.put("Foo.Enabled.backgroundPainter", new FooBackgroundPainter());

It is also possible to register a named component with Nimbus. For example, suppose you wanted to style the background of a JPanel named "MyPanel" differently from other JPanels. You could accomplish this by doing the following:


     laf.register(Region.PANEL, "\"MyPanel\"");
     UIManager.put("\"MyPanel\".background", new ColorUIResource(Color.RED));

Parameters

region	The Synth Region that is being registered. Such as Button, or ScrollBarThumb, or NimbusFooUI.FOO_REGION.
prefix	The UIDefault prefix. For example, could be ComboBox, or if a named components, "MyComboBox", or even something like ToolBar."MyComboBox"."ComboBox.arrowButton"

public boolean shouldUpdateStyleOnAncestorChanged ()

@inheritDoc

Returns

true

public boolean shouldUpdateStyleOnEvent (PropertyChangeEvent ev)

Returns whether or not the UIs should update their styles when a particular event occurs. Returns true when one of the following properties change:

"name"
"ancestor"
"Nimbus.Overrides"
"Nimbus.Overrides.InheritDefaults"
"JComponent.sizeVariant"

Parameters

ev	a `PropertyChangeEvent`

Returns

whether or not the UIs should update their styles

public void uninitialize ()

Called by UIManager when this look and feel is uninstalled.

Protected Methods

protected final Color getDerivedColor (Color color1, Color color2, float midPoint)

Decodes and returns a color, which is derived from a offset between two other colors.

Parameters

color1	The first color
color2	The second color
midPoint	The offset between color 1 and color 2, a value of 0.0 is color 1 and 1.0 is color 2;

Returns

The derived color, which will be a UIResource

protected final Color getDerivedColor (Color color1, Color color2, float midPoint, boolean uiResource)

Decodes and returns a color, which is derived from an offset between two other colors.

Parameters

color1	The first color
color2	The second color
midPoint	The offset between color 1 and color 2, a value of 0.0 is color 1 and 1.0 is color 2;
uiResource	True if the derived color should be a UIResource

Returns

The derived color

Classes

Enums

NimbusLookAndFeel

Class Overview

Summary

Public Constructors

public NimbusLookAndFeel ()

Public Methods

public UIDefaults getDefaults ()

Returns

public Color getDerivedColor (String uiDefaultParentName, float hOffset, float sOffset, float bOffset, int aOffset, boolean uiResource)

Parameters

Returns

public String getDescription ()

Returns

public Icon getDisabledIcon (JComponent component, Icon icon)

Parameters

Returns

public String getID ()

Returns

public String getName ()

Returns

public static NimbusStyle getStyle (JComponent c, Region r)

Parameters

Returns

public void initialize ()

public void register (Region region, String prefix)

Parameters

public boolean shouldUpdateStyleOnAncestorChanged ()

Returns

public boolean shouldUpdateStyleOnEvent (PropertyChangeEvent ev)

Parameters

Returns

public void uninitialize ()

Protected Methods

protected final Color getDerivedColor (Color color1, Color color2, float midPoint)

Parameters

Returns

protected final Color getDerivedColor (Color color1, Color color2, float midPoint, boolean uiResource)

Parameters

Returns