Fixes documentation and indentation
2004-11-06 Robert Schuster <thebohemian@gmx.net> Fixes documentation and indentation * java/beans/PropertyEditorSupport.java: reworked initial API doc (value): changed name from val 2004-11-06 Robert Schuster <thebohemian@gmx.net> Updates to 1.5 * java/beans/PropertyEditorSupport.java (PropertyEditorSupport()): Changed modifier to public (PropertyEditorSupport(Object): Changed modifier to public (setSource): New method (getSource): New method 2004-11-06 Robert Schuster <thebohemian@gmx.net> Fixes bug #10799 * java/beans/PropertyEditorSupport.java (setValue): Fire property change event From-SVN: r90170
This commit is contained in:
parent
c1df75d1a2
commit
6ea123cec7
@ -1,3 +1,25 @@
|
||||
2004-11-06 Robert Schuster <thebohemian@gmx.net>
|
||||
|
||||
Fixes documentation and indentation
|
||||
* java/beans/PropertyEditorSupport.java:
|
||||
reworked initial API doc
|
||||
(value): changed name from val
|
||||
|
||||
2004-11-06 Robert Schuster <thebohemian@gmx.net>
|
||||
|
||||
Updates to 1.5
|
||||
* java/beans/PropertyEditorSupport.java
|
||||
(PropertyEditorSupport()): Changed modifier to public
|
||||
(PropertyEditorSupport(Object): Changed modifier to public
|
||||
(setSource): New method
|
||||
(getSource): New method
|
||||
|
||||
2004-11-06 Robert Schuster <thebohemian@gmx.net>
|
||||
|
||||
Fixes bug #10799
|
||||
* java/beans/PropertyEditorSupport.java
|
||||
(setValue): Fire property change event
|
||||
|
||||
2004-11-03 Tom Tromey <tromey@redhat.com>
|
||||
|
||||
* jni.cc (_Jv_JNI_NewObjectArray): Fixed return type.
|
||||
|
@ -1,5 +1,5 @@
|
||||
/* java.beans.PropertyEditorSupport
|
||||
Copyright (C) 1998 Free Software Foundation, Inc.
|
||||
Copyright (C) 1998, 2004 Free Software Foundation, Inc.
|
||||
|
||||
This file is part of GNU Classpath.
|
||||
|
||||
@ -7,7 +7,7 @@ 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
|
||||
@ -38,169 +38,228 @@ exception statement from your version. */
|
||||
|
||||
package java.beans;
|
||||
|
||||
|
||||
/**
|
||||
** 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.<P>
|
||||
**
|
||||
** 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.
|
||||
**
|
||||
** @author John Keiser
|
||||
** @since JDK1.1
|
||||
** @version 1.1.0, 29 Jul 1998
|
||||
**/
|
||||
* 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.<P>
|
||||
*
|
||||
* 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.
|
||||
*
|
||||
* @author John Keiser
|
||||
* @author Robert Schuster
|
||||
* @since 1.1
|
||||
* @status updated to 1.5
|
||||
*/
|
||||
public class PropertyEditorSupport implements PropertyEditor
|
||||
{
|
||||
Object eventSource;
|
||||
Object value;
|
||||
PropertyChangeSupport pSupport;
|
||||
|
||||
public class PropertyEditorSupport implements PropertyEditor {
|
||||
Object eventSource;
|
||||
Object val;
|
||||
PropertyChangeSupport pSupport;
|
||||
/** Call this constructor when you are deriving from
|
||||
* PropertyEditorSupport.
|
||||
*
|
||||
* Using this constructor the event source is this PropertyEditorSupport
|
||||
* instance itself.
|
||||
*
|
||||
* @since 1.5
|
||||
* @status this was <code>protected</code> prior to 1.5
|
||||
*/
|
||||
public PropertyEditorSupport()
|
||||
{
|
||||
eventSource = this;
|
||||
pSupport = new PropertyChangeSupport(this);
|
||||
}
|
||||
|
||||
/** Call this constructor when you are deriving from
|
||||
** PropertyEditorSupport.
|
||||
**/
|
||||
protected PropertyEditorSupport() {
|
||||
this.eventSource = this;
|
||||
this.pSupport = new PropertyChangeSupport(this);
|
||||
}
|
||||
/** Call this constructor when you are using
|
||||
* PropertyEditorSupport as a helper object.
|
||||
*
|
||||
* This constructor throws a NullPointerException when <code>source</code> is <code>null</code>,
|
||||
* for compatibility reasons with J2SDK 1.5.0 .
|
||||
*
|
||||
* @param source The source to use when firing
|
||||
* property change events.
|
||||
* @since 1.5
|
||||
* @status this was <code>protected</code> prior to 1.5
|
||||
*/
|
||||
public PropertyEditorSupport(Object source)
|
||||
{
|
||||
// note: constructor rejects source being null for the sake of compatibility
|
||||
// with official 1.5.0 implementation
|
||||
if (source == null)
|
||||
throw new NullPointerException("Event source must not be null.");
|
||||
|
||||
/** Call this constructor when you are using
|
||||
** PropertyEditorSupport as a helper object.
|
||||
** @param eventSource the source to use when firing
|
||||
** property change events.
|
||||
**/
|
||||
protected PropertyEditorSupport(Object eventSource) {
|
||||
this.eventSource = eventSource;
|
||||
this.pSupport = new PropertyChangeSupport(this);
|
||||
}
|
||||
eventSource = source;
|
||||
pSupport = new PropertyChangeSupport(eventSource);
|
||||
}
|
||||
|
||||
/** Set the current value of the property.
|
||||
** <STRONG>Implementation Note</STRONG> Sun does not
|
||||
** state what exactly this version of the method does.
|
||||
** Thus, in this implementation, it sets the value, and
|
||||
** then if the old and new values are different, it
|
||||
** fires a property change event with no property name
|
||||
** and the old and new values.
|
||||
** @param val the new value for the property.
|
||||
**/
|
||||
public void setValue(Object val) {
|
||||
Object oldVal = val;
|
||||
this.val = val;
|
||||
if(!oldVal.equals(val)) {
|
||||
pSupport.firePropertyChange(null,oldVal,val);
|
||||
}
|
||||
}
|
||||
/** Sets the current value of the property and a property change
|
||||
* event is fired to all registered PropertyChangeListener instances.
|
||||
*
|
||||
* @param newValue The new value for the property.
|
||||
*/
|
||||
public void setValue(Object newValue)
|
||||
{
|
||||
value = newValue;
|
||||
|
||||
/** Get the current value of the property.
|
||||
** @return the current value of the property.
|
||||
**/
|
||||
public Object getValue() {
|
||||
return val;
|
||||
}
|
||||
// specification in java.beans.PropertyChangeEvent says
|
||||
// that without a property name (first argument) the
|
||||
// new and the old value should always be null
|
||||
pSupport.firePropertyChange(null, null, null);
|
||||
}
|
||||
|
||||
/** Get whether this object is paintable or not.
|
||||
** @return <CODE>false</CODE>
|
||||
**/
|
||||
public boolean isPaintable() {
|
||||
return false;
|
||||
}
|
||||
/** Gets the current value of the property.
|
||||
*
|
||||
* @return the current value of the property.
|
||||
*/
|
||||
public Object getValue()
|
||||
{
|
||||
return value;
|
||||
}
|
||||
|
||||
/** Paint this object. This class does nothing in
|
||||
** this method.
|
||||
**/
|
||||
public void paintValue(java.awt.Graphics g, java.awt.Rectangle r) {
|
||||
}
|
||||
/** Gets whether this object is paintable or not.
|
||||
*
|
||||
* @return <CODE>false</CODE>
|
||||
*/
|
||||
public boolean isPaintable()
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
/** Get the Java initialization String for the current
|
||||
** value of the Object. This class returns gibberish or
|
||||
** null (though the spec does not say which).<P>
|
||||
** <STRONG>Implementation Note:</STRONG> 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.
|
||||
** @return the Java initialization string.
|
||||
**/
|
||||
public String getJavaInitializationString() {
|
||||
return "@$#^";
|
||||
}
|
||||
/** Paints this object. This class does nothing in
|
||||
* this method.
|
||||
*/
|
||||
public void paintValue(java.awt.Graphics g, java.awt.Rectangle r)
|
||||
{
|
||||
}
|
||||
|
||||
/** Get the value as text.
|
||||
** In this class, you cannot count on getAsText() doing
|
||||
** anything useful, although in this implementation I
|
||||
** do toString().
|
||||
** @return the value as text.
|
||||
**/
|
||||
public String getAsText() {
|
||||
return val != null ? val.toString() : "null";
|
||||
}
|
||||
/** 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).<P>
|
||||
* <STRONG>Implementation Note:</STRONG> 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.
|
||||
*
|
||||
* @return the Java initialization string.
|
||||
*/
|
||||
public String getJavaInitializationString()
|
||||
{
|
||||
return "@$#^";
|
||||
}
|
||||
|
||||
/** Set the value as text.
|
||||
** In this class, you cannot count on setAsText() doing
|
||||
** anything useful across implementations.
|
||||
** <STRONG>Implementation Note:</STRONG> In this
|
||||
** implementation it checks if the String is "null", and
|
||||
** if it is, sets the value to null, otherwise it throws
|
||||
** an IllegalArgumentException.
|
||||
** @param s the text to convert to a new value.
|
||||
** @exception IllegalArgumentException if the text is
|
||||
** malformed.
|
||||
**/
|
||||
public void setAsText(String s) throws IllegalArgumentException {
|
||||
if(s.equals("null")) {
|
||||
setValue(null);
|
||||
} else {
|
||||
throw new IllegalArgumentException();
|
||||
}
|
||||
}
|
||||
/** Gets the value as text.
|
||||
* In this class, you cannot count on getAsText() doing
|
||||
* anything useful, although in this implementation I
|
||||
* do toString().
|
||||
*
|
||||
* @return the value as text.
|
||||
*/
|
||||
public String getAsText()
|
||||
{
|
||||
return value != null ? value.toString() : "null";
|
||||
}
|
||||
|
||||
/** Returns a list of possible choices for the value.
|
||||
** @return <CODE>null</CODE>
|
||||
**/
|
||||
public String[] getTags() {
|
||||
return null;
|
||||
}
|
||||
/** Sets the value as text.
|
||||
* In this class, you cannot count on setAsText() doing
|
||||
* anything useful across implementations.
|
||||
* <STRONG>Implementation Note:</STRONG> In this
|
||||
* implementation it checks if the String is "null", and
|
||||
* if it is, sets the value to null, otherwise it throws
|
||||
* an IllegalArgumentException.
|
||||
*
|
||||
* @param s the text to convert to a new value.
|
||||
* @exception IllegalArgumentException if the text is
|
||||
* malformed.
|
||||
*/
|
||||
public void setAsText(String s) throws IllegalArgumentException
|
||||
{
|
||||
if (s.equals("null"))
|
||||
setValue(null);
|
||||
else
|
||||
throw new IllegalArgumentException();
|
||||
}
|
||||
|
||||
/** Return a custom component to edit the value.
|
||||
** @return <CODE>null</CODE> in this class.
|
||||
**/
|
||||
public java.awt.Component getCustomEditor() {
|
||||
return null;
|
||||
}
|
||||
/** Returns a list of possible choices for the value.
|
||||
*
|
||||
* @return <CODE>null</CODE>
|
||||
*/
|
||||
public String[] getTags()
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
/** Find out whether this property editor supports a
|
||||
** custom component to edit its value.
|
||||
** @return <CODE>false</CODE> in this class.
|
||||
**/
|
||||
public boolean supportsCustomEditor() {
|
||||
return false;
|
||||
}
|
||||
/** Returns a custom component to edit the value.
|
||||
*
|
||||
* @return <CODE>null</CODE> in this class.
|
||||
*/
|
||||
public java.awt.Component getCustomEditor()
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
/** Add a property change listener to this property editor.
|
||||
** @param l the listener to add.
|
||||
**/
|
||||
public void addPropertyChangeListener(PropertyChangeListener l) {
|
||||
pSupport.addPropertyChangeListener(l);
|
||||
}
|
||||
/** Finds out whether this property editor supports a
|
||||
* custom component to edit its value.
|
||||
*
|
||||
* @return <CODE>false</CODE> in this class.
|
||||
*/
|
||||
public boolean supportsCustomEditor()
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
/** Remove a property change listener from this property editor.
|
||||
** @param l the listener to remove.
|
||||
**/
|
||||
public void removePropertyChangeListener(PropertyChangeListener l) {
|
||||
pSupport.removePropertyChangeListener(l);
|
||||
}
|
||||
/** Adds a property change listener to this property editor.
|
||||
*
|
||||
* @param l the listener to add.
|
||||
*/
|
||||
public void addPropertyChangeListener(PropertyChangeListener l)
|
||||
{
|
||||
pSupport.addPropertyChangeListener(l);
|
||||
}
|
||||
|
||||
/** Removes a property change listener from this property editor.
|
||||
*
|
||||
* @param l the listener to remove.
|
||||
*/
|
||||
public void removePropertyChangeListener(PropertyChangeListener l)
|
||||
{
|
||||
pSupport.removePropertyChangeListener(l);
|
||||
}
|
||||
|
||||
/** Notify people that we've changed, although we don't
|
||||
** tell them just how. The only thing I can think of to
|
||||
** send in the event is the new value (since the old value
|
||||
** is unavailable and there is no property name).
|
||||
** I confess I do not understand the point of this method.
|
||||
**/
|
||||
public void firePropertyChange() {
|
||||
pSupport.firePropertyChange(null,null,val);
|
||||
}
|
||||
/** Notifies people that we've changed, although we don't
|
||||
* tell them just how.
|
||||
*/
|
||||
public void firePropertyChange()
|
||||
{
|
||||
pSupport.firePropertyChange(null, null, null);
|
||||
}
|
||||
|
||||
/** Returns the bean that is used as the source of events.
|
||||
*
|
||||
* @return The event source object
|
||||
* @since 1.5
|
||||
*/
|
||||
public Object getSource()
|
||||
{
|
||||
return eventSource;
|
||||
}
|
||||
|
||||
/** 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 <code>PropertyEditor</code>.
|
||||
*
|
||||
* @param source
|
||||
* @since 1.5
|
||||
*/
|
||||
public void setSource(Object source)
|
||||
{
|
||||
eventSource = source;
|
||||
}
|
||||
}
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user