A PropertyEditor class provides support for GUIs that want to
allow users to edit a property value of a given type.
PropertyEditor supports a variety of different kinds of ways of
displaying and updating property values. Most PropertyEditors will
only need to support a subset of the different options available in
Simple PropertyEditors may only support the getAsText and setAsText
methods and need not support (say) paintValue or getCustomEditor. More
complex types may be unable to support getAsText and setAsText but will
instead support paintValue and getCustomEditor.
Every propertyEditor must support one or more of the three simple
display styles. Thus it can either (1) support isPaintable or (2)
both return a non-null String from getTags() and return a non-null
value from getAsText or (3) simply return a non-null String from
Every property editor must support a call on setValue when the argument
object is of the type for which this is the corresponding propertyEditor.
In addition, each property editor must either support a custom editor,
or support setAsText.
Each PropertyEditor should have a null constructor.
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.
The given Graphics object will have the default font, color, etc of
the parent container. The PropertyEditor may change graphics attributes
such as font and color and doesn't need to restore the old values.
gfx - Graphics object to paint into.
box - Rectangle within graphics object into which we should paint.
public abstract String getJavaInitializationString()
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
Example results are "2", "new Color(127,127,34)", "Color.orange", etc.
A fragment of Java code representing an initializer for the
If the property value must be one of a set of known tagged values,
then this method should return an array of the tags. 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 and the use of getAsText
to identify the current value.
The tag values for this property. May be null if this
property cannot be represented as a tagged value.
A PropertyEditor may choose 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 ...
A java.awt.Component that will allow a human to directly
edit the current property value. May be null if this is
Register a listener for the PropertyChange event. When a
PropertyEditor changes its value it should fire a PropertyChange
event on all registered PropertyChangeListeners, specifying the
null value for the property name and itself as the source.
listener - An object to be invoked when a PropertyChange
event is fired.
Submit a bug or feature - Version 1.1.8 of Java Platform API Specification
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1995-1999 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.