java.beans
Class FeatureDescriptor
java.lang.Object
|
+--java.beans.FeatureDescriptor
public class
FeatureDescriptorextends
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:FeatureDescriptor
public FeatureDescriptor()
Instantiate this FeatureDescriptor with appropriate default values.*
attributeNames
public Enumeration attributeNames()
Get a list of the programmatic key names set with setValue().
Returns:
- an Enumerator over all the programmatic key names associated
with this feature.
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:
- the value associated with this name, or null if there is none.
isExpert
public boolean isExpert()
Indicates whether this feature is for expert use only.
Returns:
- true if for use by experts only, or false if anyone can use it.
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:
- true if tools only should use it, or false if anyone can see it.
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:
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.