|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.faces.component.UIComponent javax.faces.component.UIComponentBase org.omnifaces.component.tree.TreeFamily org.omnifaces.component.tree.TreeNode
public class TreeNode
TreeNode is an UIComponent
that represents a single tree node within a parent
Tree
component. Within this component, the var
attribute of the parent Tree
component will expose the tree node. Each of its children is processed by TreeNodeItem
.
The level
attribute can be used to specify for which tree node level as obtained by
TreeModel.getLevel()
this component should render the children by TreeNodeItem
. The root tree node
has level 0.
Tree
,
TreeNodeItem
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_TYPE
The standard component type. |
Fields inherited from class org.omnifaces.component.tree.TreeFamily |
---|
COMPONENT_FAMILY |
Fields inherited from class javax.faces.component.UIComponent |
---|
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY |
Constructor Summary | |
---|---|
TreeNode()
|
Method Summary | |
---|---|
java.lang.Integer |
getLevel()
Returns the level for which this node should render the items. |
protected void |
process(javax.faces.context.FacesContext context,
javax.faces.event.PhaseId phaseId)
This method is by design only called by Tree.processTreeNode(FacesContext, PhaseId) as it maintains all
the nodes. |
void |
setLevel(java.lang.Integer level)
Sets the level for which this node should render the items. |
protected void |
validateHierarchy()
Validate the component hierarchy. |
Methods inherited from class org.omnifaces.component.tree.TreeFamily |
---|
encodeChildren, getFamily, getRendersChildren, processDecodes, processSuper, processUpdates, processValidators |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent, visitTree |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public TreeNode()
Method Detail |
---|
protected void validateHierarchy()
validateHierarchy
in class TreeFamily
java.lang.IllegalArgumentException
- When the direct parent component isn't of type Tree
.protected void process(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId)
Tree.processTreeNode(FacesContext, PhaseId)
as it maintains all
the nodes.
process
in class TreeFamily
context
- The faces context to work with.phaseId
- The current phase ID.Tree.processTreeNode(FacesContext, PhaseId)
public java.lang.Integer getLevel()
public void setLevel(java.lang.Integer level)
level
- The level for which this node should render the items.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |