Module org.omnifaces

Package org.omnifaces.component.tree

Class TreeFamily

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

org.omnifaces.component.tree.TreeFamily

All Implemented Interfaces:

PartialStateHolder, StateHolder, TransientStateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder, EventListener

Direct Known Subclasses:

Tree, TreeInsertChildren, TreeNode, TreeNodeItem

public abstract class TreeFamily
extends UIComponentBase

Base class which is to be shared between all components of the Tree family.

Author:

Bauke Scholtz

Field Summary

Fields

Modifier and Type	Field	Description
static String	COMPONENT_FAMILY	The standard component family.

Fields inherited from class jakarta.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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TreeFamily()	The base constructor sets the renderer type to null as the components of the Tree family does not render anything by themselves.

Method Summary

Modifier and Type	Method	Description
void	encodeChildren(FacesContext context)	Calls validateHierarchy(FacesContext) when project stage is Development and then calls process(FacesContext, PhaseId) with PhaseId.RENDER_RESPONSE.
String	getFamily()	Returns COMPONENT_FAMILY.
boolean	getRendersChildren()	Returns true.
protected abstract void	process(FacesContext context, PhaseId phaseId)	Process the component according to the rules of the given phase ID.
void	processDecodes(FacesContext context)	Calls process(FacesContext, PhaseId) with PhaseId.APPLY_REQUEST_VALUES.
protected void	processSuper(FacesContext context, PhaseId phaseId)	Helper method to delegate the processing further to the UIComponentBase superclass which will handle all children.
void	processUpdates(FacesContext context)	Calls process(FacesContext, PhaseId) with PhaseId.UPDATE_MODEL_VALUES.
void	processValidators(FacesContext context)	Calls process(FacesContext, PhaseId) with PhaseId.PROCESS_VALIDATIONS.
protected void	validateHierarchy()	Deprecated, for removal: This API element is subject to removal in a future version. Use validateHierarchy(FacesContext) instead.
protected abstract void	validateHierarchy(FacesContext context)	Validate the component hierarchy.

Methods inherited from class jakarta.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, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class jakarta.faces.component.UIComponent

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

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

The standard component family.

See Also:

Constant Field Values

Constructor Detail

TreeFamily

protected TreeFamily()

The base constructor sets the renderer type to null as the components of the Tree family does not render anything by themselves.

Method Detail

getFamily

public String getFamily()

Returns COMPONENT_FAMILY.

Specified by:

getFamily in class UIComponent

getRendersChildren

public boolean getRendersChildren()

Returns true.

Overrides:

getRendersChildren in class UIComponentBase

processDecodes

public void processDecodes(FacesContext context)

Calls process(FacesContext, PhaseId) with PhaseId.APPLY_REQUEST_VALUES.

Overrides:

processDecodes in class UIComponentBase

processValidators

public void processValidators(FacesContext context)

Calls process(FacesContext, PhaseId) with PhaseId.PROCESS_VALIDATIONS.

Overrides:

processValidators in class UIComponentBase

processUpdates

public void processUpdates(FacesContext context)

Calls process(FacesContext, PhaseId) with PhaseId.UPDATE_MODEL_VALUES.

Overrides:

processUpdates in class UIComponentBase

encodeChildren

public void encodeChildren(FacesContext context)
                    throws IOException

Calls validateHierarchy(FacesContext) when project stage is Development and then calls process(FacesContext, PhaseId) with PhaseId.RENDER_RESPONSE.

Overrides:

encodeChildren in class UIComponentBase

Throws:

IOException

validateHierarchy

@Deprecated(since="4.6",
            forRemoval=true)
protected void validateHierarchy()

Deprecated, for removal: This API element is subject to removal in a future version.

Use validateHierarchy(FacesContext) instead.

Validate the component hierarchy. This should only be called when project stage is Development.

Throws:

IllegalStateException - When component hierarchy is wrong.

validateHierarchy

protected abstract void validateHierarchy(FacesContext context)

Validate the component hierarchy. This should only be called when project stage is Development.

Parameters:

context - The faces context to work with.

Throws:

IllegalStateException - When component hierarchy is wrong.

Since:

4.6

process

protected abstract void process(FacesContext context,
                                PhaseId phaseId)

Process the component according to the rules of the given phase ID.

Parameters:

context - The faces context to work with.

phaseId - The current phase ID.

processSuper

protected void processSuper(FacesContext context,
                            PhaseId phaseId)

Helper method to delegate the processing further to the UIComponentBase superclass which will handle all children.

Parameters:

context - The faces context to work with.

phaseId - The current phase ID.