Index (Frames) | Index (No Frames) | Package | Package Tree | Tree
java.beans

Class FeatureDescriptor

java.lang.Object
|
+--java.beans.FeatureDescriptor


public class FeatureDescriptor

extends Object

FeatureDescriptor is the common superclass for all JavaBeans Descriptor classes. JavaBeans descriptors are abstract descriptors of properties, events, methods, beans, etc.

Documentation Convention: for proper Internalization of Beans inside an RAD tool, sometimes there are two names for a property or method: a programmatic, or locale-independent name, which can be used anywhere, and a localized, display name, for ease of use. In the documentation I will specify different String values as either programmatic or localized to make this distinction clear.

Since:Author:

Constructor Summary

FeatureDescriptor()

Instantiate this FeatureDescriptor with appropriate default values.*

Method Summary

java.util.EnumerationattributeNames()

Get a list of the programmatic key names set with setValue().
java.lang.StringgetDisplayName()

Get the localized (display) name of this feature.
java.lang.StringgetName()

Get the programmatic name of this feature.
java.lang.StringgetShortDescription()

Get the localized short description for this feature.
java.lang.ObjectgetValue(java.lang.String name)

Get an arbitrary value set with setValue().
booleanisExpert()

Indicates whether this feature is for expert use only.
booleanisHidden()

Indicates whether this feature is for use by tools only.
voidsetDisplayName(java.lang.String displayName)

Set the localized (display) name of this feature.
voidsetExpert(boolean expert)

Set whether this feature is for expert use only.
voidsetHidden(boolean hidden)

Set whether this feature is for use by tools only.
voidsetName(java.lang.String name)

Set the programmatic name of this feature.
voidsetShortDescription(java.lang.String shortDescription)

Set the localized short description for this feature.
voidsetValue(java.lang.String name, java.lang.Object value)

Set an arbitrary string-value pair with this feature.

Constructor Details

FeatureDescriptor

public FeatureDescriptor()

Instantiate this FeatureDescriptor with appropriate default values.*


Method Details

attributeNames

public Enumeration attributeNames()

Get a list of the programmatic key names set with setValue().

Returns:


getDisplayName

public String getDisplayName()

Get the localized (display) name of this feature. *


getName

public String getName()

Get the programmatic name of this feature. *


getShortDescription

public String getShortDescription()

Get the localized short description for this feature. *


getValue

public Object getValue(java.lang.String name)

Get an arbitrary value set with setValue().

Parameters:

Returns:


isExpert

public boolean isExpert()

Indicates whether this feature is for expert use only.

Returns:


isHidden

public boolean isHidden()

Indicates whether this feature is for use by tools only. If it is for use by tools only, then it should not be displayed.

Returns:


setDisplayName

public void setDisplayName(java.lang.String displayName)

Set the localized (display) name of this feature.

Parameters:


setExpert

public void setExpert(boolean expert)

Set whether this feature is for expert use only.

Parameters:


setHidden

public void setHidden(boolean hidden)

Set whether this feature is for use by tools only. If it is for use by tools only, then it should not be displayed.

Parameters:


setName

public void setName(java.lang.String name)

Set the programmatic name of this feature.

Parameters:


setShortDescription

public void setShortDescription(java.lang.String shortDescription)

Set the localized short description for this feature.

Parameters:


setValue

public void setValue(java.lang.String name, java.lang.Object value)

Set an arbitrary string-value pair with this feature.

Parameters: