org.apache.beehive.netui.tags.tree
Class TreeHtmlAttributeInfo

Object
  extended by TreeHtmlAttributeInfo
All Implemented Interfaces:
Serializable

public class TreeHtmlAttributeInfo
extends Object
implements Serializable

This structure is used to track the use of HTML attributes within a tree item.

See Also:
Serialized Form

Field Summary
static int HTML_LOCATION_CNT
           
static int HTML_LOCATION_DIV
           
static int HTML_LOCATION_ICON
           
static int HTML_LOCATION_SELECTION_LINK
           
 
Constructor Summary
TreeHtmlAttributeInfo()
          Default constructor for creating a TreeHtmlAttributeInfo.
TreeHtmlAttributeInfo(String attribute, String value)
          Construct a new TreeHtmlAttributeInfo with the specified parameters.
 
Method Summary
 String getAttribute()
          Return the name of the attribute.
 TreeElement getParent()
          Return the parent node of the HtmlAttributeInfo item.
 String getValue()
          Return the value of the attribute.
 boolean isApplyToDescendents()
          Gets whether the attribute is applied to descendants of the node.
 boolean isOnDiv()
          Gets whether the HTML attribute is on the <div> tag of the node.
 boolean isOnIcon()
          Gets whether the HTML attribute is on the <img> tag for the icon of the node.
 boolean isOnSelectionLink()
          Gets whether the HTML attribute is on the selection link of the node.
 void setApplyToDescendents(boolean applyToDescendents)
          Sets whether the attribute is applied to descendant nodes of the parent node.
 void setAttribute(String attribute)
          Set the name of the attribute.
 void setOnDiv(boolean onDiv)
          Sets whether the HTML attribute is on the node item's <div> tag.
 void setOnIcon(boolean onIcon)
          Sets whether the HTML attribute is on the node item's <img> tag for the icon.
 void setOnSelectionLink(boolean onSelectionLink)
          Sets whether the HTML attribute is on the node item's selection.
 void setParent(TreeElement parent)
          Set the parent of the HtmlAttributeInfo item.
 void setValue(String value)
          Set the HTML attribute value.
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

HTML_LOCATION_DIV

public static final int HTML_LOCATION_DIV
See Also:
Constant Field Values

HTML_LOCATION_ICON

public static final int HTML_LOCATION_ICON
See Also:
Constant Field Values

HTML_LOCATION_SELECTION_LINK

public static final int HTML_LOCATION_SELECTION_LINK
See Also:
Constant Field Values

HTML_LOCATION_CNT

public static final int HTML_LOCATION_CNT
See Also:
Constant Field Values
Constructor Detail

TreeHtmlAttributeInfo

public TreeHtmlAttributeInfo()
Default constructor for creating a TreeHtmlAttributeInfo.


TreeHtmlAttributeInfo

public TreeHtmlAttributeInfo(String attribute,
                             String value)
Construct a new TreeHtmlAttributeInfo with the specified parameters.

Parameters:
attribute - the name of the attribute.
value - sets HTML attribute value.
Method Detail

getAttribute

public String getAttribute()
Return the name of the attribute.

Returns:
the attribute name

setAttribute

public void setAttribute(String attribute)
Set the name of the attribute.

Parameters:
attribute - the name of the attribute.

getValue

public String getValue()
Return the value of the attribute.

Returns:
the String value of the attribute.

setValue

public void setValue(String value)
Set the HTML attribute value.

Parameters:
value - the value of the HTML attribute.

getParent

public TreeElement getParent()
Return the parent node of the HtmlAttributeInfo item. This is the node the HtmlAttributeInfo item is associated with.

Returns:
the TreeElement parent.

setParent

public void setParent(TreeElement parent)
Set the parent of the HtmlAttributeInfo item. This sets the node the HtmlAttributeInfo item will be associated with.

Parameters:
parent - the TreeElement parent.

isApplyToDescendents

public boolean isApplyToDescendents()
Gets whether the attribute is applied to descendants of the node.

Returns:
whether the attribute is applied to descendants of the node.

setApplyToDescendents

public void setApplyToDescendents(boolean applyToDescendents)
Sets whether the attribute is applied to descendant nodes of the parent node.

Parameters:
applyToDescendents -

isOnDiv

public boolean isOnDiv()
Gets whether the HTML attribute is on the <div> tag of the node.

Returns:
whether the attribute is on the <div> tag of the node.

setOnDiv

public void setOnDiv(boolean onDiv)
Sets whether the HTML attribute is on the node item's <div> tag.

Parameters:
onDiv - whether the attribute is on the <div> tag of the node.

isOnIcon

public boolean isOnIcon()
Gets whether the HTML attribute is on the <img> tag for the icon of the node.

Returns:
whether the attribute is on the <img> tag of the node.

setOnIcon

public void setOnIcon(boolean onIcon)
Sets whether the HTML attribute is on the node item's <img> tag for the icon.

Parameters:
onIcon - whether the attribute is on the <img> tag of the node.

isOnSelectionLink

public boolean isOnSelectionLink()
Gets whether the HTML attribute is on the selection link of the node.

Returns:
whether the attribute is on the selection link of the node.

setOnSelectionLink

public void setOnSelectionLink(boolean onSelectionLink)
Sets whether the HTML attribute is on the node item's selection.

Parameters:
onSelectionLink - whether the attribute is on the selection link of the node.