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.AbstractHtmlTree
                  extended by org.apache.myfaces.custom.tree2.HtmlTree
All Implemented Interfaces:
javax.faces.component.NamingContainer, javax.faces.component.StateHolder, LocationAware, Tree

public class HtmlTree
extends AbstractHtmlTree


Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static java.lang.String DEFAULT_RENDERER_TYPE
           
 
Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
 
Constructor Summary
HtmlTree()
           
 
Method Summary
 java.lang.String getFamily()
           
 java.lang.String getImageLocation()
          An alternate location to find image resources.
 java.lang.String getJavascriptLocation()
          An alternate location to find javascript resources.
 java.lang.String getStyleLocation()
          An alternate location to find stylesheet resources.
 boolean isPreserveToggle()
          Preserve changes in client-side toggle information between requests (default is true.)
 boolean isShowLines()
          Show the connecting lines (default is true.)
 boolean isShowNav()
          Show the "plus" and "minus" navigation icons (default is true.) Value is ignored if clientSideToggle is true.
 boolean isShowRootNode()
          Include the root node when rendering the tree (default is true.)
 void restoreState(javax.faces.context.FacesContext facesContext, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext facesContext)
           
 void setImageLocation(java.lang.String imageLocation)
           
 void setJavascriptLocation(java.lang.String javascriptLocation)
           
 void setPreserveToggle(boolean preserveToggle)
           
 void setShowLines(boolean showLines)
           
 void setShowNav(boolean showNav)
           
 void setShowRootNode(boolean showRootNode)
           
 void setStyleLocation(java.lang.String styleLocation)
           
 
Methods inherited from class org.apache.myfaces.custom.tree2.AbstractHtmlTree
getExpandControl, getVarNodeToggler, isClientSideToggle, processNodes, setClientSideToggle, setNodeId, setVarNodeToggler
 
Methods inherited from class org.apache.myfaces.custom.tree2.UITreeData
broadcast, collapseAll, collapsePath, encodeBegin, encodeEnd, expandAll, expandPath, getClientId, getDataModel, 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_FAMILY

public static final java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

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

DEFAULT_RENDERER_TYPE

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

HtmlTree

public HtmlTree()
Method Detail

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class UITreeData

isShowNav

public boolean isShowNav()
Description copied from class: AbstractHtmlTree
Show the "plus" and "minus" navigation icons (default is true.) Value is ignored if clientSideToggle is true.

Specified by:
isShowNav in class AbstractHtmlTree

setShowNav

public void setShowNav(boolean showNav)

isShowLines

public boolean isShowLines()
Description copied from class: AbstractHtmlTree
Show the connecting lines (default is true.)

Specified by:
isShowLines in class AbstractHtmlTree

setShowLines

public void setShowLines(boolean showLines)

isShowRootNode

public boolean isShowRootNode()
Description copied from class: AbstractHtmlTree
Include the root node when rendering the tree (default is true.)

Specified by:
isShowRootNode in class AbstractHtmlTree

setShowRootNode

public void setShowRootNode(boolean showRootNode)

isPreserveToggle

public boolean isPreserveToggle()
Description copied from class: AbstractHtmlTree
Preserve changes in client-side toggle information between requests (default is true.)

Specified by:
isPreserveToggle in class AbstractHtmlTree

setPreserveToggle

public void setPreserveToggle(boolean preserveToggle)

getJavascriptLocation

public java.lang.String getJavascriptLocation()
Description copied from interface: LocationAware
An alternate location to find javascript resources. If no values is specified, javascript will be loaded from the resources directory using AddResource and ExtensionsFilter.


setJavascriptLocation

public void setJavascriptLocation(java.lang.String javascriptLocation)

getImageLocation

public java.lang.String getImageLocation()
Description copied from interface: LocationAware
An alternate location to find image resources. If no values is specified, images will be loaded from the resources directory using AddResource and ExtensionsFilter.


setImageLocation

public void setImageLocation(java.lang.String imageLocation)

getStyleLocation

public java.lang.String getStyleLocation()
Description copied from interface: LocationAware
An alternate location to find stylesheet resources. If no values is specified, stylesheets will be loaded from the resources directory using AddResource and ExtensionsFilter.


setStyleLocation

public void setStyleLocation(java.lang.String styleLocation)

saveState

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

restoreState

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


Copyright © 2011 The Apache Software Foundation. All Rights Reserved.