Java Doc for PropertyEditorSupport.java in  » 6.0-JDK-Core » beans » java » beans » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » beans » java.beans 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.beans.PropertyEditorSupport

PropertyEditorSupport
public class PropertyEditorSupport implements PropertyEditor(Code)
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
public  PropertyEditorSupport()
     Constructs a PropertyEditorSupport object.
public  PropertyEditorSupport(Object source)
     Constructs a PropertyEditorSupport object.

Method Summary
public synchronized  voidaddPropertyChangeListener(PropertyChangeListener listener)
     Register a listener for the PropertyChange event.
public  voidfirePropertyChange()
     Report that we have been modified to any interested listeners.
public  StringgetAsText()
     Gets the property value as a string suitable for presentation to a human to edit.
public  java.awt.ComponentgetCustomEditor()
     A PropertyEditor may chose to make available a full custom Component that edits its property value.
public  StringgetJavaInitializationString()
     This method is intended for use when generating Java code to set the value of the property.
public  ObjectgetSource()
     Returns the bean that is used as the source of events.
public  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.
public  ObjectgetValue()
     Gets the value of the property.
public  booleanisPaintable()
     Determines whether the class will honor the paintValue method.
public  voidpaintValue(java.awt.Graphics gfx, java.awt.Rectangle box)
     Paint a representation of the value into a given area of screen real estate.
public synchronized  voidremovePropertyChangeListener(PropertyChangeListener listener)
     Remove a listener for the PropertyChange event.
public  voidsetAsText(String text)
     Sets the property value by parsing a given String.
public  voidsetSource(Object source)
     Sets the source bean.

The source bean is used as the source of events for the property changes.

public  voidsetValue(Object value)
     Set (or change) the object that is to be edited.
Parameters:
  value - The new target object to be edited.
public  booleansupportsCustomEditor()
     Determines whether the propertyEditor can provide a custom editor.


Constructor Detail
PropertyEditorSupport
public PropertyEditorSupport()(Code)
Constructs a PropertyEditorSupport object.
since:
   1.5


PropertyEditorSupport
public PropertyEditorSupport(Object source)(Code)
Constructs a PropertyEditorSupport object.
Parameters:
  source - the source used for event firing
since:
   1.5



Method Detail
addPropertyChangeListener
public synchronized void addPropertyChangeListener(PropertyChangeListener listener)(Code)
Register a listener for the PropertyChange event. The class will fire a PropertyChange value whenever the value is updated.
Parameters:
  listener - An object to be invoked when a PropertyChangeevent is fired.


firePropertyChange
public void firePropertyChange()(Code)
Report that we have been modified to any interested listeners.


getAsText
public String getAsText()(Code)
Gets the property value as a string suitable for presentation to a human to edit. The property value as a string suitable for presentationto a human to edit.

Returns "null" is the value can't be expressed as a string.

If a non-null value is returned, then the PropertyEditor shouldbe prepared to parse that string back in setAsText().



getCustomEditor
public java.awt.Component getCustomEditor()(Code)
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 ... A java.awt.Component that will allow a human to directlyedit the current property value. May be null if this isnot supported.



getJavaInitializationString
public String getJavaInitializationString()(Code)
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. A fragment of Java code representing an initializer for thecurrent value.



getSource
public Object getSource()(Code)
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. the source object or this instance
since:
   1.5


getTags
public String[] getTags()(Code)
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. The tag values for this property. May be null if this property cannot be represented as a tagged value.


getValue
public Object getValue()(Code)
Gets the value of the property. The value of the property.


isPaintable
public boolean isPaintable()(Code)
Determines whether the class will honor the paintValue method. True if the class will honor the paintValue method.


paintValue
public void paintValue(java.awt.Graphics gfx, java.awt.Rectangle box)(Code)
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 object to paint into.
Parameters:
  box - Rectangle within graphics object into which we should paint.



removePropertyChangeListener
public synchronized void removePropertyChangeListener(PropertyChangeListener listener)(Code)
Remove a listener for the PropertyChange event.
Parameters:
  listener - The PropertyChange listener to be removed.


setAsText
public void setAsText(String text) throws java.lang.IllegalArgumentException(Code)
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 - The string to be parsed.


setSource
public void setSource(Object source)(Code)
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 - source object to be used for events
since:
   1.5



setValue
public void setValue(Object value)(Code)
Set (or change) the object that is to be edited.
Parameters:
  value - The new target object to be edited. Note that thisobject should not be modified by the PropertyEditor, rather the PropertyEditor should create a new object to hold anymodified value.


supportsCustomEditor
public boolean supportsCustomEditor()(Code)
Determines whether the propertyEditor can provide a custom editor. True if the propertyEditor can provide a custom editor.


Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.