|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PropertyDescriptor
A base interface for describing a property, or a group of properties.
Method Summary | |
---|---|
void |
addPropertyChangeListener(PropertyChangeListener listener)
Registers a to this property. |
Object |
clone()
Tool environments may need to make copies of properties for logical, performance, or caching, needs. |
String |
getDescription()
Returns the description of this property. |
String |
getDisplayName()
Returns the display name to be used by tool environments to display the property. |
String |
getID()
Returns a unique ID that has been assigned to the property descriptor. |
String |
getName()
Returns the name of this property. |
boolean |
isEnabled()
Returns if this property is enabled or disabled. |
void |
removePropertyChangeListener(PropertyChangeListener listener)
Removes a PropertyChangeListener from this property. |
Method Detail |
---|
String getDescription()
This is a locale specific object that must be separated to a ResourceBundle, translated, and retrieved using the locale of the tool environment.
null
String description.ResourceBundle
,
MessageFormat
String getName()
null
String name. The name chosen for a
property is implementation specific. The only requirement is that
property names must be unique within a given PropertyGroup to
avoid name collisions.PropertyGroup
String getDisplayName()
This is a locale specific object that must be separated to a ResourceBundle, translated, and retrieved using the locale of the tool environment.
null
string name.ResourceBundle
,
MessageFormat
void addPropertyChangeListener(PropertyChangeListener listener)
PropertyChangeListener
to this property.
The registered listener will be notified of any changes to the property
instance. Tool environment user interfaces should use this mechanism to
respond to property change behaviour.
listener
- a non null
lister that wishes to be notified of
property change events.void removePropertyChangeListener(PropertyChangeListener listener)
PropertyChangeListener
from this property.
listener
- listener a non null
lister that wishes removed
from the notification list.addPropertyChangeListener(PropertyChangeListener)
boolean isEnabled()
Object clone()
Cloneable
interface. Implementors of the clone
method must ensure that a deep copy is performed where necessary. For
example, if a property group has many properties that listen to each
other for changes, then it is insufficient to simply clone the property
values. The cloned property group must also clone the listening behavior
among the properties as well.
null
clone of this Object.String getID()
null
if no id exists.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |