org.alfresco.web.ui.repo.component
Class UITree

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by org.alfresco.web.ui.repo.component.UITree
All Implemented Interfaces:
javax.faces.component.StateHolder

public class UITree
extends javax.faces.component.UIComponentBase

JSF component that renders an AJAX based tree for browsing the repository.


Nested Class Summary
static class UITree.TreeNode
          Inner class representing a node in the tree
 
Field Summary
static java.lang.String COMPONENT_TYPE
           
static java.lang.String DEFAULT_RENDERER
           
protected  java.lang.String nodeCollapsedCallback
           
protected  java.lang.String nodeCollapsedUrl
           
protected  java.lang.String nodeExpandedCallback
           
protected  java.lang.String nodeSelectedCallback
           
protected  java.lang.String retrieveChildrenUrl
           
protected  java.util.List rootNodes
           
 
Constructor Summary
UITree()
           
 
Method Summary
 java.lang.String getFamily()
           
 java.lang.String getNodeCollapsedCallback()
          Returns the Javascript function name to be used for node collapsed event
 java.lang.String getNodeCollapsedUrl()
          Returns the URL to use for the AJAX call to inform the server that a node has been collapsed
 java.lang.String getNodeExpandedCallback()
          Returns the Javascript function name to be used for node expanded event
 java.lang.String getNodeSelectedCallback()
          Returns the Javascript function name to be used for node selected event
 java.lang.String getRetrieveChildrenUrl()
          Returns the URL to use for the AJAX call to retrieve the child nodea
 java.util.List getRootNodes()
          Get the root nodes for the tree
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext context)
           
 void setNodeCollapsedCallback(java.lang.String nodeCollapsedCallback)
          Sets the name of the Javascript function to use for the node collapsed event
 void setNodeCollapsedUrl(java.lang.String nodeCollapsedUrl)
          Sets the AJAX URL to use to inform the server that a node has been collapsed
 void setNodeExpandedCallback(java.lang.String nodeExpandedCallback)
          Sets the name of the Javascript function to use for the expanded event
 void setNodeSelectedCallback(java.lang.String nodeSelectedCallback)
          Sets the name of the Javascript function to use for the node selected event
 void setRetrieveChildrenUrl(java.lang.String retrieveChildrenUrl)
          Sets the AJAX URL to use to retrive child nodes
 void setRootNodes(java.util.List rootNodes)
          Set the root nodes for the tree to show
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
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

DEFAULT_RENDERER

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

rootNodes

protected java.util.List rootNodes

retrieveChildrenUrl

protected java.lang.String retrieveChildrenUrl

nodeCollapsedUrl

protected java.lang.String nodeCollapsedUrl

nodeExpandedCallback

protected java.lang.String nodeExpandedCallback

nodeCollapsedCallback

protected java.lang.String nodeCollapsedCallback

nodeSelectedCallback

protected java.lang.String nodeSelectedCallback
Constructor Detail

UITree

public UITree()
Method Detail

getFamily

public java.lang.String getFamily()
Specified by:
getFamily in class javax.faces.component.UIComponent

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 javax.faces.component.UIComponentBase

saveState

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

getRootNodes

public java.util.List getRootNodes()
Get the root nodes for the tree

Returns:
the list of nodes representing the root nodes of the tree

setRootNodes

public void setRootNodes(java.util.List rootNodes)
Set the root nodes for the tree to show

Parameters:
rootNodes - The list of node for the tree

getNodeCollapsedCallback

public java.lang.String getNodeCollapsedCallback()
Returns the Javascript function name to be used for node collapsed event

Returns:
Javascript function name to be used for node collapsed event

setNodeCollapsedCallback

public void setNodeCollapsedCallback(java.lang.String nodeCollapsedCallback)
Sets the name of the Javascript function to use for the node collapsed event

Parameters:
nodeCollapsedCallback - The Javascript function to use for the node collapsed event

getNodeExpandedCallback

public java.lang.String getNodeExpandedCallback()
Returns the Javascript function name to be used for node expanded event

Returns:
Javascript function name to be used for node expanded event

setNodeExpandedCallback

public void setNodeExpandedCallback(java.lang.String nodeExpandedCallback)
Sets the name of the Javascript function to use for the expanded event

Parameters:
nodeExpandedCallback - The Javascript function to use for the expanded event

getNodeSelectedCallback

public java.lang.String getNodeSelectedCallback()
Returns the Javascript function name to be used for node selected event

Returns:
Javascript function name to be used for node selected event

setNodeSelectedCallback

public void setNodeSelectedCallback(java.lang.String nodeSelectedCallback)
Sets the name of the Javascript function to use for the node selected event

Parameters:
nodeSelectedCallback - The Javascript function to use for the node selected event

getRetrieveChildrenUrl

public java.lang.String getRetrieveChildrenUrl()
Returns the URL to use for the AJAX call to retrieve the child nodea

Returns:
AJAX URL to get children

setRetrieveChildrenUrl

public void setRetrieveChildrenUrl(java.lang.String retrieveChildrenUrl)
Sets the AJAX URL to use to retrive child nodes

Parameters:
retrieveChildrenUrl - The AJAX URL to use

getNodeCollapsedUrl

public java.lang.String getNodeCollapsedUrl()
Returns the URL to use for the AJAX call to inform the server that a node has been collapsed

Returns:
AJAX URL to inform of node collapse

setNodeCollapsedUrl

public void setNodeCollapsedUrl(java.lang.String nodeCollapsedUrl)
Sets the AJAX URL to use to inform the server that a node has been collapsed

Parameters:
nodeCollapsedUrl - The AJAX URL to use


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.