public class

UIDefaults

extends Hashtable<K, V>

java.lang.Object
↳	java.util.Dictionary<K, V>
	↳	java.util.Hashtable<K, V>
		↳	javax.swing.UIDefaults

Class Overview

A table of defaults for Swing components. Applications can set/get default values via the UIManager.

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^TM has been added to the java.beans package. Please see XMLEncoder.

Summary

Nested Classes
interface	UIDefaults.ActiveValue	This class enables one to store an entry in the defaults table that's constructed each time it's looked up with one of the `getXXX(key)` methods.
class	UIDefaults.LazyInputMap	`LazyInputMap` will create a `InputMap` in its `createValue` method.
interface	UIDefaults.LazyValue	This class enables one to store an entry in the defaults table that isn't constructed until the first time it's looked up with one of the `getXXX(key)` methods.
class	UIDefaults.ProxyLazyValue	This class provides an implementation of `LazyValue` which can be used to delay loading of the Class for the instance to be created.

Public Constructors
	UIDefaults() Creates an empty defaults table.
	UIDefaults(int initialCapacity, float loadFactor) Creates an empty defaults table with the specified initial capacity and load factor.
	UIDefaults(Object[] keyValueList) Creates a defaults table initialized with the specified key/value pairs.

Public Methods
synchronized void	addPropertyChangeListener(PropertyChangeListener listener) Adds a `PropertyChangeListener` to the listener list.
synchronized void	addResourceBundle(String bundleName) Adds a resource bundle to the list of resource bundles that are searched for localized values.
Object	get(Object key, Locale l) Returns the value for key associated with the given locale.
Object	get(Object key) Returns the value for key.
boolean	getBoolean(Object key, Locale l) If the value of `key` for the given `Locale` is boolean, return the boolean value, otherwise return false.
boolean	getBoolean(Object key) If the value of `key` is boolean, return the boolean value, otherwise return false.
Border	getBorder(Object key) If the value of `key` is a `Border` return it, otherwise return `null`.
Border	getBorder(Object key, Locale l) If the value of `key` for the given `Locale` is a `Border` return it, otherwise return `null`.
Color	getColor(Object key) If the value of `key` is a `Color` return it, otherwise return `null`.
Color	getColor(Object key, Locale l) If the value of `key` for the given `Locale` is a `Color` return it, otherwise return `null`.
Locale	getDefaultLocale() Returns the default locale.
Dimension	getDimension(Object key, Locale l) If the value of `key` for the given `Locale` is a `Dimension` return it, otherwise return `null`.
Dimension	getDimension(Object key) If the value of `key` is a `Dimension` return it, otherwise return `null`.
Font	getFont(Object key, Locale l) If the value of `key` for the given `Locale` is a `Font` return it, otherwise return `null`.
Font	getFont(Object key) If the value of `key` is a `Font` return it, otherwise return `null`.
Icon	getIcon(Object key, Locale l) If the value of `key` for the given `Locale` is an `Icon` return it, otherwise return `null`.
Icon	getIcon(Object key) If the value of `key` is an `Icon` return it, otherwise return `null`.
Insets	getInsets(Object key) If the value of `key` is an `Insets` return it, otherwise return `null`.
Insets	getInsets(Object key, Locale l) If the value of `key` for the given `Locale` is an `Insets` return it, otherwise return `null`.
int	getInt(Object key) If the value of `key` is an `Integer` return its integer value, otherwise return 0.
int	getInt(Object key, Locale l) If the value of `key` for the given `Locale` is an `Integer` return its integer value, otherwise return 0.
synchronized PropertyChangeListener[]	getPropertyChangeListeners() Returns an array of all the `PropertyChangeListener`s added to this UIDefaults with addPropertyChangeListener().
String	getString(Object key) If the value of `key` is a `String` return it, otherwise return `null`.
String	getString(Object key, Locale l) If the value of `key` for the given `Locale` is a `String` return it, otherwise return `null`.
ComponentUI	getUI(JComponent target) Creates an `ComponentUI` implementation for the specified component.
Class<? extends ComponentUI>	getUIClass(String uiClassID, ClassLoader uiClassLoader) The value of `get(uidClassID)` must be the `String` name of a class that implements the corresponding `ComponentUI` class.
Class<? extends ComponentUI>	getUIClass(String uiClassID) Returns the L&F class that renders this component.
Object	put(Object key, Object value) Sets the value of `key` to `value` for all locales.
void	putDefaults(Object[] keyValueList) Puts all of the key/value pairs in the database and unconditionally generates one `PropertyChangeEvent`.
synchronized void	removePropertyChangeListener(PropertyChangeListener listener) Removes a `PropertyChangeListener` from the listener list.
synchronized void	removeResourceBundle(String bundleName) Removes a resource bundle from the list of resource bundles that are searched for localized defaults.
void	setDefaultLocale(Locale l) Sets the default locale.

