com.sun.rave.designtime.markup
Class AttributeDescriptor

java.lang.Object

  java.beans.FeatureDescriptor

      com.sun.rave.designtime.markup.AttributeDescriptor

public class AttributeDescriptor

extends java.beans.FeatureDescriptor

An AttributeDescriptor describes a markup attribute that is used to persist the value of a JavaBean property. The AttributeDescriptor is "stuffed" into the PropertyDescriptor using the name-value pair storage: FeatureDescriptor.setValue(String key, Object value). The key is defined by Constants.PropertyDescriptor.ATTRIBUTE_DESCRIPTOR, or literally "attributeDescriptor". If an AttributeDescriptor is found in a property's PropertyDescriptor, the IDE will persist any property settings in the .jsp file as an attribute. If no AttributeDescriptor is found, any property settings will be persisted in the .java file as standard JavaBeans properties. For example, a property called 'background' of type 'java.awt.Color' might be persisted in two ways:

• If it has an AttributeDescriptor, it will be persisted as a markup attribute, like this: background="#FFFFFF"
• If there is no AttributeDescriptor, it will be persisted as a property setter method call, like this: setBackground(new java.awt.Color(255, 255, 255));

  Version:

  1.0

  Author:

  Joe Nuxoll

  See Also:

  FeatureDescriptor.setValue(String, Object), Constants.PropertyDescriptor.ATTRIBUTE_DESCRIPTOR

  Field Summary

  protected boolean	bindable protected storage for the 'bindable' property
  protected java.lang.String	defaultValue protected storage for the 'defaultValue' property
  protected boolean	required protected storage for the 'required' property

  Constructor Summary

  AttributeDescriptor()
  Constructs an empty AttributeDescriptor

  AttributeDescriptor(java.lang.String attributeName)
  Constructs an AttributeDescriptor with the specified attributeName

  AttributeDescriptor(java.lang.String attributeName, boolean required, java.lang.String defaultValue)
  Constructs an AttributeDescriptor with the specified attributeName, required state, and default value

  AttributeDescriptor(java.lang.String attributeName, boolean required, java.lang.String defaultValue, boolean bindable)
  Constructs an AttributeDescriptor with the specified attributeName, required state, default value, and bindable state

  Method Summary

  boolean	equals(java.lang.Object o)
  java.lang.String	getDefaultValue() Gets the 'defaultValue' property.
  boolean	isBindable() Gets the 'bindable' property.
  boolean	isRequired() Gets the 'required' property.
  void	setBindable(boolean bindable) Sets the 'bindable' property.
  void	setDefaultValue(java.lang.String defaultValue) Sets the 'defaultValue' property.
  void	setRequired(boolean required) Sets the 'required' property.

  Methods inherited from class java.beans.FeatureDescriptor

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

  Methods inherited from class java.lang.Object

  clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  Field Detail

  bindable

  
  protected boolean bindable

  protected storage for the 'bindable' property

  defaultValue

  
  protected java.lang.String defaultValue

  protected storage for the 'defaultValue' property

  required

  
  protected boolean required

  protected storage for the 'required' property

  Constructor Detail

  AttributeDescriptor

  
  public AttributeDescriptor()

  Constructs an empty AttributeDescriptor

  AttributeDescriptor

  
  public AttributeDescriptor(java.lang.String attributeName)

  Constructs an AttributeDescriptor with the specified attributeName

  Parameters:

  attributeName - The desired attribute name

  AttributeDescriptor

  
  public AttributeDescriptor(java.lang.String attributeName,
                             boolean required,
                             java.lang.String defaultValue)

  Constructs an AttributeDescriptor with the specified attributeName, required state, and default value

  Parameters:

  attributeName - The desired attribute name

  required - true if this is a required attribute, false if not

  defaultValue - The default value for this attribute (will not be persisted if the set value matches the default value)

  AttributeDescriptor

  
  public AttributeDescriptor(java.lang.String attributeName,
                             boolean required,
                             java.lang.String defaultValue,
                             boolean bindable)

  Constructs an AttributeDescriptor with the specified attributeName, required state, default value, and bindable state

  Parameters:

  attributeName - The desired attribute name

  required - true if this is a required attribute, false if not

  defaultValue - The default value for this attribute (will not be persisted if the set value matches the default value)

  bindable - true if this property is 'bindable', meaning it can have a value expression set on it, or false if not

  Method Detail

  equals

  
  public boolean equals(java.lang.Object o)

  getDefaultValue

  
  public java.lang.String getDefaultValue()

  Gets the 'defaultValue' property. The default value is the value that this property has if it is not set at all - thus when the value is explicitly set to the default, the property setting is removed from the persistence.

  Returns:

  the 'defaultValue' property setting

  isBindable

  
  public boolean isBindable()

  Gets the 'bindable' property. A 'bindable' property is one that may have a value binding expression as its value.

  Returns:

  true if this attribute should be bindable, false if not

  isRequired

  
  public boolean isRequired()

  Gets the 'required' property. A required attribute is one that must have a setting in order to produce valid JSP.

  Returns:

  the current state of the 'required' property

  setBindable

  
  public void setBindable(boolean bindable)

  Sets the 'bindable' property. A 'bindable' property is one that may have a value binding expression as its value.

  Parameters:

  bindable - true if this attribute should be bindable, false if not

  setDefaultValue

  
  public void setDefaultValue(java.lang.String defaultValue)

  Sets the 'defaultValue' property. The default value is the value that this property has if it is not set at all - thus when the value is explicitly set to the default, the property setting is removed from the persistence.

  Parameters:

  defaultValue - The default value for this attribute (will not be persisted if the set value matches the default value)

  setRequired

  
  public void setRequired(boolean required)

  Sets the 'required' property. A required attribute is one that must have a setting in order to produce valid JSP.

  Parameters:

  required - true if this attribute should be required, false if not