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

public class

SynthLookAndFeel

extends BasicLookAndFeel

java.lang.Object
↳	javax.swing.LookAndFeel
	↳	javax.swing.plaf.basic.BasicLookAndFeel
		↳	javax.swing.plaf.synth.SynthLookAndFeel

Known Direct Subclasses

GTKLookAndFeel, NimbusLookAndFeel

Class Overview

SynthLookAndFeel provides the basis for creating a customized look and feel. SynthLookAndFeel does not directly provide a look, all painting is delegated. You need to either provide a configuration file, by way of the load(InputStream, Class) method, or provide your own SynthStyleFactory to setStyleFactory(SynthStyleFactory). Refer to the package summary for an example of loading a file, and SynthStyleFactory for an example of providing your own SynthStyleFactory to setStyleFactory.

Warning: This class implements Serializable as a side effect of it extending BasicLookAndFeel. It is not intended to be serialized. An attempt to serialize it will result in NotSerializableException.

Summary

Public Constructors
	SynthLookAndFeel() Creates a SynthLookAndFeel.

Public Methods
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.

[Expand]

Inherited Methods

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 SynthLookAndFeel ()

Creates a SynthLookAndFeel.

For the returned SynthLookAndFeel to be useful you need to invoke load to specify the set of SynthStyles, or invoke setStyleFactory.

Public Methods

public static ComponentUI createUI (JComponent c)

Creates the Synth look and feel ComponentUI for the passed in JComponent.

Parameters

c	JComponent to create the `ComponentUI` for

Returns

ComponentUI to use for c

public UIDefaults getDefaults ()

Returns the defaults for this SynthLookAndFeel.

Returns

Defaults table.

public String getDescription ()

Returns a textual description of SynthLookAndFeel.

Returns

textual description of synth.

public String getID ()

Return a string that identifies this look and feel.

Returns

a short string identifying this look and feel.

public String getName ()

Return a short string that identifies this look and feel.

Returns

a short string identifying this look and feel.

public static Region getRegion (JComponent c)

Returns the Region for the JComponent c.

Parameters

c	JComponent to fetch the Region for

Returns

Region corresponding to c

public static SynthStyle getStyle (JComponent c, Region region)

Gets a SynthStyle for the specified region of the specified component. This is not for general consumption, only custom UIs should call this method.

Parameters

c	JComponent to get the SynthStyle for
region	Identifies the region of the specified component

Returns

SynthStyle to use.

public static SynthStyleFactory getStyleFactory ()

Returns the current SynthStyleFactory.

Returns

SynthStyleFactory

public void initialize ()

Called by UIManager when this look and feel is installed.

public boolean isNativeLookAndFeel ()

Returns false, SynthLookAndFeel is not a native look and feel.

Returns

false

public boolean isSupportedLookAndFeel ()

Returns true, SynthLookAndFeel is always supported.

Returns

true.

public void load (InputStream input, Class<?> resourceBase)

Loads the set of SynthStyles that will be used by this SynthLookAndFeel. resourceBase is used to resolve any path based resources, for example an Image would be resolved by resourceBase.getResource(path). Refer to Synth File Format for more information.

Parameters

input	InputStream to load from
resourceBase	used to resolve any images or other resources

Throws

ParseException	if there is an error in parsing
IllegalArgumentException	if input or resourceBase is `null`

public void load (URL url)

Loads the set of SynthStyles that will be used by this SynthLookAndFeel. Path based resources are resolved relatively to the specified URL of the style. For example an Image would be resolved by new URL(synthFile, path). Refer to Synth File Format for more information.

Parameters

url	the `URL` to load the set of `SynthStyle` from

Throws

ParseException	if there is an error in parsing
IllegalArgumentException	if synthSet is `null`
IOException	if synthSet cannot be opened as an `InputStream`

public static void setStyleFactory (SynthStyleFactory cache)

Sets the SynthStyleFactory that the UI classes provided by synth will use to obtain a SynthStyle.

Parameters

cache	SynthStyleFactory the UIs should use.

public boolean shouldUpdateStyleOnAncestorChanged ()

Returns whether or not the UIs should update their SynthStyles from the SynthStyleFactory when the ancestor of the JComponent changes. A subclass that provided a SynthStyleFactory that based the return value from getStyle off the containment hierarchy would override this method to return true.

Returns

whether or not the UIs should update their SynthStyles from the SynthStyleFactory when the ancestor changed.

public void uninitialize ()

Called by UIManager when this look and feel is uninstalled.

public static void updateStyles (Component c)

Updates the style associated with c, and all its children. This is a lighter version of SwingUtilities.updateComponentTreeUI.

Parameters

c	Component to update style for.

Interfaces

Classes

SynthLookAndFeel

Class Overview

Summary

Public Constructors

public SynthLookAndFeel ()

See Also

Public Methods

public static ComponentUI createUI (JComponent c)

Parameters

Returns

public UIDefaults getDefaults ()

Returns

public String getDescription ()

Returns

public String getID ()

Returns

public String getName ()

Returns

public static Region getRegion (JComponent c)

Parameters

Returns

public static SynthStyle getStyle (JComponent c, Region region)

Parameters

Returns

public static SynthStyleFactory getStyleFactory ()

Returns

public void initialize ()

public boolean isNativeLookAndFeel ()

Returns

public boolean isSupportedLookAndFeel ()

Returns

public void load (InputStream input, Class<?> resourceBase)

Parameters

Throws

public void load (URL url)

Parameters

Throws

public static void setStyleFactory (SynthStyleFactory cache)

Parameters

public boolean shouldUpdateStyleOnAncestorChanged ()

Returns

public void uninitialize ()

public static void updateStyles (Component c)

Parameters