Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.beehive.netui.tags.rendering
Class AbstractAttributeState

Object
  extended by AbstractTagState
      extended by AbstractAttributeState
Direct Known Subclasses:
AbstractHtmlState, BaseTag.State, HtmlTag.State, ScriptTag.State
public abstract class AbstractAttributeState
extends AbstractTagState

Field Summary
static int ATTR_GENERAL
          The integer type constant indentifying the General Attributes AbstractBaseTag reserves 0-9 for indentification.
static String EMPTY_STRING
          String constant for the empty string.
 
Constructor Summary
AbstractAttributeState()
           
 
Method Summary
 void clear()
           
 String getAttribute(int type, String attrName)
          Return a named attribute value from the specified attribute map.
 HashMap getGeneralAttributeMap()
           
 void registerAttribute(int type, String attrName, String value)
           
 void registerAttribute(int type, String attrName, String value, boolean ignoreEmpty)
          Register a name/value pair into a named attribute map.
 void removeAttribute(int type, String attrName)
          Remove a previously registered attribute value from map.
 Map selectMap(int type, boolean createIfNull)
          This method will return the map that represents the passed in type.
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EMPTY_STRING

public static final String EMPTY_STRING
String constant for the empty string.

See Also:
Constant Field Values

ATTR_GENERAL

public static final int ATTR_GENERAL
The integer type constant indentifying the General Attributes AbstractBaseTag reserves 0-9 for indentification.

See Also:
Constant Field Values
Constructor Detail

AbstractAttributeState

public AbstractAttributeState()
Method Detail

getGeneralAttributeMap

public HashMap getGeneralAttributeMap()

selectMap

public Map selectMap(int type,
                     boolean createIfNull)
This method will return the map that represents the passed in type. The boolean flag createIfNull indicates that the map should be created or not if it's null. This class defines two maps defined by @see #ATTR_GENERAL and ATTR_GENERAL_EXPRESSION

Parameters:
type - integer type indentifying the map to be created.
createIfNull - boolean flag indicating if the map should be created if it doesn't exist.
Returns:
The map or null
See Also:
ATTR_GENERAL

clear

public void clear()
Specified by:
clear in class AbstractTagState

registerAttribute

public void registerAttribute(int type,
                              String attrName,
                              String value,
                              boolean ignoreEmpty)
Register a name/value pair into a named attribute map. The base type supports the ATTR_GENERAL named map. Subclasses may add additional maps enabling attributes to be treated with different behavior.

Parameters:
type - an integer key identifying the map.
attrName - the name of the attribute
value - the value of the attribute

registerAttribute

public void registerAttribute(int type,
                              String attrName,
                              String value)

removeAttribute

public void removeAttribute(int type,
                            String attrName)
Remove a previously registered attribute value from map.

Parameters:
type - an integer key indentifying the map
attrName - the name of the attribute to remove from the specified map

getAttribute

public String getAttribute(int type,
                           String attrName)
Return a named attribute value from the specified attribute map.

Parameters:
type - an integer key indentifying the map
attrName - the name of the attribute we will get the value from.
Returns:
a string value of the attribute if set or null.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD