Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

java.beans

Class PropertyEditorSupport

Implemented Interfaces:
PropertyEditor
Known Direct Subclasses:
ColorEditor, FontEditor, NativeBooleanEditor, NativeByteEditor, NativeDoubleEditor, NativeFloatEditor, NativeIntEditor, NativeLongEditor, NativeShortEditor, StringEditor
public class PropertyEditorSupport
extends Object
implements PropertyEditor
PropertyEditorSupport helps with PropertyEditors, implementing base functionality that they usually must have but which is a pain to implement. You may extend from this class or use it as a standalone.

This class does not do any painting or actual editing. For that, you must use or extend it. See the PropertyEditor class for better descriptions of what the various methods do.

Since:
1.1

Constructor Summary

PropertyEditorSupport()
Call this constructor when you are deriving from PropertyEditorSupport.
PropertyEditorSupport(Object source)
Call this constructor when you are using PropertyEditorSupport as a helper object.

Method Summary

void
addPropertyChangeListener(PropertyChangeListener l)
Adds a property change listener to this property editor.
void
firePropertyChange()
Notifies people that we've changed, although we don't tell them just how.
String
getAsText()
Gets the value as text.
Component
getCustomEditor()
Returns a custom component to edit the value.
String
getJavaInitializationString()
Gets the Java initialization String for the current value of the Object.
Object
getSource()
Returns the bean that is used as the source of events.
String[]
getTags()
Returns a list of possible choices for the value.
Object
getValue()
Gets the current value of the property.
boolean
isPaintable()
Gets whether this object is paintable or not.
void
paintValue(Graphics g, Rectangle r)
Paints this object.
void
removePropertyChangeListener(PropertyChangeListener l)
Removes a property change listener from this property editor.
void
setAsText(String s)
Sets the value as text.
void
setSource(Object source)
Sets the bean that is used as the source of events when property changes occur.
void
setValue(Object newValue)
Sets the current value of the property and a property change event is fired to all registered PropertyChangeListener instances.
boolean
supportsCustomEditor()
Finds out whether this property editor supports a custom component to edit its value.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PropertyEditorSupport

public PropertyEditorSupport()
Call this constructor when you are deriving from PropertyEditorSupport. Using this constructor the event source is this PropertyEditorSupport instance itself.
Since:
1.5

PropertyEditorSupport

public PropertyEditorSupport(Object source)
Call this constructor when you are using PropertyEditorSupport as a helper object. This constructor throws a NullPointerException when source is null, for compatibility reasons with J2SDK 1.5.0 .
Parameters:
source - The source to use when firing property change events.
Since:
1.5

Method Details

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)
Adds a property change listener to this property editor.
Specified by:
addPropertyChangeListener in interface PropertyEditor
Parameters:
l - the listener to add.

firePropertyChange

public void firePropertyChange()
Notifies people that we've changed, although we don't tell them just how.

getAsText

public String getAsText()
Gets the value as text. In this class, you cannot count on getAsText() doing anything useful, although in this implementation I do toString().
Specified by:
getAsText in interface PropertyEditor
Returns:
the value as text.

getCustomEditor

public Component getCustomEditor()
Returns a custom component to edit the value.
Specified by:
getCustomEditor in interface PropertyEditor
Returns:
null in this class.

getJavaInitializationString

public String getJavaInitializationString()
Gets the Java initialization String for the current value of the Object. This class returns gibberish or null (though the spec does not say which).

Implementation Note: This class returns the string "@$#^" to make sure the code will be broken, so that you will know to override it when you create your own property editor.

Specified by:
getJavaInitializationString in interface PropertyEditor
Returns:
the Java initialization string.

getSource

public Object getSource()
Returns the bean that is used as the source of events.
Returns:
The event source object
Since:
1.5

getTags

public String[] getTags()
Returns a list of possible choices for the value.
Specified by:
getTags in interface PropertyEditor
Returns:
null

getValue

public Object getValue()
Gets the current value of the property.
Specified by:
getValue in interface PropertyEditor
Returns:
the current value of the property.

isPaintable

public boolean isPaintable()
Gets whether this object is paintable or not.
Specified by:
isPaintable in interface PropertyEditor
Returns:
false

paintValue

public void paintValue(Graphics g,
                       Rectangle r)
Paints this object. This class does nothing in this method.
Specified by:
paintValue in interface PropertyEditor

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)
Removes a property change listener from this property editor.
Specified by:
removePropertyChangeListener in interface PropertyEditor
Parameters:
l - the listener to remove.

setAsText

public void setAsText(String s)
            throws IllegalArgumentException
Sets the value as text. In this class, you cannot count on setAsText() doing anything useful across implementations. Implementation Note: In this implementation it checks if the String is "null", and if it is, sets the value to null, otherwise it throws an IllegalArgumentException.
Specified by:
setAsText in interface PropertyEditor
Parameters:
s - the text to convert to a new value.
Throws:
IllegalArgumentException - if the text is malformed.

setSource

public void setSource(Object source)
Sets the bean that is used as the source of events when property changes occur. The event source bean is for informational purposes only and should not be changed by the PropertyEditor.
Parameters:
source -
Since:
1.5

setValue

public void setValue(Object newValue)
Sets the current value of the property and a property change event is fired to all registered PropertyChangeListener instances.
Specified by:
setValue in interface PropertyEditor
Parameters:
newValue - The new value for the property.

supportsCustomEditor

public boolean supportsCustomEditor()
Finds out whether this property editor supports a custom component to edit its value.
Specified by:
supportsCustomEditor in interface PropertyEditor
Returns:
false in this class.
java.beans.PropertyEditorSupport Copyright (C) 1998, 2004 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About