javax.swing
Class UIDefaults

java.lang.Object
  |
  +--java.util.Dictionary
        |
        +--java.util.Hashtable
              |
              +--javax.swing.UIDefaults

public class UIDefaults

extends Hashtable

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. A future release of Swing will provide support for long term persistence.

See Also:

UIManager, Serialized Form

Inner Class Summary

static 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.
static 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.

Constructor Summary

UIDefaults()
Create an empty defaults table.

UIDefaults(Object[] keyValueList)
Create a defaults table initialized with the specified key/value pairs.

Method Summary

void	addPropertyChangeListener(PropertyChangeListener listener) Add a PropertyChangeListener to the listener list.
protected void	firePropertyChange(String propertyName, Object oldValue, Object newValue) Support for reporting bound property changes.
Object	get(Object key) Returns the value for key.
Border	getBorder(Object key) If the value of key 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.
Dimension	getDimension(Object key) If the value of key is a Dimension 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) If the value of key is an Icon return it, otherwise return null.
Insets	getInsets(Object key) If the value of key is a Insets return it, otherwise return null.
int	getInt(Object key) If the value of key is a Integer return its integer value, otherwise return 0.
String	getString(Object key) If the value of key is a String return it, otherwise return null.
ComponentUI	getUI(JComponent target) Create an ComponentUI implementation for the specified component.
Class	getUIClass(String uiClassID) Returns the L&F class that renders this component.
Class	getUIClass(String uiClassID, ClassLoader uiClassLoader) The value of get(uidClassID) must be the String name of a class that implements the corresponding ComponentUI class.
protected void	getUIError(String msg) If getUI() fails for any reason, it calls this method before returning null.
Object	put(Object key, Object value) Set the value of key to value.
void	putDefaults(Object[] keyValueList) Put all of the key/value pairs in the database and unconditionally generate one PropertyChangeEvent.
void	removePropertyChangeListener(PropertyChangeListener listener) Remove a PropertyChangeListener from the listener list.

Methods inherited from class java.util.Hashtable

clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, hashCode, isEmpty, keys, keySet, putAll, rehash, remove, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UIDefaults

public UIDefaults()

Create an empty defaults table.

UIDefaults

public UIDefaults(Object[] keyValueList)

Create 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);
 

Method Detail

get

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.

Overrides:

get in class Hashtable

See Also:

UIDefaults.LazyValue, UIDefaults.ActiveValue, Hashtable.get(java.lang.Object)

put

public Object put(Object key,
                  Object value)

Set the value of key to value. 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.

Overrides:

put in class Hashtable

Parameters:

key - the unique Object who's value will be used to retreive the data value associated with it

value - the new Object to store as data under that key

Returns:

the previous Object value, or null

See Also:

putDefaults(java.lang.Object[]), Hashtable.put(java.lang.Object, java.lang.Object)

putDefaults

public void putDefaults(Object[] keyValueList)

Put all of the key/value pairs in the database and unconditionally generate one PropertyChangeEvent. The events oldValue and newValue will be null and its propertyName will be "UIDefaults".

See Also:

put(java.lang.Object, java.lang.Object), Hashtable.put(java.lang.Object, java.lang.Object)

getFont

public Font getFont(Object key)

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

getColor

public Color getColor(Object key)

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

getIcon

public Icon getIcon(Object key)

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

getBorder

public Border getBorder(Object key)

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

getString

public String getString(Object key)

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

getInt

public int getInt(Object key)

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

getInsets

public Insets getInsets(Object key)

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

getDimension

public Dimension getDimension(Object key)

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

getUIClass

public Class 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 neccessary to call it directly.

Returns:

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

See Also:

getUI(javax.swing.JComponent)

getUIClass

public Class getUIClass(String uiClassID)

Returns the L&F class that renders this component.

Returns:

the Class object returned by getUIClass(uiClassID, null)

getUIError

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.

See Also:

getUI(javax.swing.JComponent)

getUI

public ComponentUI getUI(JComponent target)

Create 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:

• Lookup 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.

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Add 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

See Also:

PropertyChangeSupport

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

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

Parameters:

listener - The PropertyChangeListener to be removed

See Also:

PropertyChangeSupport

firePropertyChange

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

Support for reporting bound property changes. If oldValue and newValue are not equal and the PropertyChangeEvent 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.

See Also:

PropertyChangeSupport