org.openide.nodes

Class Node.Property<T>

java.lang.Object

java.beans.FeatureDescriptor

org.openide.nodes.Node.Property<T>

Type Parameters:

T - the type of bean

Direct Known Subclasses:

Node.IndexedProperty, PropertySupport, PropertySupport.Reflection

Enclosing class:

Node

public abstract static class Node.Property<T>
extends FeatureDescriptor

Description of a Bean property on a node, and operations on it.

You may associate context help with this object, if desired, by setting a custom property with the name helpID and value of type String giving a help ID. Normally this is unnecessary as help for the whole Node will be used by default.

Important: the code name you use for the property is relevant not only for making properties of a node unique, but also for firing property changes.

Constructor Summary

Constructors

Constructor and Description
Property(Class<T> valueType) Constructor.

Method Summary

Modifier and Type	Method and Description
abstract boolean	canRead() Test whether the property is readable.
abstract boolean	canWrite() Test whether the property is writable.
boolean	equals(Object property)
String	getHtmlDisplayName() Return a variant of the display name containing HTML markup conforming to the limited subset of font-markup HTML supported by the lightweight HTML renderer HtmlRenderer (font color, bold, italic and strike-through supported; font colors can be UIManager color keys if they are prefixed with a ! character, i.e.
PropertyEditor	getPropertyEditor() Get a property editor for this property.
abstract T	getValue() Get the value.
Class<T>	getValueType() Get the value type.
int	hashCode()
boolean	isDefaultValue() This method indicates whether the current value is the same as the value that would otherwise be restored by calling restoreDefaultValue() (if supportsDefaultValue() returns true).
void	restoreDefaultValue() Restore this property to its default value, if supported.
abstract void	setValue(T val) Set the value.
boolean	supportsDefaultValue() Test whether the property had a default value.

Methods inherited from class java.beans.FeatureDescriptor

attributeNames, getDisplayName, getName, getShortDescription, getValue, isExpert, isHidden, isPreferred, setDisplayName, setExpert, setHidden, setName, setPreferred, setShortDescription, setValue, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Property

public Property(Class<T> valueType)

Constructor.

Parameters:

valueType - type of the property

Method Detail

getValueType

public Class<T> getValueType()

Get the value type. This is the representation class of the property. Remember that e.g. Boolean.class means that values are Boolean objects; to specify the primitive type, use e.g. Boolean.TYPE. In the latter case, Node.Property.getValue() and Node.Property.setValue(T) will still operate on the wrapper object.

Returns:

the type

canRead

public abstract boolean canRead()

Test whether the property is readable.

Returns:

true if it is

getValue

public abstract T getValue()
                    throws IllegalAccessException,
                           InvocationTargetException

Get the value.

Returns:

the value of the property

Throws:

IllegalAccessException - cannot access the called method

InvocationTargetException - an exception during invocation

canWrite

public abstract boolean canWrite()

Test whether the property is writable.

Returns:

true if the read of the value is supported

setValue

public abstract void setValue(T val)
                       throws IllegalAccessException,
                              IllegalArgumentException,
                              InvocationTargetException

Set the value.

Parameters:

val - the new value of the property

Throws:

IllegalAccessException - cannot access the called method

IllegalArgumentException - wrong argument

InvocationTargetException - an exception during invocation

supportsDefaultValue

public boolean supportsDefaultValue()

Test whether the property had a default value.

Returns:

true if it does (false by default)

restoreDefaultValue

public void restoreDefaultValue()
                         throws IllegalAccessException,
                                InvocationTargetException

Restore this property to its default value, if supported. In the default implementation, does nothing. Typically you would just call e.g. setValue(default). Note that it is not permitted for this call to throw IllegalArgumentException, though the other two exceptions from Node.Property.setValue(T) may be passed through.

Throws:

IllegalAccessException - cannot access the called method

InvocationTargetException - an exception during invocation

isDefaultValue

public boolean isDefaultValue()

This method indicates whether the current value is the same as the value that would otherwise be restored by calling restoreDefaultValue() (if supportsDefaultValue() returns true). The default implementation returns true and it is recommended to also return true when supportsDefaultValue() returns false (if we do not support default value any value can be considered as the default). If supportsDefaultValue() returns false this method will not be called by the default implementation of property sheet.

Since:

3.19

getPropertyEditor

public PropertyEditor getPropertyEditor()

Get a property editor for this property. The default implementation uses standard Java PropertyEditorManager. If a property editor is found, its instance is cached using SoftReference. Caching happens per thread - e.g. it is guaranteed that multiple threads accessing the editor will get different instance.

Returns:

the property editor, or null if there is no editor

equals

public boolean equals(Object property)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getHtmlDisplayName

public String getHtmlDisplayName()

Return a variant of the display name containing HTML markup conforming to the limited subset of font-markup HTML supported by the lightweight HTML renderer HtmlRenderer (font color, bold, italic and strike-through supported; font colors can be UIManager color keys if they are prefixed with a ! character, i.e. <font color=&'controlShadow'>). Enclosing HTML tags are not needed.

This method should return either an HTML display name or null; it should not return the non-HTML display name.

Returns:

a String containing conformant, legal HTML markup which represents the display name, or null. The default implementation returns null.

Since:

4.30

See Also:

HtmlRenderer