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 class
UITree.PropertyKeys
-
Field Summary
Fields Modifier and Type Field Description static String
CHECKBOX_CLASS
static String
REQUIRED_MESSAGE_ID
static String
ROOT_ROW_KEY
static String
SEPARATOR
-
Constructor Summary
Constructors Constructor Description UITree()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
broadcast(javax.faces.event.FacesEvent event)
void
buildRowKeys(TreeNode<?> node)
protected boolean
doVisitChildren(javax.faces.component.visit.VisitContext context)
void
encodeBegin(javax.faces.context.FacesContext context)
protected TreeNode<?>
findTreeNode(TreeNode<?> searchRoot, String rowKey)
String
getContainerClientId(javax.faces.context.FacesContext context)
Object
getLocalSelectedNodes()
String
getNodeVar()
String
getRequiredMessage()
String
getRowKey()
TreeNode
getRowNode()
String
getSelectedRowKeysAsString()
Object
getSelection()
String
getSelectionMode()
Class<?>
getSelectionType()
TreeNode
getValue()
String
getVar()
void
initPreselection()
boolean
invokeOnComponent(javax.faces.context.FacesContext context, String clientId, javax.faces.component.ContextCallback callback)
boolean
isCheckboxSelectionMode()
boolean
isMultipleSelectionMode()
boolean
isPropagateSelectionDown()
boolean
isPropagateSelectionUp()
boolean
isRequired()
boolean
isRTLRendering()
boolean
isSelectionEnabled()
boolean
isShowUnselectableCheckbox()
boolean
isSkipChildren()
void
populateRowKeys(TreeNode<?> node, List<String> keys)
protected void
preDecode(javax.faces.context.FacesContext context)
protected void
preEncode(javax.faces.context.FacesContext context)
protected void
preUpdate(javax.faces.context.FacesContext context)
protected void
preValidate(javax.faces.context.FacesContext context)
protected void
processColumnChildren(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, TreeNode root, String nodeKey)
protected void
processColumnFacets(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, TreeNode root)
protected void
processComponent(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, javax.faces.event.PhaseId phaseId)
void
processDecodes(javax.faces.context.FacesContext context)
protected void
processFacets(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, TreeNode root)
protected void
processNode(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, TreeNode root, TreeNode treeNode, String rowKey)
protected void
processNodes(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, TreeNode root)
void
processUpdates(javax.faces.context.FacesContext context)
void
processValidators(javax.faces.context.FacesContext context)
void
queueEvent(javax.faces.event.FacesEvent event)
void
refreshSelectedNodeKeys()
protected boolean
requiresColumns()
void
setNodeVar(String _nodeVar)
void
setPropagateSelectionDown(boolean _propagateSelectionDown)
void
setPropagateSelectionUp(boolean _propagateSelectionUp)
void
setRequired(boolean _required)
void
setRequiredMessage(String _requiredMessage)
void
setRowKey(String rowKey)
void
setRowKey(TreeNode root, String rowKey)
void
setRowKey(Lazy<TreeNode> root, String rowKey)
protected void
setRowKey(Lazy<TreeNode> lazyRoot, TreeNode root, String rowKey)
void
setRTLRendering(boolean rtl)
void
setSelection(Object _selection)
void
setSelectionMode(String _selectionMode)
void
setShowUnselectableCheckbox(boolean _showUnselectableCheckbox)
void
setSkipChildren(boolean _skipChildren)
void
setValue(TreeNode _value)
void
setVar(String _var)
protected boolean
shouldVisitNode(TreeNode node)
void
updateRowKeys(TreeNode<?> node)
void
updateSelection(javax.faces.context.FacesContext context)
protected void
validateSelection(javax.faces.context.FacesContext context)
protected boolean
visitColumnContent(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, javax.faces.component.UIComponent component)
protected boolean
visitColumnFacets(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, javax.faces.component.UIComponent component)
protected boolean
visitColumnGroup(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, ColumnGroup group)
protected boolean
visitColumnsAndColumnFacets(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, boolean visitRows, Lazy<TreeNode> root)
protected boolean
visitFacets(javax.faces.component.visit.VisitContext context, Lazy<TreeNode> root, javax.faces.component.visit.VisitCallback callback, boolean visitNodes)
protected boolean
visitNode(javax.faces.component.visit.VisitContext context, Lazy<TreeNode> root, javax.faces.component.visit.VisitCallback callback, TreeNode treeNode, String rowKey)
protected boolean
visitNodes(javax.faces.component.visit.VisitContext context, Lazy<TreeNode> root, javax.faces.component.visit.VisitCallback callback, boolean visitRows)
boolean
visitTree(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:
getContainerClientId
in classjavax.faces.component.UIComponent
-
queueEvent
public void queueEvent(javax.faces.event.FacesEvent event)
- Overrides:
queueEvent
in classjavax.faces.component.UIComponentBase
-
broadcast
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
- Overrides:
broadcast
in classjavax.faces.component.UIComponentBase
- Throws:
javax.faces.event.AbortProcessingException
-
processDecodes
public void processDecodes(javax.faces.context.FacesContext context)
- Overrides:
processDecodes
in classjavax.faces.component.UIComponentBase
-
processValidators
public void processValidators(javax.faces.context.FacesContext context)
- Overrides:
processValidators
in classjavax.faces.component.UIComponentBase
-
validateSelection
protected void validateSelection(javax.faces.context.FacesContext context)
-
processUpdates
public void processUpdates(javax.faces.context.FacesContext context)
- Overrides:
processUpdates
in 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:
invokeOnComponent
in 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:
visitTree
in classjavax.faces.component.UIComponent
-
doVisitChildren
protected boolean doVisitChildren(javax.faces.component.visit.VisitContext context)
-
visitFacets
protected boolean visitFacets(javax.faces.component.visit.VisitContext context, Lazy<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, Lazy<TreeNode> root, javax.faces.component.visit.VisitCallback callback, boolean visitRows)
-
visitNode
protected boolean visitNode(javax.faces.component.visit.VisitContext context, Lazy<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, Lazy<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:
encodeBegin
in 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)
-
isSelectionEnabled
public boolean isSelectionEnabled()
-
isMultipleSelectionMode
public boolean isMultipleSelectionMode()
-
getSelectionType
public Class<?> getSelectionType()
-
isCheckboxSelectionMode
public boolean isCheckboxSelectionMode()
-
-