Protected Methods
void	firePropertyChange(String propertyName, Object oldValue, Object newValue) Support for reporting bound property changes.
void	getUIError(String msg) If `getUI()` fails for any reason, it calls this method before returning `null`.

[Expand]

Inherited Methods

From class java.util.Hashtable

synchronized void	clear() Clears this hashtable so that it contains no keys.
synchronized Object	clone() Creates a shallow copy of this hashtable.
synchronized boolean	contains(Object value) Tests if some key maps into the specified value in this hashtable.
synchronized boolean	containsKey(Object key) Tests if the specified object is a key in this hashtable.
boolean	containsValue(Object value) Returns true if this hashtable maps one or more keys to this value.
synchronized Enumeration<V>	elements() Returns an enumeration of the values in this hashtable.
Set<Entry<K, V>>	entrySet() Returns a `Set` view of the mappings contained in this map.
synchronized boolean	equals(Object o) Compares the specified Object with this Map for equality, as per the definition in the Map interface.
synchronized V	get(Object key) Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key.
synchronized int	hashCode() Returns the hash code value for this Map as per the definition in the Map interface.
synchronized boolean	isEmpty() Tests if this hashtable maps no keys to values.
Set<K>	keySet() Returns a `Set` view of the keys contained in this map.
synchronized Enumeration<K>	keys() Returns an enumeration of the keys in this hashtable.
synchronized V	put(K key, V value) Maps the specified `key` to the specified `value` in this hashtable.
synchronized void	putAll(Map<? extends K, ? extends V> t) Copies all of the mappings from the specified map to this hashtable.
void	rehash() Increases the capacity of and internally reorganizes this hashtable, in order to accommodate and access its entries more efficiently.
synchronized V	remove(Object key) Removes the key (and its corresponding value) from this hashtable.
synchronized int	size() Returns the number of keys in this hashtable.
synchronized String	toString() Returns a string representation of this `Hashtable` object in the form of a set of entries, enclosed in braces and separated by the ASCII characters "`,` " (comma and space).
Collection<V>	values() Returns a `Collection` view of the values contained in this map.

From class java.util.Dictionary

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.

From interface java.util.Map

abstract void	clear() Removes all of the mappings from this map (optional operation).
abstract boolean	containsKey(Object key) Returns `true` if this map contains a mapping for the specified key.
abstract boolean	containsValue(Object value) Returns `true` if this map maps one or more keys to the specified value.
abstract Set<Entry<K, V>>	entrySet() Returns a `Set` view of the mappings contained in this map.
abstract boolean	equals(Object o) Compares the specified object with this map for equality.
abstract V	get(Object key) Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key.
abstract int	hashCode() Returns the hash code value for this map.
abstract boolean	isEmpty() Returns `true` if this map contains no key-value mappings.
abstract Set<K>	keySet() Returns a `Set` view of the keys contained in this map.
abstract V	put(K key, V value) Associates the specified value with the specified key in this map (optional operation).
abstract void	putAll(Map<? extends K, ? extends V> m) Copies all of the mappings from the specified map to this map (optional operation).
abstract V	remove(Object key) Removes the mapping for a key from this map if it is present (optional operation).
abstract int	size() Returns the number of key-value mappings in this map.
abstract Collection<V>	values() Returns a `Collection` view of the values contained in this map.

