Package org.primefaces.component.tree

Class Tree

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.primefaces.component.api.UITree

org.primefaces.component.tree.TreeBase

org.primefaces.component.tree.Tree

All Implemented Interfaces:

EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, PrimeClientBehaviorHolder, RTLAware, Widget

public class Tree
extends TreeBase

Nested Class Summary

Nested classes/interfaces inherited from class org.primefaces.component.tree.TreeBase

TreeBase.PropertyKeys

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHILDREN_NODES_CLASS
static final String	COLLAPSED_ICON_CLASS_H
static final String	COLLAPSED_ICON_CLASS_V
static final String	COLLAPSED_ICON_RTL_CLASS_V
static final String	COMPONENT_TYPE
static final String	CONTAINER_CLASS
static final String	CONTAINER_RTL_CLASS
static final String	EXPANDED_ICON_CLASS_H
static final String	EXPANDED_ICON_CLASS_V
static final String	FILTER_CLASS
static final String	FILTER_CONTAINER
static final String	HORIZONTAL_CONTAINER_CLASS
static final String	LEAF_ICON_CLASS
static final String	LEAF_NODE_CLASS
static final String	NODE_CONTENT_CLASS_H
static final String	NODE_CONTENT_CLASS_V
static final String	NODE_ICON_CLASS
static final String	NODE_LABEL_CLASS
static final String	PARENT_NODE_CLASS
static final String	ROOT_NODES_CLASS
static final String	SELECTABLE_NODE_CONTENT_CLASS_H
static final String	SELECTABLE_NODE_CONTENT_CLASS_V

Fields inherited from class org.primefaces.component.tree.TreeBase

COMPONENT_FAMILY, DEFAULT_RENDERER

Fields inherited from class org.primefaces.component.api.UITree

CHECKBOX_CLASS, REQUIRED_MESSAGE_ID, ROOT_ROW_KEY, SEPARATOR

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Fields inherited from interface org.primefaces.component.api.Widget

ATTR_WIDGET_VAR_PATTERN, CALLBACK_POST_CONSTRUCT, CALLBACK_POST_REFRESH, CALLBACK_PRE_DESTROY

Constructor Summary

Constructors

Constructor	Description
Tree()

Method Summary

Modifier and Type	Method	Description
TreeNode	createCopyOfTreeNode(TreeNode<?> node)
Map<String,Class<? extends javax.faces.event.BehaviorEvent>>	getBehaviorEventMapping()
Collection<String>	getEventNames()
List<String>	getFilteredRowKeys()
String	getScrollState()
Map<String,UITreeNode>	getTreeNodes()
UITreeNode	getUITreeNodeByType(String type)
boolean	isDragDropRequest(javax.faces.context.FacesContext context)
boolean	isFiltering()
boolean	isFilterRequest(javax.faces.context.FacesContext context)
boolean	isNodeExpandRequest(javax.faces.context.FacesContext context)
boolean	isSelectionRequest(javax.faces.context.FacesContext context)
boolean	isTreeNodeDropped()
protected void	processColumnChildren(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, TreeNode root, String nodeKey)
void	processDecodes(javax.faces.context.FacesContext context)
void	processUpdates(javax.faces.context.FacesContext context)
void	processValidators(javax.faces.context.FacesContext context)
void	queueEvent(javax.faces.event.FacesEvent event)
Object	saveState(javax.faces.context.FacesContext context)
void	setFilteredRowKeys(List<String> filteredRowKeys)
protected boolean	shouldVisitNode(TreeNode node)

Methods inherited from class org.primefaces.component.tree.TreeBase

getDatakey, getDir, getDragdropScope, getDragMode, getDropRestrict, getFamily, getFilterBy, getFilterFunction, getFilterMatchMode, getFilterMode, getOnDrop, getOnNodeClick, getOrientation, getStyle, getStyleClass, getTabindex, getWidgetVar, isAnimate, isCache, isDisabled, isDraggable, isDropCopyNode, isDroppable, isDynamic, isHighlight, isMultipleDrag, setAnimate, setCache, setDatakey, setDir, setDisabled, setDragdropScope, setDraggable, setDragMode, setDropCopyNode, setDroppable, setDropRestrict, setDynamic, setFilterBy, setFilterFunction, setFilterMatchMode, setFilterMode, setHighlight, setMultipleDrag, setOnDrop, setOnNodeClick, setOrientation, setStyle, setStyleClass, setTabindex, setWidgetVar

Methods inherited from class org.primefaces.component.api.UITree

broadcast, buildRowKeys, doVisitChildren, encodeBegin, findTreeNode, getContainerClientId, getLocalSelectedNodes, getNodeVar, getRequiredMessage, getRowKey, getRowNode, getSelectedRowKeysAsString, getSelection, getSelectionMode, getSelectionType, getValue, getVar, initPreselection, invokeOnComponent, isCheckboxSelectionMode, isMultipleSelectionMode, isPropagateSelectionDown, isPropagateSelectionUp, isRequired, isRTLRendering, isSelectionEnabled, isShowUnselectableCheckbox, isSkipChildren, populateRowKeys, preDecode, preEncode, preUpdate, preValidate, processColumnFacets, processComponent, processFacets, processNode, processNodes, refreshSelectedNodeKeys, requiresColumns, setNodeVar, setPropagateSelectionDown, setPropagateSelectionUp, setRequired, setRequiredMessage, setRowKey, setRowKey, setRowKey, setRowKey, setRTLRendering, setSelection, setSelectionMode, setShowUnselectableCheckbox, setSkipChildren, setValue, setVar, updateRowKeys, updateSelection, validateSelection, visitColumnContent, visitColumnFacets, visitColumnGroup, visitColumnsAndColumnFacets, visitFacets, visitNode, visitNodes, visitTree

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, clearInitialState, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors, getDefaultEventName

