java.lang.Object | |
↳ | java.beans.PropertyEditorSupport |
Known Direct Subclasses |
Known Indirect Subclasses |
This is a support class to help build property editors.
It can be used either as a base class or as a delagatee.
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructs a
PropertyEditorSupport object. | |||||||||||
Constructs a
PropertyEditorSupport object. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Register a listener for the PropertyChange event.
| |||||||||||
Report that we have been modified to any interested listeners.
| |||||||||||
Gets the property value as a string suitable for presentation
to a human to edit.
| |||||||||||
A PropertyEditor may chose to make available a full custom Component
that edits its property value.
| |||||||||||
This method is intended for use when generating Java code to set
the value of the property.
| |||||||||||
Returns the bean that is used as the
source of events.
| |||||||||||
If the property value must be one of a set of known tagged values,
then this method should return an array of the tag values.
| |||||||||||
Gets the value of the property.
| |||||||||||
Determines whether the class will honor the paintValue method.
| |||||||||||
Paint a representation of the value into a given area of screen
real estate.
| |||||||||||
Remove a listener for the PropertyChange event.
| |||||||||||
Sets the property value by parsing a given String.
| |||||||||||
Sets the source bean.
| |||||||||||
Set (or change) the object that is to be edited.
| |||||||||||
Determines whether the propertyEditor can provide a custom editor.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
java.beans.PropertyEditor
|
Constructs a PropertyEditorSupport
object.
Constructs a PropertyEditorSupport
object.
source | the source used for event firing |
---|
Register a listener for the PropertyChange event. The class will fire a PropertyChange value whenever the value is updated.
listener | An object to be invoked when a PropertyChange event is fired. |
---|
Report that we have been modified to any interested listeners.
Gets the property value as a string suitable for presentation to a human to edit.
Returns "null" is the value can't be expressed as a string.
If a non-null value is returned, then the PropertyEditor should be prepared to parse that string back in setAsText().
A PropertyEditor may chose to make available a full custom Component that edits its property value. It is the responsibility of the PropertyEditor to hook itself up to its editor Component itself and to report property value changes by firing a PropertyChange event.
The higher-level code that calls getCustomEditor may either embed the Component in some larger property sheet, or it may put it in its own individual dialog, or ...
This method is intended for use when generating Java code to set the value of the property. It should return a fragment of Java code that can be used to initialize a variable with the current property value.
Example results are "2", "new Color(127,127,34)", "Color.orange", etc.
Returns the bean that is used as the
source of events. If the source has not
been explicitly set then this instance of
PropertyEditorSupport
is returned.
If the property value must be one of a set of known tagged values, then this method should return an array of the tag values. This can be used to represent (for example) enum values. If a PropertyEditor supports tags, then it should support the use of setAsText with a tag value as a way of setting the value.
Determines whether the class will honor the paintValue method.
Paint a representation of the value into a given area of screen real estate. Note that the propertyEditor is responsible for doing its own clipping so that it fits into the given rectangle.
If the PropertyEditor doesn't honor paint requests (see isPaintable) this method should be a silent noop.
gfx | Graphics object to paint into. |
---|---|
box | Rectangle within graphics object into which we should paint. |
Remove a listener for the PropertyChange event.
listener | The PropertyChange listener to be removed. |
---|
Sets the property value by parsing a given String. May raise java.lang.IllegalArgumentException if either the String is badly formatted or if this kind of property can't be expressed as text.
text | The string to be parsed. |
---|
IllegalArgumentException |
---|
Sets the source bean.
The source bean is used as the source of events for the property changes. This source should be used for information purposes only and should not be modified by the PropertyEditor.
source | source object to be used for events |
---|
Set (or change) the object that is to be edited.
value | The new target object to be edited. Note that this object should not be modified by the PropertyEditor, rather the PropertyEditor should create a new object to hold any modified value. |
---|
Determines whether the propertyEditor can provide a custom editor.