public class

FontEditor

extends Panel
implements PropertyEditor
java.lang.Object
   ↳ java.awt.Component
     ↳ java.awt.Container
       ↳ java.awt.Panel
         ↳ sun.beans.editors.FontEditor

Summary

[Expand]
Inherited Constants
From class java.awt.Component
From interface java.awt.image.ImageObserver
Public Constructors
FontEditor()
Public Methods
boolean action(Event e, Object arg)
This method is deprecated. As of JDK version 1.1, should register this component as ActionListener on component which fires action events.
void addPropertyChangeListener(PropertyChangeListener l)
Adds a PropertyChangeListener to the listener list.
String getAsText()
Gets the property value as text.
Component getCustomEditor()
A PropertyEditor may choose to make available a full custom Component that edits its property value.
String getJavaInitializationString()
Returns a fragment of Java code that can be used to set a property to match the editors current state.
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 tags.
Object getValue()
Gets the property value.
boolean isPaintable()
Determines whether this property editor is paintable.
void paintValue(Graphics gfx, Rectangle box)
Paint a representation of the value into a given area of screen real estate.
Dimension preferredSize()
This method is deprecated. As of JDK version 1.1, replaced by getPreferredSize().
void removePropertyChangeListener(PropertyChangeListener l)
Removes a PropertyChangeListener from the listener list.
void setAsText(String text)
Set the property value by parsing a given String.
void setValue(Object o)
Set (or change) the object that is to be edited.
boolean supportsCustomEditor()
Determines whether this property editor supports a custom editor.
[Expand]
Inherited Methods
From class java.awt.Panel
From class java.awt.Container
From class java.awt.Component
From class java.lang.Object
From interface java.awt.MenuContainer
From interface java.awt.image.ImageObserver
From interface java.beans.PropertyEditor
From interface javax.accessibility.Accessible

Public Constructors

public FontEditor ()

Public Methods

public boolean action (Event e, Object arg)

This method is deprecated.
As of JDK version 1.1, should register this component as ActionListener on component which fires action events.

public void addPropertyChangeListener (PropertyChangeListener l)

Adds a PropertyChangeListener to the listener list. The listener is registered for all bound properties of this class, including the following:

  • this Container's font ("font")
  • this Container's background color ("background")
  • this Container's foreground color ("foreground")
  • this Container's focusability ("focusable")
  • this Container's focus traversal keys enabled state ("focusTraversalKeysEnabled")
  • this Container's Set of FORWARD_TRAVERSAL_KEYS ("forwardFocusTraversalKeys")
  • this Container's Set of BACKWARD_TRAVERSAL_KEYS ("backwardFocusTraversalKeys")
  • this Container's Set of UP_CYCLE_TRAVERSAL_KEYS ("upCycleFocusTraversalKeys")
  • this Container's Set of DOWN_CYCLE_TRAVERSAL_KEYS ("downCycleFocusTraversalKeys")
  • this Container's focus traversal policy ("focusTraversalPolicy")
  • this Container's focus-cycle-root state ("focusCycleRoot")
Note that if this Container is inheriting a bound property, then no event will be fired in response to a change in the inherited property.

If listener is null, no exception is thrown and no action is performed.

Parameters
l the PropertyChangeListener to be added

public String getAsText ()

Gets the property value as text.

Returns
  • The property value as a human editable string.

    Returns null if the value can't be expressed as an editable string.

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

public Component getCustomEditor ()

A PropertyEditor may choose 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
  • A java.awt.Component that will allow a human to directly edit the current property value. May be null if this is not supported.

public String getJavaInitializationString ()

Returns a fragment of Java code that can be used to set a property to match the editors current state. This method is intended for use when generating Java code to reflect changes made through the property editor.

The code fragment should be context free and must be a legal Java expression as specified by the JLS.

Specifically, if the expression represents a computation then all classes and static members should be fully qualified. This rule applies to constructors, static methods and non primitive arguments.

Caution should be used when evaluating the expression as it may throw exceptions. In particular, code generators must ensure that generated code will compile in the presence of an expression that can throw checked exceptions.

Example results are:

  • Primitive expresssion: 2
  • Class constructor: new java.awt.Color(127,127,34)
  • Static field: java.awt.Color.orange
  • Static method: javax.swing.Box.createRigidArea(new java.awt.Dimension(0, 5))

Returns
  • a fragment of Java code representing an initializer for the current value. It should not contain a semi-colon (';') to end the expression.

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 tags. 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 and the use of getAsText to identify the current value.

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

public Object getValue ()

Gets the property value.

Returns
  • The value of the property. Primitive types such as "int" will be wrapped as the corresponding object type such as "java.lang.Integer".

public boolean isPaintable ()

Determines whether this property editor is paintable.

Returns
  • True if the class will honor the paintValue method.

public void paintValue (Graphics gfx, Rectangle box)

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.

The given Graphics object will have the default font, color, etc of the parent container. The PropertyEditor may change graphics attributes such as font and color and doesn't need to restore the old values.

Parameters
gfx Graphics object to paint into.
box Rectangle within graphics object into which we should paint.

public Dimension preferredSize ()

This method is deprecated.
As of JDK version 1.1, replaced by getPreferredSize().

public void removePropertyChangeListener (PropertyChangeListener l)

Removes a PropertyChangeListener from the listener list. This method should be used to remove PropertyChangeListeners that were registered for all bound properties of this class.

If listener is null, no exception is thrown and no action is performed.

Parameters
l the PropertyChangeListener to be removed

public void setAsText (String text)

Set 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.
Throws
IllegalArgumentException

public void setValue (Object o)

Set (or change) the object that is to be edited. Primitive types such as "int" must be wrapped as the corresponding object type such as "java.lang.Integer".

Parameters
o 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 boolean supportsCustomEditor ()

Determines whether this property editor supports a custom editor.

Returns
  • True if the propertyEditor can provide a custom editor.