|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.portaluiinfrastructure.tags.metadata.ATagAttribute
public abstract class ATagAttribute
This base class provides programmatic access to the tag meta data for attributes, including name, description, type, requirement, and default values.
Adding public static final member variables of the various ATagAttribute classes turns on validation that the tag attributes are being used correctly, as well as providing useful documentation information.
Field Summary | |
---|---|
protected java.lang.String |
m_strDescription
|
protected java.lang.String |
m_strName
|
protected AttributeType |
m_Type
|
Constructor Summary | |
---|---|
protected |
ATagAttribute(java.lang.String _strName,
java.lang.String _strDescription,
AttributeType _type)
Creates a new tag attribute. |
Method Summary | |
---|---|
protected void |
CheckNameSafety()
This helper method checks whether or not the attribute name contains any illegal characters, such as whitespace. |
abstract java.lang.String |
GetDefaultValue()
The default value for an optional attribute if the attribute is not present or is of the incorrect type. |
java.lang.String |
GetDescription()
The description of the attribute and it's behavior. |
abstract boolean |
GetIsRequired()
Gets whether or not this attribute is required to be present every time the tag is used. |
java.lang.String |
GetName()
The name of the attribute. |
AttributeType |
GetType()
The data type of the attribute. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected java.lang.String m_strName
protected java.lang.String m_strDescription
protected final AttributeType m_Type
Constructor Detail |
---|
protected ATagAttribute(java.lang.String _strName, java.lang.String _strDescription, AttributeType _type)
_strName
- The attribute name._strDescription
- The attribute description._type
- The attribute type.
XPFormatException
- if the name contains any
whitespace.
XPIllegalArgumentException
- if the AttributeType
is null.Method Detail |
---|
public abstract boolean GetIsRequired()
public abstract java.lang.String GetDefaultValue()
public java.lang.String GetName()
public java.lang.String GetDescription()
public AttributeType GetType()
Specifying the attribute type will force the conversion of the attribute to that type and will cause an error if it cannot be converted.
Required attributes will be converted before the tag is displayed and will cause the tag to fail if they cannot be converted correctly.
protected void CheckNameSafety()
XPFormatException
- if the name contains any
whitespace.
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |