org.apache.myfaces.tobago.component
Class UITreeNode

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by org.apache.myfaces.tobago.internal.component.AbstractUITreeNode
                  extended by org.apache.myfaces.tobago.component.UITreeNode
All Implemented Interfaces:
javax.faces.component.StateHolder, javax.faces.component.ValueHolder, SupportsMarkup, TreeModelBuilder, Configurable

public class UITreeNode
extends AbstractUITreeNode
implements SupportsMarkup

Creates a tree node. This component represents a single node inside a tree structure. For iterating over tree node use tc:treeData. UIComponent class, generated from template component1.2.stg with class TreeNodeTagDeclaration.


Field Summary
static String COMPONENT_TYPE
           
 
Fields inherited from class javax.faces.component.UIOutput
COMPONENT_FAMILY
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Constructor Summary
UITreeNode()
           
 
Method Summary
 Markup getCurrentMarkup()
           
 Markup getMarkup()
           
 String getTip()
          Text value to display as tooltip.
 javax.faces.el.MethodBinding getTreeExpansionListener()
           
 javax.faces.el.MethodBinding getTreeMarkedListener()
           
 boolean isDisabled()
          Flag indicating that this element is disabled.
 boolean isExpanded()
          Flag indicating if the subnodes are to be displayed.
 boolean isMarked()
          Flag indicating if the node is marked, and should be displayed in a special way.
 boolean isSelected()
          Flag indicating if the node is selected (only possible, when the tree component allows it).
 void restoreState(javax.faces.context.FacesContext context, Object componentState)
           
 Object saveState(javax.faces.context.FacesContext context)
           
 void setCurrentMarkup(Markup currentMarkup)
           
 void setDisabled(boolean disabled)
           
 void setExpanded(boolean expanded)
           
 void setMarked(boolean marked)
           
 void setMarkup(Markup markup)
           
 void setSelected(boolean selected)
           
 void setTip(String tip)
           
 void setTreeExpansionListener(javax.faces.el.MethodBinding treeExpansionListener)
           
 void setTreeMarkedListener(javax.faces.el.MethodBinding treeMarkedListener)
           
 
Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUITreeNode
addTreeExpansionListener, addTreeMarkedListener, broadcast, buildTreeModelBegin, buildTreeModelChildren, buildTreeModelEnd, encodeBegin, getDepth, getJunctions, getLevel, getPath, getTreeExpansionListeners, getTreeMarkedListeners, getValue, isFolder, isHasNextSibling, nodeStateId, removeStateChangeListener, removeStateChangeListener, setDepth, setFolder, setHasNextSibling, setJunctions, setPath
 
Methods inherited from class javax.faces.component.UIOutput
getConverter, getFamily, getLocalValue, setConverter, setValue
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId, getValueExpression, setValueExpression
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.myfaces.tobago.config.Configurable
getRendererType
 

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values
Constructor Detail

UITreeNode

public UITreeNode()
Method Detail

isSelected

public boolean isSelected()
Flag indicating if the node is selected (only possible, when the tree component allows it).
Default: false

Specified by:
isSelected in class AbstractUITreeNode

setSelected

public void setSelected(boolean selected)
Specified by:
setSelected in class AbstractUITreeNode

isMarked

public boolean isMarked()
Flag indicating if the node is marked, and should be displayed in a special way.
Default: false

Specified by:
isMarked in class AbstractUITreeNode

setMarked

public void setMarked(boolean marked)
Specified by:
setMarked in class AbstractUITreeNode

getMarkup

public Markup getMarkup()
Specified by:
getMarkup in interface SupportsMarkup

setMarkup

public void setMarkup(Markup markup)
Specified by:
setMarkup in interface SupportsMarkup

getTreeExpansionListener

public javax.faces.el.MethodBinding getTreeExpansionListener()
Specified by:
getTreeExpansionListener in class AbstractUITreeNode

setTreeExpansionListener

public void setTreeExpansionListener(javax.faces.el.MethodBinding treeExpansionListener)
Specified by:
setTreeExpansionListener in class AbstractUITreeNode

getCurrentMarkup

public Markup getCurrentMarkup()
Specified by:
getCurrentMarkup in interface SupportsMarkup
Specified by:
getCurrentMarkup in interface Configurable

setCurrentMarkup

public void setCurrentMarkup(Markup currentMarkup)
Specified by:
setCurrentMarkup in interface SupportsMarkup

isExpanded

public boolean isExpanded()
Flag indicating if the subnodes are to be displayed.
Default: false

Specified by:
isExpanded in class AbstractUITreeNode

setExpanded

public void setExpanded(boolean expanded)
Specified by:
setExpanded in class AbstractUITreeNode

isDisabled

public boolean isDisabled()
Flag indicating that this element is disabled.
Default: false


setDisabled

public void setDisabled(boolean disabled)

getTip

public String getTip()
Text value to display as tooltip.


setTip

public void setTip(String tip)

getTreeMarkedListener

public javax.faces.el.MethodBinding getTreeMarkedListener()
Specified by:
getTreeMarkedListener in class AbstractUITreeNode

setTreeMarkedListener

public void setTreeMarkedListener(javax.faces.el.MethodBinding treeMarkedListener)
Specified by:
setTreeMarkedListener in class AbstractUITreeNode

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         Object componentState)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class AbstractUITreeNode

saveState

public Object saveState(javax.faces.context.FacesContext context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class AbstractUITreeNode


Copyright © 2002-2014 The Apache Software Foundation. All Rights Reserved.