org.apache.myfaces.tobago.taglib.component
Class TreeListboxTag

java.lang.Object
  javax.faces.webapp.UIComponentTag
      org.apache.myfaces.tobago.taglib.component.TobagoTag
          org.apache.myfaces.tobago.taglib.component.TreeListboxTag

All Implemented Interfaces:

JspTag, Tag, TobagoTagDeclaration, TreeListboxTagDeclaration, HasBinding, HasId, HasIdBindingAndRendered, HasIdReference, HasNameReference, HasState, HasTreeNodeValue, IsRendered, IsRequired

public class TreeListboxTag
extends TobagoTag
implements TreeListboxTagDeclaration

Field Summary

Fields inherited from class javax.faces.webapp.UIComponentTag

pageContext

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

TreeListboxTag()

Method Summary

String	getComponentType()
String	getIdReference()
String	getNameReference()
String	getRequired()
String	getSelectable()
String	getState()
String	getValue()
void	release()
void	setIdReference(String idReference) Bean property reference to fetch the id for the treeNode's.
void	setNameReference(String nameReference) Bean property reference to fetch the label for the treeNode's.
protected void	setProperties(UIComponent component)
void	setRequired(String required) Flag indicating that a value is required.
void	setSelectable(String selectable) Flag indicating whether or not this component should be render selectable items.
void	setState(String state) ValueBindingExpression pointing to a object to save the component's state.
void	setTipReference(String tipReference) reference to tip value.
void	setValue(String value) A javax.swing.tree.TreeNode object to use as rootNode in the tree.

Methods inherited from class org.apache.myfaces.tobago.taglib.component.TobagoTag

doEndTag, doStartTag, getDisabled, getHeight, getHidden, getInline, getLabel, getReadonly, getRendererType, getTitle, getWidth, setDisabled, setHeight, setHidden, setInline, setLabel, setReadonly, setTitle, setWidth

Methods inherited from class javax.faces.webapp.UIComponentTag

encodeBegin, encodeChildren, encodeEnd, findComponent, getComponentInstance, getCreated, getDoEndValue, getDoStartValue, getFacesContext, getFacetName, getId, getParent, getParentUIComponentTag, isSuppressed, isValueReference, setBinding, setId, setPageContext, setParent, setRendered, setupResponseWriter

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.jsp.tagext.Tag

doEndTag, doStartTag, getParent, setPageContext, setParent

Methods inherited from interface org.apache.myfaces.tobago.taglib.decl.HasId

setId

Methods inherited from interface org.apache.myfaces.tobago.taglib.decl.HasBinding

setBinding

Methods inherited from interface org.apache.myfaces.tobago.taglib.decl.IsRendered

setRendered

Constructor Detail

TreeListboxTag

public TreeListboxTag()

Method Detail

getComponentType

public String getComponentType()

Specified by:

getComponentType in class UIComponentTag

setProperties

protected void setProperties(UIComponent component)

Overrides:

setProperties in class TobagoTag

release

public void release()

Specified by:

release in interface Tag

Overrides:

release in class TobagoTag

getValue

public String getValue()

setValue

public void setValue(String value)

Description copied from interface: HasTreeNodeValue

A javax.swing.tree.TreeNode object to use as rootNode in the tree.

Specified by:

setValue in interface HasTreeNodeValue

getState

public String getState()

setState

public void setState(String state)

Description copied from interface: HasState

ValueBindingExpression pointing to a object to save the component's state.

Specified by:

setState in interface HasState

getIdReference

public String getIdReference()

setIdReference

public void setIdReference(String idReference)

Description copied from interface: HasIdReference

Bean property reference to fetch the id for the treeNode's.
Example:
a idReference="userObject.id" try's to invoke <UITreeNode>.getUserObject().getId() to fetch the id.

Specified by:

setIdReference in interface HasIdReference

getNameReference

public String getNameReference()

setNameReference

public void setNameReference(String nameReference)

Description copied from interface: HasNameReference

Bean property reference to fetch the label for the treeNode's.
Example:
a idReference="userObject.name" try's to invoke <UITreeNode>.getUserObject().getName() to fetch the label.

Specified by:

setNameReference in interface HasNameReference

getSelectable

public String getSelectable()

setSelectable

public void setSelectable(String selectable)

Description copied from interface: TreeListboxTagDeclaration

Flag indicating whether or not this component should be render selectable items. Possible values are:

• single : a singleselection tree is rendered
• singleLeafOnly : a singleselection tree is rendered, only Leaf's are selectable
• siblingLeafOnly : a multiselection tree is rendered, where only sibling Leaf's are selectable

Specified by:

setSelectable in interface TreeListboxTagDeclaration

getRequired

public String getRequired()

setRequired

public void setRequired(String required)

Description copied from interface: IsRequired

Flag indicating that a value is required. If the value is an empty string a ValidationError occurs and a Error Message is rendered.

Specified by:

setRequired in interface IsRequired

setTipReference

public void setTipReference(String tipReference)

Description copied from interface: TreeListboxTagDeclaration

reference to tip value.

Specified by:

setTipReference in interface TreeListboxTagDeclaration