|
|||||||||
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
public abstract class TreeFamily
Base class which is to be shared between all components of the Tree family.
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_FAMILY
The standard 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 | |
---|---|
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 | |
---|---|
void |
encodeChildren(javax.faces.context.FacesContext context)
Calls validateHierarchy() and then process(FacesContext, PhaseId) with
PhaseId.RENDER_RESPONSE . |
java.lang.String |
getFamily()
Returns COMPONENT_FAMILY . |
boolean |
getRendersChildren()
Returns true . |
protected abstract void |
process(javax.faces.context.FacesContext context,
javax.faces.event.PhaseId phaseId)
Process the component according to the rules of the given phase ID. |
void |
processDecodes(javax.faces.context.FacesContext context)
Calls validateHierarchy() and then process(FacesContext, PhaseId) with
PhaseId.APPLY_REQUEST_VALUES . |
protected void |
processSuper(javax.faces.context.FacesContext context,
javax.faces.event.PhaseId phaseId)
Helper method to delegate the processing further to the UIComponentBase superclass which will handle
all children. |
void |
processUpdates(javax.faces.context.FacesContext context)
Calls process(FacesContext, PhaseId) with PhaseId.UPDATE_MODEL_VALUES . |
void |
processValidators(javax.faces.context.FacesContext context)
Calls process(FacesContext, PhaseId) with PhaseId.PROCESS_VALIDATIONS . |
protected abstract void |
validateHierarchy()
Validate the component hierarchy. |
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_FAMILY
Constructor Detail |
---|
public TreeFamily()
null
as the components of the Tree family does not
render anything by themselves.
Method Detail |
---|
public java.lang.String getFamily()
COMPONENT_FAMILY
.
getFamily
in class javax.faces.component.UIComponent
public boolean getRendersChildren()
true
.
getRendersChildren
in class javax.faces.component.UIComponentBase
public void processDecodes(javax.faces.context.FacesContext context)
validateHierarchy()
and then process(FacesContext, PhaseId)
with
PhaseId.APPLY_REQUEST_VALUES
.
processDecodes
in class javax.faces.component.UIComponentBase
public void processValidators(javax.faces.context.FacesContext context)
process(FacesContext, PhaseId)
with PhaseId.PROCESS_VALIDATIONS
.
processValidators
in class javax.faces.component.UIComponentBase
public void processUpdates(javax.faces.context.FacesContext context)
process(FacesContext, PhaseId)
with PhaseId.UPDATE_MODEL_VALUES
.
processUpdates
in class javax.faces.component.UIComponentBase
public void encodeChildren(javax.faces.context.FacesContext context) throws java.io.IOException
validateHierarchy()
and then process(FacesContext, PhaseId)
with
PhaseId.RENDER_RESPONSE
.
encodeChildren
in class javax.faces.component.UIComponentBase
java.io.IOException
protected abstract void validateHierarchy() throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
- When component hierarchy is wrong.protected abstract void process(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId)
context
- The faces context to work with.phaseId
- The current phase ID.protected void processSuper(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId)
UIComponentBase
superclass which will handle
all children.
context
- The faces context to work with.phaseId
- The current phase ID.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |