APIdia Launch Partner
Top Description Fields Constructors Methods
java.beans

public Class PropertyEditorSupport

extends Object
implements PropertyEditor
Class Inheritance
All Implemented Interfaces
java.beans.PropertyEditor
Known Direct Subclasses
com.sun.beans.editors.BooleanEditor, com.sun.beans.editors.NumberEditor, com.sun.beans.editors.StringEditor
Imports
java.util.ArrayList

This is a support class to help build property editors.

It can be used either as a base class or as a delegate.

Since
1.1

Field Summary

Modifier and TypeField and Description
private ArrayList<PropertyChangeListener>
private Object
private Object

Constructor Summary

AccessConstructor and Description
public
PropertyEditorSupport()

Constructs a PropertyEditorSupport object.

public
PropertyEditorSupport(Object
the source used for event firing
source
)

Constructs a PropertyEditorSupport object.

Method Summary

Modifier and TypeMethod and Description
public synchronized void
public void
firePropertyChange()

Report that we have been modified to any interested listeners.

public String

Returns:

The property value as a string suitable for presentation to a human to edit.

Returns null if 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().

getAsText
()

Implements java.beans.PropertyEditor.getAsText.

Gets the property value as a string suitable for presentation to a human to edit.

public Component

Returns:

A java.awt.Component that will allow a human to directly edit the current property value. May be null if this is not supported.
getCustomEditor
()

Implements java.beans.PropertyEditor.getCustomEditor.

A PropertyEditor may chose to make available a full custom Component that edits its property value.

public String

Returns:

A fragment of Java code representing an initializer for the current value.
getJavaInitializationString
()

Implements java.beans.PropertyEditor.getJavaInitializationString.

This method is intended for use when generating Java code to set the value of the property.

public Object

Returns:

the source object or this instance
getSource
()

Returns the bean that is used as the source of events.

public String[]

Returns:

The tag values for this property. May be null if this property cannot be represented as a tagged value.
getTags
()

Implements java.beans.PropertyEditor.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.

public Object

Returns:

The value of the property.
getValue
()

Implements java.beans.PropertyEditor.getValue.

Gets the value of the property.

public boolean

Returns:

True if the class will honor the paintValue method.
isPaintable
()

Implements java.beans.PropertyEditor.isPaintable.

Determines whether the class will honor the paintValue method.

public void
paintValue(Graphics
Graphics object to paint into.
gfx
,
Rectangle
Rectangle within graphics object into which we should paint.
box
)

Implements java.beans.PropertyEditor.paintValue.

Paint a representation of the value into a given area of screen real estate.

public synchronized void
public void
setAsText(String
The string to be parsed.
text
)

Implements java.beans.PropertyEditor.setAsText.

Sets the property value by parsing a given String.

public void
setSource(Object
source object to be used for events
source
)

Sets the source bean.

public void
setValue(Object
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.
value
)

Implements java.beans.PropertyEditor.setValue.

Set (or change) the object that is to be edited.

public boolean

Returns:

True if the propertyEditor can provide a custom editor.
supportsCustomEditor
()

Implements java.beans.PropertyEditor.supportsCustomEditor.

Determines whether the propertyEditor can provide a custom editor.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

listenersback to summary
private ArrayList<PropertyChangeListener> listeners
sourceback to summary
private Object source
valueback to summary
private Object value

Constructor Detail

PropertyEditorSupportback to summary
public PropertyEditorSupport()

Constructs a PropertyEditorSupport object.

Since
1.5
PropertyEditorSupportback to summary
public PropertyEditorSupport(Object source)

Constructs a PropertyEditorSupport object.

Parameters
source:Object

the source used for event firing

Since
1.5

Method Detail

addPropertyChangeListenerback to summary
public synchronized void addPropertyChangeListener(PropertyChangeListener listener)

Implements java.beans.PropertyEditor.addPropertyChangeListener.

Adds a listener for the value change. When the property editor changes its value it should fire a PropertyChangeEvent on all registered PropertyChangeListeners, specifying the null value for the property name. If the source property is set, it should be used as the source of the event.

The same listener object may be added more than once, and will be called as many times as it is added. If listener is null, no exception is thrown and no action is taken.

Parameters
listener:PropertyChangeListener

the PropertyChangeListener to add

Annotations
@Override
firePropertyChangeback to summary
public void firePropertyChange()

Report that we have been modified to any interested listeners.

getAsTextback to summary
public String getAsText()

Implements java.beans.PropertyEditor.getAsText.

Gets the property value as a string suitable for presentation to a human to edit.

Returns:String

The property value as a string suitable for presentation to a human to edit.

Returns null if 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().

Annotations
@Override
getCustomEditorback to summary
public Component getCustomEditor()

Implements java.beans.PropertyEditor.getCustomEditor.

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 ...

Returns:Component

A java.awt.Component that will allow a human to directly edit the current property value. May be null if this is not supported.

Annotations
@Override
getJavaInitializationStringback to summary
public String getJavaInitializationString()

Implements java.beans.PropertyEditor.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 value.

Example results are "2", "new Color(127,127,34)", "Color.orange", etc.

Returns:String

A fragment of Java code representing an initializer for the current value.

Annotations
@Override
getSourceback to summary
public Object getSource()

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.

Returns:Object

the source object or this instance

Since
1.5
getTagsback to summary
public String[] getTags()

Implements java.beans.PropertyEditor.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. 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.

Returns:String[]

The tag values for this property. May be null if this property cannot be represented as a tagged value.

Annotations
@Override
getValueback to summary
public Object getValue()

Implements java.beans.PropertyEditor.getValue.

Gets the value of the property.

Returns:Object

The value of the property.

Annotations
@Override
isPaintableback to summary
public boolean isPaintable()

Implements java.beans.PropertyEditor.isPaintable.

Determines whether the class will honor the paintValue method.

Returns:boolean

True if the class will honor the paintValue method.

Annotations
@Override
paintValueback to summary
public void paintValue(Graphics gfx, Rectangle box)

Implements java.beans.PropertyEditor.paintValue.

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.

Parameters
gfx:Graphics

Graphics object to paint into.

box:Rectangle

Rectangle within graphics object into which we should paint.

Annotations
@Override
removePropertyChangeListenerback to summary
public synchronized void removePropertyChangeListener(PropertyChangeListener listener)

Implements java.beans.PropertyEditor.removePropertyChangeListener.

Removes a listener for the value change.

If the same listener was added more than once, it will be notified one less time after being removed. If listener is null, or was never added, no exception is thrown and no action is taken.

Parameters
listener:PropertyChangeListener

the PropertyChangeListener to remove

Annotations
@Override
setAsTextback to summary
public void setAsText(String text) throws IllegalArgumentException

Implements java.beans.PropertyEditor.setAsText.

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.

Parameters
text:String

The string to be parsed.

Annotations
@Override
setSourceback to summary
public void setSource(Object source)

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.

Parameters
source:Object

source object to be used for events

Since
1.5
setValueback to summary
public void setValue(Object value)

Implements java.beans.PropertyEditor.setValue.

Set (or change) the object that is to be edited.

Parameters
value:Object

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.

Annotations
@Override
supportsCustomEditorback to summary
public boolean supportsCustomEditor()

Implements java.beans.PropertyEditor.supportsCustomEditor.

Determines whether the propertyEditor can provide a custom editor.

Returns:boolean

True if the propertyEditor can provide a custom editor.

Annotations
@Override