- java.lang.Object
-
- java.util.Dictionary<K,V>
-
- java.util.Hashtable<Object,Object>
-
- javax.swing.UIDefaults
-
- All Implemented Interfaces:
Serializable
,Cloneable
,Map<Object,Object>
public class UIDefaults extends Hashtable<Object,Object>
A table of defaults for Swing components. Applications can set/get default values via theUIManager
.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™ has been added to the
java.beans
package. Please seeXMLEncoder
.- Since:
- 1.2
- See Also:
UIManager
, Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description 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 thegetXXX(key)
methods.static class
UIDefaults.LazyInputMap
LazyInputMap
will create aInputMap
in itscreateValue
method.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 thegetXXX(key)
methods.static class
UIDefaults.ProxyLazyValue
This class provides an implementation ofLazyValue
which can be used to delay loading of the Class for the instance to be created.
-
Constructor Summary
Constructors Constructor Description 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.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addPropertyChangeListener(PropertyChangeListener listener)
Adds aPropertyChangeListener
to the listener list.void
addResourceBundle(String bundleName)
Adds a resource bundle to the list of resource bundles that are searched for localized values.protected void
firePropertyChange(String propertyName, Object oldValue, Object newValue)
Support for reporting bound property changes.Object
get(Object key)
Returns the value for key.Object
get(Object key, Locale l)
Returns the value for key associated with the given locale.boolean
getBoolean(Object key)
If the value ofkey
is boolean, return the boolean value, otherwise return false.boolean
getBoolean(Object key, Locale l)
If the value ofkey
for the givenLocale
is boolean, return the boolean value, otherwise return false.Border
getBorder(Object key)
If the value ofkey
is aBorder
return it, otherwise returnnull
.Border
getBorder(Object key, Locale l)
If the value ofkey
for the givenLocale
is aBorder
return it, otherwise returnnull
.Color
getColor(Object key)
If the value ofkey
is aColor
return it, otherwise returnnull
.Color
getColor(Object key, Locale l)
If the value ofkey
for the givenLocale
is aColor
return it, otherwise returnnull
.Locale
getDefaultLocale()
Returns the default locale.Dimension
getDimension(Object key)
If the value ofkey
is aDimension
return it, otherwise returnnull
.Dimension
getDimension(Object key, Locale l)
If the value ofkey
for the givenLocale
is aDimension
return it, otherwise returnnull
.Font
getFont(Object key)
If the value ofkey
is aFont
return it, otherwise returnnull
.Font
getFont(Object key, Locale l)
If the value ofkey
for the givenLocale
is aFont
return it, otherwise returnnull
.Icon
getIcon(Object key)
If the value ofkey
is anIcon
return it, otherwise returnnull
.Icon
getIcon(Object key, Locale l)
If the value ofkey
for the givenLocale
is anIcon
return it, otherwise returnnull
.Insets
getInsets(Object key)
If the value ofkey
is anInsets
return it, otherwise returnnull
.Insets
getInsets(Object key, Locale l)
If the value ofkey
for the givenLocale
is anInsets
return it, otherwise returnnull
.int
getInt(Object key)
If the value ofkey
is anInteger
return its integer value, otherwise return 0.int
getInt(Object key, Locale l)
If the value ofkey
for the givenLocale
is anInteger
return its integer value, otherwise return 0.PropertyChangeListener[]
getPropertyChangeListeners()
Returns an array of all thePropertyChangeListener
s added to this UIDefaults with addPropertyChangeListener().String
getString(Object key)
If the value ofkey
is aString
return it, otherwise returnnull
.String
getString(Object key, Locale l)
If the value ofkey
for the givenLocale
is aString
return it, otherwise returnnull
.ComponentUI
getUI(JComponent target)
Creates anComponentUI
implementation for the specified component.Class<? extends ComponentUI>
getUIClass(String uiClassID)
Returns the L&F class that renders this component.Class<? extends ComponentUI>
getUIClass(String uiClassID, ClassLoader uiClassLoader)
The value ofget(uidClassID)
must be theString
name of a class that implements the correspondingComponentUI
class.protected void
getUIError(String msg)
IfgetUI()
fails for any reason, it calls this method before returningnull
.Object
put(Object key, Object value)
Sets the value ofkey
tovalue
for all locales.void
putDefaults(Object[] keyValueList)
Puts all of the key/value pairs in the database and unconditionally generates onePropertyChangeEvent
.void
removePropertyChangeListener(PropertyChangeListener listener)
Removes aPropertyChangeListener
from the listener list.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.-
Methods declared in class java.util.Hashtable
clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, hashCode, isEmpty, keys, keySet, merge, putAll, rehash, remove, size, toString, values
-
Methods declared in interface java.util.Map
forEach, getOrDefault, putIfAbsent, remove, replace, replace, replaceAll
-
-
-
-
Constructor Detail
-
UIDefaults
public UIDefaults()
Creates an empty defaults table.
-
UIDefaults
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 tableloadFactor
- the load factor of the defaults table- Since:
- 1.6
- See Also:
Hashtable
-
UIDefaults
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", Integer.valueOf(5) } UIDefaults myDefaults = new UIDefaults(uiDefaults);
- Parameters:
keyValueList
- an array of objects containing the key/value pairs
-
-
Method Detail
-
get
public Object get(Object key)
Returns the value for key. If the value is aUIDefaults.LazyValue
then the real value is computed withLazyValue.createValue()
, the table entry is replaced, and the real value is returned. If the value is anUIDefaults.ActiveValue
the table entry is not replaced - the value is computed withActiveValue.createValue()
for eachget()
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 bygetDefaultLocale
.LazyValues
andActiveValues
are not supported in the resource bundles.- Specified by:
get
in interfaceMap<Object,Object>
- Overrides:
get
in classHashtable<Object,Object>
- Parameters:
key
- the desired key- Returns:
- the value for
key
- Since:
- 1.4
- See Also:
UIDefaults.LazyValue
,UIDefaults.ActiveValue
,Hashtable.get(java.lang.Object)
,getDefaultLocale()
,addResourceBundle(java.lang.String)
-
get
public Object get(Object key, Locale l)
Returns the value for key associated with the given locale. If the value is aUIDefaults.LazyValue
then the real value is computed withLazyValue.createValue()
, the table entry is replaced, and the real value is returned. If the value is anUIDefaults.ActiveValue
the table entry is not replaced - the value is computed withActiveValue.createValue()
for eachget()
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
andActiveValues
are not supported in the resource bundles.- Parameters:
key
- the desired keyl
- the desiredlocale
- Returns:
- the value for
key
- Since:
- 1.4
- See Also:
UIDefaults.LazyValue
,UIDefaults.ActiveValue
,Hashtable.get(java.lang.Object)
,addResourceBundle(java.lang.String)
-
put
public Object put(Object key, Object value)
Sets the value ofkey
tovalue
for all locales. Ifkey
is a string and the new value isn't equal to the old one, fire aPropertyChangeEvent
. If value isnull
, the key is removed from the table.- Specified by:
put
in interfaceMap<Object,Object>
- Overrides:
put
in classHashtable<Object,Object>
- Parameters:
key
- the uniqueObject
who's value will be used to retrieve the data value associated with itvalue
- the newObject
to store as data under that key- Returns:
- the previous
Object
value, ornull
- See Also:
putDefaults(java.lang.Object[])
,Hashtable.put(K, V)
-
putDefaults
public void putDefaults(Object[] keyValueList)
Puts all of the key/value pairs in the database and unconditionally generates onePropertyChangeEvent
. The events oldValue and newValue will benull
and itspropertyName
will be "UIDefaults". The key/value pairs are added for all locales.- Parameters:
keyValueList
- an array of key/value pairs- See Also:
put(java.lang.Object, java.lang.Object)
,Hashtable.put(K, V)
-
getFont
public Font getFont(Object key)
If the value ofkey
is aFont
return it, otherwise returnnull
.- Parameters:
key
- the desired key- Returns:
- if the value for
key
is aFont
, return theFont
object; otherwise returnnull
-
getFont
public Font getFont(Object key, Locale l)
If the value ofkey
for the givenLocale
is aFont
return it, otherwise returnnull
.- Parameters:
key
- the desired keyl
- the desired locale- Returns:
- if the value for
key
andLocale
is aFont
, return theFont
object; otherwise returnnull
- Since:
- 1.4
-
getColor
public Color getColor(Object key)
If the value ofkey
is aColor
return it, otherwise returnnull
.- Parameters:
key
- the desired key- Returns:
- if the value for
key
is aColor
, return theColor
object; otherwise returnnull
-
getColor
public Color getColor(Object key, Locale l)
If the value ofkey
for the givenLocale
is aColor
return it, otherwise returnnull
.- Parameters:
key
- the desired keyl
- the desired locale- Returns:
- if the value for
key
andLocale
is aColor
, return theColor
object; otherwise returnnull
- Since:
- 1.4
-
getIcon
public Icon getIcon(Object key)
If the value ofkey
is anIcon
return it, otherwise returnnull
.- Parameters:
key
- the desired key- Returns:
- if the value for
key
is anIcon
, return theIcon
object; otherwise returnnull
-
getIcon
public Icon getIcon(Object key, Locale l)
If the value ofkey
for the givenLocale
is anIcon
return it, otherwise returnnull
.- Parameters:
key
- the desired keyl
- the desired locale- Returns:
- if the value for
key
andLocale
is anIcon
, return theIcon
object; otherwise returnnull
- Since:
- 1.4
-
getBorder
public Border getBorder(Object key)
If the value ofkey
is aBorder
return it, otherwise returnnull
.- Parameters:
key
- the desired key- Returns:
- if the value for
key
is aBorder
, return theBorder
object; otherwise returnnull
-
getBorder
public Border getBorder(Object key, Locale l)
If the value ofkey
for the givenLocale
is aBorder
return it, otherwise returnnull
.- Parameters:
key
- the desired keyl
- the desired locale- Returns:
- if the value for
key
andLocale
is aBorder
, return theBorder
object; otherwise returnnull
- Since:
- 1.4
-
getString
public String getString(Object key)
If the value ofkey
is aString
return it, otherwise returnnull
.- Parameters:
key
- the desired key- Returns:
- if the value for
key
is aString
, return theString
object; otherwise returnnull
-
getString
public String getString(Object key, Locale l)
If the value ofkey
for the givenLocale
is aString
return it, otherwise returnnull
.- Parameters:
key
- the desired keyl
- the desiredLocale
- Returns:
- if the value for
key
for the givenLocale
is aString
, return theString
object; otherwise returnnull
- Since:
- 1.4
-
getInt
public int getInt(Object key)
If the value ofkey
is anInteger
return its integer value, otherwise return 0.- Parameters:
key
- the desired key- Returns:
- if the value for
key
is anInteger
, return its value, otherwise return 0
-
getInt
public int getInt(Object key, Locale l)
If the value ofkey
for the givenLocale
is anInteger
return its integer value, otherwise return 0.- Parameters:
key
- the desired keyl
- the desired locale- Returns:
- if the value for
key
andLocale
is anInteger
, return its value, otherwise return 0 - Since:
- 1.4
-
getBoolean
public boolean getBoolean(Object key)
If the value ofkey
is boolean, return the boolean value, otherwise return false.- Parameters:
key
- anObject
specifying the key for the desired boolean value- Returns:
- if the value of
key
is boolean, return the boolean value, otherwise return false. - Since:
- 1.4
-
getBoolean
public boolean getBoolean(Object key, Locale l)
If the value ofkey
for the givenLocale
is boolean, return the boolean value, otherwise return false.- Parameters:
key
- anObject
specifying the key for the desired boolean valuel
- the desired locale- Returns:
- if the value for
key
andLocale
is boolean, return the boolean value, otherwise return false. - Since:
- 1.4
-
getInsets
public Insets getInsets(Object key)
If the value ofkey
is anInsets
return it, otherwise returnnull
.- Parameters:
key
- the desired key- Returns:
- if the value for
key
is anInsets
, return theInsets
object; otherwise returnnull
-
getInsets
public Insets getInsets(Object key, Locale l)
If the value ofkey
for the givenLocale
is anInsets
return it, otherwise returnnull
.- Parameters:
key
- the desired keyl
- the desired locale- Returns:
- if the value for
key
andLocale
is anInsets
, return theInsets
object; otherwise returnnull
- Since:
- 1.4
-
getDimension
public Dimension getDimension(Object key)
If the value ofkey
is aDimension
return it, otherwise returnnull
.- Parameters:
key
- the desired key- Returns:
- if the value for
key
is aDimension
, return theDimension
object; otherwise returnnull
-
getDimension
public Dimension getDimension(Object key, Locale l)
If the value ofkey
for the givenLocale
is aDimension
return it, otherwise returnnull
.- Parameters:
key
- the desired keyl
- the desired locale- Returns:
- if the value for
key
andLocale
is aDimension
, return theDimension
object; otherwise returnnull
- Since:
- 1.4
-
getUIClass
public Class<? extends ComponentUI> getUIClass(String uiClassID, ClassLoader uiClassLoader)
The value ofget(uidClassID)
must be theString
name of a class that implements the correspondingComponentUI
class. If the class hasn't been loaded before, this method looks up the class withuiClassLoader.loadClass()
if a nonnull
class loader is provided,classForName()
otherwise.If a mapping for
uiClassID
exists or if the specified class can't be found, returnnull
.This method is used by
getUI
, it's usually not necessary to call it directly.- Parameters:
uiClassID
- a string containing the class IDuiClassLoader
- the object which will load the class- Returns:
- the value of
Class.forName(get(uidClassID))
- See Also:
getUI(javax.swing.JComponent)
-
getUIClass
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)
-
getUIError
protected void getUIError(String msg)
IfgetUI()
fails for any reason, it calls this method before returningnull
. 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)
Creates anComponentUI
implementation for the specified component. In other words create the look and feel specific delegate object fortarget
. This is done in two steps:- Look up the name of the
ComponentUI
implementation class under the value returned bytarget.getUIClassID()
. - Use the implementation classes static
createUI()
method to construct a look and feel delegate.
- Parameters:
target
- theJComponent
which needs a UI- Returns:
- the
ComponentUI
object
- Look up the name of the
-
addPropertyChangeListener
public void addPropertyChangeListener(PropertyChangeListener listener)
Adds aPropertyChangeListener
to the listener list. The listener is registered for all properties.A
PropertyChangeEvent
will get fired whenever a default is changed.- Parameters:
listener
- thePropertyChangeListener
to be added- See Also:
PropertyChangeSupport
-
removePropertyChangeListener
public void removePropertyChangeListener(PropertyChangeListener listener)
Removes aPropertyChangeListener
from the listener list. This removes aPropertyChangeListener
that was registered for all properties.- Parameters:
listener
- thePropertyChangeListener
to be removed- See Also:
PropertyChangeSupport
-
getPropertyChangeListeners
public PropertyChangeListener[] getPropertyChangeListeners()
Returns an array of all thePropertyChangeListener
s added to this UIDefaults with addPropertyChangeListener().- Returns:
- all of the
PropertyChangeListener
s added or an empty array if no listeners have been added - Since:
- 1.4
-
firePropertyChange
protected void firePropertyChange(String propertyName, Object oldValue, Object newValue)
Support for reporting bound property changes. If oldValue and newValue are not equal and thePropertyChangeEvent
x listener list isn't empty, then fire aPropertyChange
event to each listener.- Parameters:
propertyName
- the programmatic name of the property that was changedoldValue
- the old value of the propertynewValue
- the new value of the property- See Also:
PropertyChangeSupport
-
addResourceBundle
public 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, using the system class loader. In other words, the most recently added bundle is searched first.- Parameters:
bundleName
- the base name of the resource bundle to be added- Since:
- 1.4
- See Also:
ResourceBundle
,removeResourceBundle(java.lang.String)
,ResourceBundle.getBundle(String, Locale, ClassLoader)
-
removeResourceBundle
public 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- Since:
- 1.4
- See Also:
ResourceBundle
,addResourceBundle(java.lang.String)
-
setDefaultLocale
public void setDefaultLocale(Locale l)
Sets the default locale. The default locale is used in retrieving localized values viaget
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- Since:
- 1.4
- See Also:
getDefaultLocale()
,get(Object)
,get(Object,Locale)
-
getDefaultLocale
public Locale getDefaultLocale()
Returns the default locale. The default locale is used in retrieving localized values viaget
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
- Since:
- 1.4
- See Also:
setDefaultLocale(java.util.Locale)
,get(Object)
,get(Object,Locale)
-
-