|
Java™ Platform Standard Ed. 6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjava.beans.PropertyEditorSupport
public class PropertyEditorSupport
This is a support class to help build property editors.
It can be used either as a base class or as a delagatee.
| Constructor Summary | |
|---|---|
PropertyEditorSupport()
Constructs a PropertyEditorSupport object. |
|
PropertyEditorSupport(Object source)
Constructs a PropertyEditorSupport object. |
|
| Method Summary | |
|---|---|
void |
addPropertyChangeListener(PropertyChangeListener listener)
Register a listener for the PropertyChange event. |
void |
firePropertyChange()
Report that we have been modified to any interested listeners. |
String |
getAsText()
Gets the property value as a string suitable for presentation to a human to edit. |
Component |
getCustomEditor()
A PropertyEditor may chose to make available a full custom Component that edits its property value. |
String |
getJavaInitializationString()
This method is intended for use when generating Java code to set the value of the property. |
Object |
getSource()
Returns the bean that is used as the source of events. |
String[] |
getTags()
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. |
Object |
getValue()
Gets the value of the property. |
boolean |
isPaintable()
Determines whether the class will honor the paintValue method. |
void |
paintValue(Graphics gfx,
Rectangle box)
Paint a representation of the value into a given area of screen real estate. |
void |
removePropertyChangeListener(PropertyChangeListener listener)
Remove a listener for the PropertyChange event. |
void |
setAsText(String text)
Sets the property value by parsing a given String. |
void |
setSource(Object source)
Sets the source bean. |
void |
setValue(Object value)
Set (or change) the object that is to be edited. |
boolean |
supportsCustomEditor()
Determines whether the propertyEditor can provide a custom editor. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public PropertyEditorSupport()
PropertyEditorSupport object.
public PropertyEditorSupport(Object source)
PropertyEditorSupport object.
source - the source used for event firing| Method Detail |
|---|
public Object getSource()
PropertyEditorSupport is returned.
public void setSource(Object source)
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 eventspublic void setValue(Object value)
setValue in interface PropertyEditorvalue - 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()
getValue in interface PropertyEditorpublic boolean isPaintable()
isPaintable in interface PropertyEditor
public void paintValue(Graphics gfx,
Rectangle box)
If the PropertyEditor doesn't honor paint requests (see isPaintable) this method should be a silent noop.
paintValue in interface PropertyEditorgfx - 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.
getJavaInitializationString in interface PropertyEditorpublic String getAsText()
getAsText in interface PropertyEditorReturns "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().
public void setAsText(String text)
throws IllegalArgumentException
setAsText in interface PropertyEditortext - The string to be parsed.
IllegalArgumentExceptionpublic String[] getTags()
getTags in interface PropertyEditorpublic 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 ...
getCustomEditor in interface PropertyEditorpublic boolean supportsCustomEditor()
supportsCustomEditor in interface PropertyEditorpublic void addPropertyChangeListener(PropertyChangeListener listener)
addPropertyChangeListener in interface PropertyEditorlistener - An object to be invoked when a PropertyChange
event is fired.public void removePropertyChangeListener(PropertyChangeListener listener)
removePropertyChangeListener in interface PropertyEditorlistener - The PropertyChange listener to be removed.public void firePropertyChange()
|
Java™ Platform Standard Ed. 6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.