Public Constructors

public UIDefaults ()

Creates an empty defaults table.

public UIDefaults (int initialCapacity, float loadFactor)

Creates an empty defaults table with the specified initial capacity and load factor.

Parameters

initialCapacity	the initial capacity of the defaults table
loadFactor	the load factor of the defaults table

public UIDefaults (Object[] keyValueList)

Creates a defaults table initialized with the specified key/value pairs. For example:

        Object[] uiDefaults = {
             "Font", new Font("Dialog", Font.BOLD, 12),
            "Color", Color.red,
             "five", new Integer(5)
        }
        UIDefaults myDefaults = new UIDefaults(uiDefaults);

Parameters

keyValueList	an array of objects containing the key/value pairs

Public Methods

public synchronized void addPropertyChangeListener (PropertyChangeListener listener)

Adds a PropertyChangeListener to the listener list. The listener is registered for all properties.

A PropertyChangeEvent will get fired whenever a default is changed.

Parameters

listener	the `PropertyChangeListener` to be added

public synchronized void addResourceBundle (String bundleName)

Adds a resource bundle to the list of resource bundles that are searched for localized values. Resource bundles are searched in the reverse order they were added. In other words, the most recently added bundle is searched first.

Parameters

bundleName	the base name of the resource bundle to be added

public Object get (Object key, Locale l)

Returns the value for key associated with the given locale. If the value is a UIDefaults.LazyValue then the real value is computed with LazyValue.createValue(), the table entry is replaced, and the real value is returned. If the value is an UIDefaults.ActiveValue the table entry is not replaced - the value is computed with ActiveValue.createValue() for each get() call. If the key is not found in the table then it is searched for in the list of resource bundles maintained by this object. The resource bundles are searched most recently added first using the given locale. LazyValues and ActiveValues are not supported in the resource bundles.

Parameters

key	the desired key
l	the desired `locale`

Returns

the value for key

public Object get (Object key)

Returns the value for key. If the value is a UIDefaults.LazyValue then the real value is computed with LazyValue.createValue(), the table entry is replaced, and the real value is returned. If the value is an UIDefaults.ActiveValue the table entry is not replaced - the value is computed with ActiveValue.createValue() for each get() call. If the key is not found in the table then it is searched for in the list of resource bundles maintained by this object. The resource bundles are searched most recently added first using the locale returned by getDefaultLocale. LazyValues and ActiveValues are not supported in the resource bundles.

Parameters

key	the desired key

Returns

the value for key

public boolean getBoolean (Object key, Locale l)

If the value of key for the given Locale is boolean, return the boolean value, otherwise return false.

Parameters

key	an `Object` specifying the key for the desired boolean value
l	the desired locale

Returns

if the value for key and Locale is boolean, return the boolean value, otherwise return false.

public boolean getBoolean (Object key)

If the value of key is boolean, return the boolean value, otherwise return false.

Parameters

key	an `Object` specifying the key for the desired boolean value

Returns

if the value of key is boolean, return the boolean value, otherwise return false.

public Border getBorder (Object key)

If the value of key is a Border return it, otherwise return null.

Parameters

key	the desired key

Returns

if the value for key is a Border, return the Border object; otherwise return null

public Border getBorder (Object key, Locale l)

If the value of key for the given Locale is a Border return it, otherwise return null.

Parameters

key	the desired key
l	the desired locale

Returns

if the value for key and Locale is a Border, return the Border object; otherwise return null

public Color getColor (Object key)

If the value of key is a Color return it, otherwise return null.

Parameters

key	the desired key

Returns

if the value for key is a Color, return the Color object; otherwise return null

public Color getColor (Object key, Locale l)

If the value of key for the given Locale is a Color return it, otherwise return null.

Parameters

key	the desired key
l	the desired locale

Returns

