Package org.primefaces.component.api
Class UITree
- java.lang.Object
-
- javax.faces.component.UIComponent
-
- javax.faces.component.UIComponentBase
-
- org.primefaces.component.api.UITree
-
- All Implemented Interfaces:
EventListener,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
- Direct Known Subclasses:
TreeBase,TreeTableBase
public abstract class UITree extends javax.faces.component.UIComponentBase implements javax.faces.component.NamingContainer
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classUITree.PropertyKeys
-
Field Summary
Fields Modifier and Type Field Description static StringCHECKBOX_CLASSstatic StringREQUIRED_MESSAGE_IDstatic StringROOT_ROW_KEYstatic StringSEPARATOR
-
Constructor Summary
Constructors Constructor Description UITree()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidbroadcast(javax.faces.event.FacesEvent event)voidbuildRowKeys(TreeNode node)protected booleandoVisitChildren(javax.faces.component.visit.VisitContext context)voidencodeBegin(javax.faces.context.FacesContext context)protected TreeNodefindTreeNode(TreeNode searchRoot, String rowKey)StringgetContainerClientId(javax.faces.context.FacesContext context)ObjectgetLocalSelectedNodes()StringgetNodeVar()StringgetRequiredMessage()StringgetRowKey()TreeNodegetRowNode()StringgetSelectedRowKeysAsString()ObjectgetSelection()StringgetSelectionMode()TreeNodegetValue()StringgetVar()voidinitPreselection()booleaninvokeOnComponent(javax.faces.context.FacesContext context, String clientId, javax.faces.component.ContextCallback callback)protected BooleanisNestedWithinIterator()booleanisPropagateSelectionDown()booleanisPropagateSelectionUp()booleanisRequired()booleanisRTLRendering()booleanisShowUnselectableCheckbox()booleanisSkipChildren()voidpopulateRowKeys(TreeNode node, List<String> keys)protected voidpreDecode(javax.faces.context.FacesContext context)protected voidpreEncode(javax.faces.context.FacesContext context)protected voidpreUpdate(javax.faces.context.FacesContext context)protected voidpreValidate(javax.faces.context.FacesContext context)protected voidprocessColumnChildren(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, TreeNode root, String nodeKey)protected voidprocessColumnFacets(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, TreeNode root)protected voidprocessComponent(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, javax.faces.event.PhaseId phaseId)voidprocessDecodes(javax.faces.context.FacesContext context)protected voidprocessFacets(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, TreeNode root)protected voidprocessNode(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, TreeNode root, TreeNode treeNode, String rowKey)protected voidprocessNodes(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, TreeNode root)voidprocessUpdates(javax.faces.context.FacesContext context)voidprocessValidators(javax.faces.context.FacesContext context)voidqueueEvent(javax.faces.event.FacesEvent event)voidrefreshSelectedNodeKeys()protected booleanrequiresColumns()voidsetNodeVar(String _nodeVar)voidsetPropagateSelectionDown(boolean _propagateSelectionDown)voidsetPropagateSelectionUp(boolean _propagateSelectionUp)voidsetRequired(boolean _required)voidsetRequiredMessage(String _requiredMessage)voidsetRowKey(String rowKey)voidsetRowKey(TreeNode root, String rowKey)voidsetRTLRendering(boolean rtl)voidsetSelection(Object _selection)voidsetSelectionMode(String _selectionMode)voidsetShowUnselectableCheckbox(boolean _showUnselectableCheckbox)voidsetSkipChildren(boolean _skipChildren)voidsetValue(TreeNode _value)voidsetVar(String _var)protected booleanshouldVisitNode(TreeNode node)voidupdateRowKeys(TreeNode node)voidupdateSelection(javax.faces.context.FacesContext context)protected voidvalidateSelection(javax.faces.context.FacesContext context)protected booleanvisitColumnContent(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, javax.faces.component.UIComponent component)protected booleanvisitColumnFacets(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, javax.faces.component.UIComponent component)protected booleanvisitColumnGroup(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, ColumnGroup group)protected booleanvisitColumnsAndColumnFacets(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, boolean visitRows, TreeNode root)protected booleanvisitFacets(javax.faces.component.visit.VisitContext context, TreeNode root, javax.faces.component.visit.VisitCallback callback, boolean visitNodes)protected booleanvisitNode(javax.faces.component.visit.VisitContext context, TreeNode root, javax.faces.component.visit.VisitCallback callback, TreeNode treeNode, String rowKey)protected booleanvisitNodes(javax.faces.component.visit.VisitContext context, TreeNode root, javax.faces.component.visit.VisitCallback callback, boolean visitRows)booleanvisitTree(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback)-
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, clearInitialState, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent
-
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getFamily, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression
-
-
-
-
Field Detail
-
SEPARATOR
public static final String SEPARATOR
- See Also:
- Constant Field Values
-
REQUIRED_MESSAGE_ID
public static final String REQUIRED_MESSAGE_ID
- See Also:
- Constant Field Values
-
CHECKBOX_CLASS
public static final String CHECKBOX_CLASS
- See Also:
- Constant Field Values
-
ROOT_ROW_KEY
public static final String ROOT_ROW_KEY
- See Also:
- Constant Field Values
-
-
Method Detail
-
getRowKey
public String getRowKey()
-
setRowKey
public void setRowKey(String rowKey)
-
getRowNode
public TreeNode getRowNode()
-
getVar
public String getVar()
-
setVar
public void setVar(String _var)
-
getNodeVar
public String getNodeVar()
-
setNodeVar
public void setNodeVar(String _nodeVar)
-
getValue
public TreeNode getValue()
-
setValue
public void setValue(TreeNode _value)
-
getSelectionMode
public String getSelectionMode()
-
setSelectionMode
public void setSelectionMode(String _selectionMode)
-
getSelection
public Object getSelection()
-
setSelection
public void setSelection(Object _selection)
-
isRequired
public boolean isRequired()
-
setRequired
public void setRequired(boolean _required)
-
getRequiredMessage
public String getRequiredMessage()
-
setRequiredMessage
public void setRequiredMessage(String _requiredMessage)
-
isSkipChildren
public boolean isSkipChildren()
-
setSkipChildren
public void setSkipChildren(boolean _skipChildren)
-
isShowUnselectableCheckbox
public boolean isShowUnselectableCheckbox()
-
setShowUnselectableCheckbox
public void setShowUnselectableCheckbox(boolean _showUnselectableCheckbox)
-
getLocalSelectedNodes
public Object getLocalSelectedNodes()
-
isPropagateSelectionDown
public boolean isPropagateSelectionDown()
-
setPropagateSelectionDown
public void setPropagateSelectionDown(boolean _propagateSelectionDown)
-
isPropagateSelectionUp
public boolean isPropagateSelectionUp()
-
setPropagateSelectionUp
public void setPropagateSelectionUp(boolean _propagateSelectionUp)
-
buildRowKeys
public void buildRowKeys(TreeNode node)
-
updateRowKeys
public void updateRowKeys(TreeNode node)
-
initPreselection
public void initPreselection()
-
refreshSelectedNodeKeys
public void refreshSelectedNodeKeys()
-
getSelectedRowKeysAsString
public String getSelectedRowKeysAsString()
-
getContainerClientId
public String getContainerClientId(javax.faces.context.FacesContext context)
- Overrides:
getContainerClientIdin classjavax.faces.component.UIComponent
-
queueEvent
public void queueEvent(javax.faces.event.FacesEvent event)
- Overrides:
queueEventin classjavax.faces.component.UIComponentBase
-
broadcast
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException- Overrides:
broadcastin classjavax.faces.component.UIComponentBase- Throws:
javax.faces.event.AbortProcessingException
-
processDecodes
public void processDecodes(javax.faces.context.FacesContext context)
- Overrides:
processDecodesin classjavax.faces.component.UIComponentBase
-
processValidators
public void processValidators(javax.faces.context.FacesContext context)
- Overrides:
processValidatorsin classjavax.faces.component.UIComponentBase
-
validateSelection
protected void validateSelection(javax.faces.context.FacesContext context)
-
processUpdates
public void processUpdates(javax.faces.context.FacesContext context)
- Overrides:
processUpdatesin classjavax.faces.component.UIComponentBase
-
updateSelection
public void updateSelection(javax.faces.context.FacesContext context)
-
processNodes
protected void processNodes(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, TreeNode root)
-
processNode
protected void processNode(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, TreeNode root, TreeNode treeNode, String rowKey)
-
processFacets
protected void processFacets(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, TreeNode root)
-
processColumnFacets
protected void processColumnFacets(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, TreeNode root)
-
processColumnChildren
protected void processColumnChildren(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, TreeNode root, String nodeKey)
-
processComponent
protected void processComponent(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, javax.faces.event.PhaseId phaseId)
-
invokeOnComponent
public boolean invokeOnComponent(javax.faces.context.FacesContext context, String clientId, javax.faces.component.ContextCallback callback) throws javax.faces.FacesException- Overrides:
invokeOnComponentin classjavax.faces.component.UIComponentBase- Throws:
javax.faces.FacesException
-
visitTree
public boolean visitTree(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback)- Overrides:
visitTreein classjavax.faces.component.UIComponent
-
doVisitChildren
protected boolean doVisitChildren(javax.faces.component.visit.VisitContext context)
-
visitFacets
protected boolean visitFacets(javax.faces.component.visit.VisitContext context, TreeNode root, javax.faces.component.visit.VisitCallback callback, boolean visitNodes)
-
visitColumnContent
protected boolean visitColumnContent(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, javax.faces.component.UIComponent component)
-
visitNodes
protected boolean visitNodes(javax.faces.component.visit.VisitContext context, TreeNode root, javax.faces.component.visit.VisitCallback callback, boolean visitRows)
-
visitNode
protected boolean visitNode(javax.faces.component.visit.VisitContext context, TreeNode root, javax.faces.component.visit.VisitCallback callback, TreeNode treeNode, String rowKey)
-
requiresColumns
protected boolean requiresColumns()
-
visitColumnsAndColumnFacets
protected boolean visitColumnsAndColumnFacets(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, boolean visitRows, TreeNode root)
-
visitColumnFacets
protected boolean visitColumnFacets(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, javax.faces.component.UIComponent component)
-
visitColumnGroup
protected boolean visitColumnGroup(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, ColumnGroup group)
-
isRTLRendering
public boolean isRTLRendering()
-
setRTLRendering
public void setRTLRendering(boolean rtl)
-
shouldVisitNode
protected boolean shouldVisitNode(TreeNode node)
-
encodeBegin
public void encodeBegin(javax.faces.context.FacesContext context) throws IOException- Overrides:
encodeBeginin classjavax.faces.component.UIComponentBase- Throws:
IOException
-
preDecode
protected void preDecode(javax.faces.context.FacesContext context)
-
preValidate
protected void preValidate(javax.faces.context.FacesContext context)
-
preUpdate
protected void preUpdate(javax.faces.context.FacesContext context)
-
preEncode
protected void preEncode(javax.faces.context.FacesContext context)
-
isNestedWithinIterator
protected Boolean isNestedWithinIterator()
-
-