org.apache.myfaces.custom.tree2
Class HtmlTree

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by org.apache.myfaces.custom.tree2.UITreeData
              extended by org.apache.myfaces.custom.tree2.HtmlTree
All Implemented Interfaces:
javax.faces.component.NamingContainer, javax.faces.component.StateHolder, Tree

public class HtmlTree
extends UITreeData

Represents "tree data" in an HTML format. Also provides a mechanism for maintaining expand/collapse state of the nodes in the tree.

Author:
Sean Schofield

Field Summary
static java.lang.String COMPONENT_TYPE
           
 
Fields inherited from class org.apache.myfaces.custom.tree2.UITreeData
COMPONENT_FAMILY
 
Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
 
Constructor Summary
HtmlTree()
          Constructor
 
Method Summary
 javax.faces.component.UICommand getExpandControl()
          Gets the expand/collapse control that can be used to handle expand/collapse nodes.
 java.lang.String getImageLocation()
           
 java.lang.String getJavascriptLocation()
           
 boolean isClientSideToggle()
           
 boolean isPreserveToggle()
           
 boolean isShowLines()
           
 boolean isShowNav()
           
 boolean isShowRootNode()
           
protected  void processNodes(javax.faces.context.FacesContext context, int processAction, TreeWalker walker)
           
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext context)
           
 void setClientSideToggle(boolean clientSideToggle)
           
 void setImageLocation(java.lang.String imageLocation)
           
 void setJavascriptLocation(java.lang.String javascriptLocation)
           
 void setNodeId(java.lang.String nodeId)
           
 void setPreserveToggle(boolean preserveToggle)
           
 void setShowLines(boolean showLines)
           
 void setShowNav(boolean showNav)
           
 void setShowRootNode(boolean showRootNode)
           
 void setVarNodeToggler(java.lang.String varNodeToggler)
           
 
Methods inherited from class org.apache.myfaces.custom.tree2.UITreeData
broadcast, collapseAll, collapsePath, encodeBegin, encodeEnd, expandAll, expandPath, getClientId, getDataModel, getFamily, getModel, getNode, getNodeId, getPathInformation, getValue, getVar, isLastChild, isNodeExpanded, isNodeSelected, processDecodes, processUpdates, processValidators, queueEvent, setModel, setNodeSelected, setValue, setValueBinding, setVar, toggleExpanded
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, decode, encodeChildren, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMPONENT_TYPE

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

HtmlTree

public HtmlTree()
Constructor

Method Detail

processNodes

protected void processNodes(javax.faces.context.FacesContext context,
                            int processAction,
                            TreeWalker walker)
Overrides:
processNodes in class UITreeData
See Also:
UITreeData.processNodes(javax.faces.context.FacesContext, int, org.apache.myfaces.custom.tree2.TreeWalker)

saveState

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

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class UITreeData

setNodeId

public void setNodeId(java.lang.String nodeId)
Specified by:
setNodeId in interface Tree
Overrides:
setNodeId in class UITreeData

getExpandControl

public javax.faces.component.UICommand getExpandControl()
Gets the expand/collapse control that can be used to handle expand/collapse nodes. This is only used in server-side mode. It allows the nagivation controls (if any) to be clickable as well as any commandLinks the user has set up in their JSP.

Returns:
UICommand

setVarNodeToggler

public void setVarNodeToggler(java.lang.String varNodeToggler)

setShowNav

public void setShowNav(boolean showNav)

isShowNav

public boolean isShowNav()

setShowLines

public void setShowLines(boolean showLines)

isShowLines

public boolean isShowLines()

setClientSideToggle

public void setClientSideToggle(boolean clientSideToggle)

isClientSideToggle

public boolean isClientSideToggle()

setShowRootNode

public void setShowRootNode(boolean showRootNode)

isShowRootNode

public boolean isShowRootNode()

setPreserveToggle

public void setPreserveToggle(boolean preserveToggle)

isPreserveToggle

public boolean isPreserveToggle()

setJavascriptLocation

public void setJavascriptLocation(java.lang.String javascriptLocation)

getJavascriptLocation

public java.lang.String getJavascriptLocation()

setImageLocation

public void setImageLocation(java.lang.String imageLocation)

getImageLocation

public java.lang.String getImageLocation()


Copyright © 2011. All Rights Reserved.