if the value for key and Locale is a Color, return the Color object; otherwise return null

public Locale getDefaultLocale ()

Returns the default locale. The default locale is used in retrieving localized values via get methods that do not take a locale argument. As of release 1.4, Swing UI objects should retrieve localized values using the locale of their component rather than the default locale. The default locale exists to provide compatibility with pre 1.4 behaviour.

Returns

the default locale

public Dimension getDimension (Object key, Locale l)

If the value of key for the given Locale is a Dimension return it, otherwise return null.

Parameters

key	the desired key
l	the desired locale

Returns

if the value for key and Locale is a Dimension, return the Dimension object; otherwise return null

public Dimension getDimension (Object key)

If the value of key is a Dimension return it, otherwise return null.

Parameters

key	the desired key

Returns

if the value for key is a Dimension, return the Dimension object; otherwise return null

public Font getFont (Object key, Locale l)

If the value of key for the given Locale is a Font return it, otherwise return null.

Parameters

key	the desired key
l	the desired locale

Returns

if the value for key and Locale is a Font, return the Font object; otherwise return null

public Font getFont (Object key)

If the value of key is a Font return it, otherwise return null.

Parameters

key	the desired key

Returns

if the value for key is a Font, return the Font object; otherwise return null

public Icon getIcon (Object key, Locale l)

If the value of key for the given Locale is an Icon return it, otherwise return null.

Parameters

key	the desired key
l	the desired locale

Returns

if the value for key and Locale is an Icon, return the Icon object; otherwise return null

public Icon getIcon (Object key)

If the value of key is an Icon return it, otherwise return null.

Parameters

key	the desired key

Returns

if the value for key is an Icon, return the Icon object; otherwise return null

public Insets getInsets (Object key)

If the value of key is an Insets return it, otherwise return null.

Parameters

key	the desired key

Returns

if the value for key is an Insets, return the Insets object; otherwise return null

public Insets getInsets (Object key, Locale l)

If the value of key for the given Locale is an Insets return it, otherwise return null.

Parameters

key	the desired key
l	the desired locale

Returns

if the value for key and Locale is an Insets, return the Insets object; otherwise return null

public int getInt (Object key)

If the value of key is an Integer return its integer value, otherwise return 0.

Parameters

key	the desired key

Returns

if the value for key is an Integer, return its value, otherwise return 0

public int getInt (Object key, Locale l)

If the value of key for the given Locale is an Integer return its integer value, otherwise return 0.

Parameters

key	the desired key
l	the desired locale

Returns

if the value for key and Locale is an Integer, return its value, otherwise return 0

public synchronized PropertyChangeListener[] getPropertyChangeListeners ()

Returns an array of all the PropertyChangeListeners added to this UIDefaults with addPropertyChangeListener().

Returns

all of the PropertyChangeListeners added or an empty array if no listeners have been added

public String getString (Object key)

If the value of key is a String return it, otherwise return null.

Parameters

key	the desired key

Returns

if the value for key is a String, return the String object; otherwise return null

public String getString (Object key, Locale l)

If the value of key for the given Locale is a String return it, otherwise return null.

Parameters

key	the desired key
l	the desired `Locale`

Returns

if the value for key for the given Locale is a String, return the String object; otherwise return null

public ComponentUI getUI (JComponent target)

Creates an ComponentUI implementation for the specified component. In other words create the look and feel specific delegate object for target. This is done in two steps:

Look up the name of the ComponentUI implementation class under the value returned by target.getUIClassID().
Use the implementation classes static createUI() method to construct a look and feel delegate.

Parameters

target	the `JComponent` which needs a UI

Returns

the ComponentUI object

public Class<? extends ComponentUI> getUIClass (String uiClassID, ClassLoader uiClassLoader)

The value of get(uidClassID) must be the String name of a class that implements the corresponding ComponentUI class. If the class hasn't been loaded before, this method looks up the class with uiClassLoader.loadClass() if a non null class loader is provided, classForName() otherwise.

