Class UIDefaults
- All Implemented Interfaces:
Serializable
,Cloneable
,Map<Object,
Object>
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
has been added to the java.beans
package.
Please see XMLEncoder
.
- Since:
- 1.2
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
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
LazyInputMap
will create aInputMap
in itscreateValue
method.static interface
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
This class provides an implementation ofLazyValue
which can be used to delay loading of the Class for the instance to be created. -
Constructor Summary
ConstructorDescriptionCreates 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
Modifier and TypeMethodDescriptionvoid
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.Returns the value for key.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.If the value ofkey
is aBorder
return it, otherwise returnnull
.If the value ofkey
for the givenLocale
is aBorder
return it, otherwise returnnull
.If the value ofkey
is aColor
return it, otherwise returnnull
.If the value ofkey
for the givenLocale
is aColor
return it, otherwise returnnull
.Returns the default locale.getDimension
(Object key) If the value ofkey
is aDimension
return it, otherwise returnnull
.getDimension
(Object key, Locale l) If the value ofkey
for the givenLocale
is aDimension
return it, otherwise returnnull
.If the value ofkey
is aFont
return it, otherwise returnnull
.If the value ofkey
for the givenLocale
is aFont
return it, otherwise returnnull
.If the value ofkey
is anIcon
return it, otherwise returnnull
.If the value ofkey
for the givenLocale
is anIcon
return it, otherwise returnnull
.If the value ofkey
is anInsets
return it, otherwise returnnull
.If the value ofkey
for the givenLocale
is anInsets
return it, otherwise returnnull
.int
If the value ofkey
is anInteger
return its integer value, otherwise return 0.int
If the value ofkey
for the givenLocale
is anInteger
return its integer value, otherwise return 0.Returns an array of all thePropertyChangeListener
s added to this UIDefaults with addPropertyChangeListener().If the value ofkey
is aString
return it, otherwise returnnull
.If the value ofkey
for the givenLocale
is aString
return it, otherwise returnnull
.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
.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
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
Sets the default locale.Methods inherited from class java.util.Hashtable
clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, getOrDefault, hashCode, isEmpty, keys, keySet, merge, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, size, toString, values
-
Constructor Details
-
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:
-
UIDefaults
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 Details
-
get
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. -
get
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:
-
put
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
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:
-
getFont
-
getFont
-
getColor
-
getColor
-
getIcon
-
getIcon
-
getBorder
-
getBorder
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
-
getString
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
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
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
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
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
-
getInsets
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
-
getDimension
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
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:
-
getUIClass
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
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
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
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:
-
removePropertyChangeListener
Removes aPropertyChangeListener
from the listener list. This removes aPropertyChangeListener
that was registered for all properties.- Parameters:
listener
- thePropertyChangeListener
to be removed- See Also:
-
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
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:
-
addResourceBundle
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:
-
removeResourceBundle
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:
-
setDefaultLocale
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
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:
-