Methods inherited from interface org.primefaces.component.api.RTLAware

isRTL

Methods inherited from interface org.primefaces.component.api.Widget

resolveWidgetVar, resolveWidgetVar

Field Details

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

• Constant Field Values

FILTER_CLASS

public static final String FILTER_CLASS

See Also:

• Constant Field Values

FILTER_CONTAINER

public static final String FILTER_CONTAINER

See Also:

• Constant Field Values

CONTAINER_CLASS

public static final String CONTAINER_CLASS

See Also:

• Constant Field Values

CONTAINER_RTL_CLASS

public static final String CONTAINER_RTL_CLASS

See Also:

• Constant Field Values

HORIZONTAL_CONTAINER_CLASS

public static final String HORIZONTAL_CONTAINER_CLASS

See Also:

• Constant Field Values

ROOT_NODES_CLASS

public static final String ROOT_NODES_CLASS

See Also:

• Constant Field Values

PARENT_NODE_CLASS

public static final String PARENT_NODE_CLASS

See Also:

• Constant Field Values

LEAF_NODE_CLASS

public static final String LEAF_NODE_CLASS

See Also:

• Constant Field Values

CHILDREN_NODES_CLASS

public static final String CHILDREN_NODES_CLASS

See Also:

• Constant Field Values

NODE_CONTENT_CLASS_V

public static final String NODE_CONTENT_CLASS_V

See Also:

• Constant Field Values

SELECTABLE_NODE_CONTENT_CLASS_V

public static final String SELECTABLE_NODE_CONTENT_CLASS_V

See Also:

• Constant Field Values

NODE_CONTENT_CLASS_H

public static final String NODE_CONTENT_CLASS_H

See Also:

• Constant Field Values

SELECTABLE_NODE_CONTENT_CLASS_H

public static final String SELECTABLE_NODE_CONTENT_CLASS_H

See Also:

• Constant Field Values

EXPANDED_ICON_CLASS_V

public static final String EXPANDED_ICON_CLASS_V

See Also:

• Constant Field Values

COLLAPSED_ICON_CLASS_V

public static final String COLLAPSED_ICON_CLASS_V

See Also:

• Constant Field Values

COLLAPSED_ICON_RTL_CLASS_V

public static final String COLLAPSED_ICON_RTL_CLASS_V

See Also:

• Constant Field Values

EXPANDED_ICON_CLASS_H

public static final String EXPANDED_ICON_CLASS_H

See Also:

• Constant Field Values

COLLAPSED_ICON_CLASS_H

public static final String COLLAPSED_ICON_CLASS_H

See Also:

• Constant Field Values

LEAF_ICON_CLASS

public static final String LEAF_ICON_CLASS

See Also:

• Constant Field Values

NODE_ICON_CLASS

public static final String NODE_ICON_CLASS

See Also:

• Constant Field Values

NODE_LABEL_CLASS

public static final String NODE_LABEL_CLASS

See Also:

• Constant Field Values

Constructor Details

Tree

public Tree()

Method Details

getUITreeNodeByType

public UITreeNode getUITreeNodeByType(String type)

isFiltering

public boolean isFiltering()

isNodeExpandRequest

public boolean isNodeExpandRequest(javax.faces.context.FacesContext context)

isSelectionRequest

public boolean isSelectionRequest(javax.faces.context.FacesContext context)

isFilterRequest

public boolean isFilterRequest(javax.faces.context.FacesContext context)

getTreeNodes

public Map<String,UITreeNode> getTreeNodes()

getBehaviorEventMapping

public Map<String,Class<? extends javax.faces.event.BehaviorEvent>> getBehaviorEventMapping()

getEventNames

public Collection<String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getEventNames in class javax.faces.component.UIComponentBase

queueEvent

public void queueEvent(javax.faces.event.FacesEvent event)

Overrides:

queueEvent in class UITree

isDragDropRequest

public boolean isDragDropRequest(javax.faces.context.FacesContext context)

processDecodes

public void processDecodes(javax.faces.context.FacesContext context)

Overrides:

processDecodes in class UITree

processValidators

public void processValidators(javax.faces.context.FacesContext context)

Overrides:

processValidators in class UITree

processUpdates

public void processUpdates(javax.faces.context.FacesContext context)

Overrides:

processUpdates in class UITree

shouldVisitNode

protected boolean shouldVisitNode(TreeNode node)

Overrides:

shouldVisitNode in class UITree

processColumnChildren

protected void processColumnChildren(javax.faces.context.FacesContext context,
 javax.faces.event.PhaseId phaseId,
 TreeNode root,
 String nodeKey)

Overrides:

processColumnChildren in class UITree

createCopyOfTreeNode

public TreeNode createCopyOfTreeNode(TreeNode<?> node)

isTreeNodeDropped

public boolean isTreeNodeDropped()

getScrollState

public String getScrollState()

getFilteredRowKeys

public List<String> getFilteredRowKeys()

setFilteredRowKeys

public void setFilteredRowKeys(List<String> filteredRowKeys)

saveState

public Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIComponentBase