Contents | Package | Class | Tree | Deprecated | Index | Help | Java 1.2 Beta 3 | ||
PREV | NEXT | SHOW LISTS | HIDE LISTS |
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 this API.
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 getAsText().
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.
Method Summary | |
void | addPropertyChangeListener(PropertyChangeListener listener)
|
String | getAsText()
|
Component | getCustomEditor()
|
String | getJavaInitializationString()
|
String[] | getTags()
|
Object | getValue()
|
boolean | isPaintable()
|
void | paintValue(Graphics gfx,
Rectangle box)
|
void | removePropertyChangeListener(PropertyChangeListener listener)
|
void | setAsText(String text)
|
void | setValue(Object value)
|
boolean | supportsCustomEditor()
|
Method Detail |
public void setValue(Object value)
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.
public Object getValue()
public boolean isPaintable()
public void paintValue(Graphics gfx, Rectangle box)
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 String getJavaInitializationString()
Example results are "2", "new Color(127,127,34)", "Color.orange", etc.
public String getAsText()
Returns null if the value can't be expressed as an editable string.
If a non-null value is returned, then the PropertyEditor should be prepared to parse that string back in setAsText().
public void setAsText(String text) throws IllegalArgumentException
text
- The string to be parsed.
public String[] getTags()
public Component getCustomEditor()
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 ...
public boolean supportsCustomEditor()
public void addPropertyChangeListener(PropertyChangeListener listener)
listener
- An object to be invoked when a PropertyChange
event is fired.
public void removePropertyChangeListener(PropertyChangeListener listener)
listener
- The PropertyChange listener to be removed.
Contents | Package | Class | Tree | Deprecated | Index | Help | Java 1.2 Beta 3 | ||
PREV | NEXT | SHOW LISTS | HIDE LISTS |