If a mapping for uiClassID exists or if the specified class can't be found, return null.

This method is used by getUI, it's usually not necessary to call it directly.

Parameters

uiClassID	a string containing the class ID
uiClassLoader	the object which will load the class

Returns

the value of Class.forName(get(uidClassID))

public Class<? extends ComponentUI> getUIClass (String uiClassID)

Returns the L&F class that renders this component.

Parameters

uiClassID	a string containing the class ID

Returns

the Class object returned by getUIClass(uiClassID, null)

public Object put (Object key, Object value)

Sets the value of key to value for all locales. If key is a string and the new value isn't equal to the old one, fire a PropertyChangeEvent. If value is null, the key is removed from the table.

Parameters

key	the unique `Object` who's value will be used to retrieve the data value associated with it
value	the new `Object` to store as data under that key

Returns

the previous Object value, or null

public void putDefaults (Object[] keyValueList)

Puts all of the key/value pairs in the database and unconditionally generates one PropertyChangeEvent. The events oldValue and newValue will be null and its propertyName will be "UIDefaults". The key/value pairs are added for all locales.

Parameters

keyValueList	an array of key/value pairs

public synchronized void removePropertyChangeListener (PropertyChangeListener listener)

Removes a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties.

Parameters

listener	the `PropertyChangeListener` to be removed

public synchronized void removeResourceBundle (String bundleName)

Removes a resource bundle from the list of resource bundles that are searched for localized defaults.

Parameters

bundleName	the base name of the resource bundle to be removed

public void setDefaultLocale (Locale l)

Sets the default locale. The default locale is used in retrieving localized values via get methods that do not take a locale argument. As of release 1.4, Swing UI objects should retrieve localized values using the locale of their component rather than the default locale. The default locale exists to provide compatibility with pre 1.4 behaviour.

Parameters

l	the new default locale

Protected Methods

protected void firePropertyChange (String propertyName, Object oldValue, Object newValue)

Support for reporting bound property changes. If oldValue and newValue are not equal and the PropertyChangeEventx listener list isn't empty, then fire a PropertyChange event to each listener.

Parameters

propertyName	the programmatic name of the property that was changed
oldValue	the old value of the property
newValue	the new value of the property

protected void getUIError (String msg)

If getUI() fails for any reason, it calls this method before returning null. Subclasses may choose to do more or less here.

Parameters

msg	message string to print

Interfaces

Classes

Enums

Exceptions

UIDefaults

Class Overview

See Also

Summary

Public Constructors

public UIDefaults ()

public UIDefaults (int initialCapacity, float loadFactor)

Parameters

See Also

public UIDefaults (Object[] keyValueList)

Parameters

Public Methods

public synchronized void addPropertyChangeListener (PropertyChangeListener listener)

Parameters

See Also

public synchronized void addResourceBundle (String bundleName)

Parameters

See Also

public Object get (Object key, Locale l)

Parameters

Returns

See Also

public Object get (Object key)

Parameters

Returns

See Also

public boolean getBoolean (Object key, Locale l)

Parameters

Returns

public boolean getBoolean (Object key)

Parameters

Returns

public Border getBorder (Object key)

Parameters

Returns

public Border getBorder (Object key, Locale l)

Parameters

Returns

public Color getColor (Object key)

Parameters

Returns

public Color getColor (Object key, Locale l)

Parameters

Returns

public Locale getDefaultLocale ()

Returns

See Also

public Dimension getDimension (Object key, Locale l)

Parameters

Returns

public Dimension getDimension (Object key)

Parameters

Returns

public Font getFont (Object key, Locale l)

Parameters

Returns

public Font getFont (Object key)

Parameters

Returns

public Icon getIcon (Object key, Locale l)

Parameters

Returns

public Icon getIcon (Object key)

Parameters

Returns

public Insets getInsets (Object key)

Parameters

Returns

public Insets getInsets (Object key, Locale l)

Parameters

Returns

public int getInt (Object key)

Parameters

Returns

public int getInt (Object key, Locale l)

Parameters