Module jakarta.faces

Package com.sun.faces.facelets.component

Class UIRepeat

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

jakarta.faces.component.UINamingContainer

com.sun.faces.facelets.component.UIRepeat

All Implemented Interfaces:

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

public class UIRepeat
extends UINamingContainer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT_FAMILY
static final String	COMPONENT_TYPE

Fields inherited from class jakarta.faces.component.UINamingContainer

SEPARATOR_CHAR_PARAM_NAME

Fields inherited from class jakarta.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY

Fields inherited from interface jakarta.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor	Description
UIRepeat()

Method Summary

Modifier and Type	Method	Description
void	broadcast(FacesEvent event)	Broadcast the specified FacesEvent to all registered event listeners who have expressed an interest in events of this type.
void	encodeChildren(FacesContext faces)	If our rendered property is true, render the child UIComponents of this UIComponent.
Integer	getBegin()
String	getClientId(FacesContext faces)	Return a client-side identifier for this component, generating one if necessary.
Integer	getEnd()
String	getFamily()	Return the identifier of the component family to which this component belongs.
Integer	getOffset()
boolean	getRendersChildren()	Return a flag indicating whether this component is responsible for rendering its child components.
Integer	getSize()
Integer	getStep()
Object	getValue()
String	getVar()
String	getVarStatus()
boolean	invokeOnComponent(FacesContext faces, String clientId, ContextCallback callback)	Starting at this component in the View hierarchy, search for a component with a clientId equal to the argument clientId and, if found, call the ContextCallback.invokeContextCallback(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent) method on the argument callback, passing the current FacesContext and the found component as arguments.
boolean	isRowStatePreserved()	Returns whether row state is preserved as per setRowStatePreserved(boolean).
void	markInitialState()	Override the base class method to take special action if the method is being invoked when StateManager.IS_BUILDING_INITIAL_STATE is true and the rowStatePreserved property for this instance is true.
void	process(FacesContext faces, PhaseId phase)
void	processDecodes(FacesContext faces)	Perform the component tree processing required by the Apply Request Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows.
void	processUpdates(FacesContext faces)	Perform the component tree processing required by the Update Model Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows.
void	processValidators(FacesContext faces)	Perform the component tree processing required by the Process Validations phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows.
void	queueEvent(FacesEvent event)	Queue an event for broadcast at the end of the current request processing lifecycle phase.
void	restoreState(FacesContext faces, Object object)	Perform any processing required to restore the state from the entries in the state Object.
Object	saveState(FacesContext faces)	Gets the state of the instance as a Serializable Object.
void	setBegin(Integer begin)
void	setEnd(Integer end)
void	setOffset(Integer offset)
void	setRowStatePreserved(boolean rowStatePreserved)	Boolean flag directing how the per-row component state of EditableValueHolder children should be handled across requests on the same view.
void	setSize(Integer size)
void	setStep(Integer step)
void	setValue(Object value)
void	setVar(String var)
void	setVarStatus(String varStatus)
boolean	visitTree(VisitContext context, VisitCallback callback)	Perform a tree visit starting at this node in the tree.

Methods inherited from class jakarta.faces.component.UINamingContainer

createUniqueId, getSeparatorChar

Methods inherited from class jakarta.faces.component.UIComponentBase

addClientBehavior, addFacesListener, clearInitialState, decode, encodeBegin, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, 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

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.faces.component.StateHolder

isTransient, setTransient

Field Details

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

• Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

• Constant Field Values

Constructor Details

UIRepeat

public UIRepeat()

Method Details

getFamily

public String getFamily()

Description copied from class: UIComponent

Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null

Overrides:

getFamily in class UINamingContainer

Returns:

the component family (not null).

setEnd

public void setEnd(Integer end)

getEnd

public Integer getEnd()

setSize

public void setSize(Integer size)

getSize

public Integer getSize()

setOffset

public void setOffset(Integer offset)

getOffset

public Integer getOffset()

setBegin

public void setBegin(Integer begin)

getBegin

public Integer getBegin()

setStep

public void setStep(Integer step)

getStep

public Integer getStep()

setRowStatePreserved

public void setRowStatePreserved(boolean rowStatePreserved)

Boolean flag directing how the per-row component state of EditableValueHolder children should be handled across requests on the same view. If set to true, then state for EditableValueHolder components in each row will not be discarded before a new row is rendered. If not specified, the default value is false.

This attribute should be set only when the current repeat component contains UIForm children which in turn contains EditableValueHolder children. This will only work reliably when the data model of the current repeat component does not change across requests on the same view by e.g. sorting, adding or removing rows. The alternative is to use c:forEach instead.

Parameters:

rowStatePreserved - Whether to preserve row state while rendering

Since:

4.1

isRowStatePreserved

public boolean isRowStatePreserved()

Returns whether row state is preserved as per setRowStatePreserved(boolean).

Returns:

Whether row state is preserved.

Since:

4.1

getVar

public String getVar()

setVar

public void setVar(String var)

getVarStatus

public String getVarStatus()

setVarStatus

public void setVarStatus(String varStatus)

getValue

public Object getValue()

setValue

public void setValue(Object value)

getClientId

public String getClientId(FacesContext faces)

Description copied from class: UIComponent

Return a client-side identifier for this component, generating one if necessary. The associated Renderer, if any, will be asked to convert the clientId to a form suitable for transmission to the client.

The return from this method must be the same value throughout the lifetime of the instance, unless the id property of the component is changed, or the component is placed in a NamingContainer whose client ID changes (for example, UIData). However, even in these cases, consecutive calls to this method must always return the same value. The implementation must follow these steps in determining the clientId:

Find the closest ancestor to this component in the view hierarchy that implements NamingContainer. Call getContainerClientId() on it and save the result as the parentId local variable. Call UIComponent.getId() on this component and save the result as the myId local variable. If myId is null, call context.getViewRoot().createUniqueId() and assign the result to myId. If parentId is non-null, let myId equal parentId + UINamingContainer.getSeparatorChar(jakarta.faces.context.FacesContext) + myId. Call Renderer.convertClientId(jakarta.faces.context.FacesContext, java.lang.String), passing myId, and return the result.

Overrides:

getClientId in class UIComponentBase

Parameters:

faces - The FacesContext for the current request

Returns:

the client id.

process

public void process(FacesContext faces,
 PhaseId phase)

invokeOnComponent

public boolean invokeOnComponent(FacesContext faces,
 String clientId,
 ContextCallback callback)
                          throws FacesException

Description copied from class: UIComponentBase

Starting at this component in the View hierarchy, search for a component with a clientId equal to the argument clientId and, if found, call the ContextCallback.invokeContextCallback(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent) method on the argument callback, passing the current FacesContext and the found component as arguments. This method is similar to UIComponent.findComponent(java.lang.String) but it does not support the leading UINamingContainer.getSeparatorChar(jakarta.faces.context.FacesContext) syntax for searching from the root of the View.

The default implementation will first check if this.getClientId() is equal to the argument clientId. If so, first call UIComponent.pushComponentToEL(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent), then call the ContextCallback.invokeContextCallback(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent) method on the argument callback, passing through the FacesContext argument and passing this as the component argument. Then call UIComponent.popComponentFromEL(jakarta.faces.context.FacesContext). If an Exception is thrown by the callback, wrap it in a FacesException and re-throw it. Otherwise, return true.

Otherwise, for each component returned by UIComponent.getFacetsAndChildren(), call invokeOnComponent() passing the arguments to this method, in order. The first time invokeOnComponent() returns true, abort traversing the rest of the Iterator and return true.

When calling ContextCallback.invokeContextCallback(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent) the implementation of this method must guarantee that the state of the component passed to the callback correctly reflects the component's position in the View hierarchy with respect to any state found in the argument clientId. For example, an iterating component such as UIData will need to set its row index to correctly reflect the argument clientId before finding the appropriate child component backed by the correct row. When the callback returns, either normally or by throwing an Exception the implementation of this method must restore the state of the view to the way it was before invoking the callback.

If none of the elements from UIComponent.getFacetsAndChildren() returned true from invokeOnComponent(), return false.

Simple usage example to find a component by clientId.

 
    private UIComponent found = null;

    private void doFind(FacesContext context, String clientId) {
      context.getViewRoot().invokeOnComponent(context, clientId,
          new ContextCallback() {
             public void invokeContextCallback(FacesContext context,
                                           UIComponent component) {
               found = component;
             }
          });
    }
 
 

Overrides:

invokeOnComponent in class UIComponentBase

Parameters:

faces - the FacesContext for the current request

clientId - the client identifier of the component to be passed to the argument callback.

callback - an implementation of the Callback interface.

Returns:

true if the a component with the given clientId is found, the callback method was successfully invoked passing that component as an argument, and no Exception was thrown. Returns false if no component with the given clientId is found.

Throws:

FacesException - if the argument Callback throws an Exception, it is wrapped in a FacesException and re-thrown.

visitTree

public boolean visitTree(VisitContext context,
 VisitCallback callback)

Description copied from class: UIComponent

Perform a tree visit starting at this node in the tree.

UIComponent.visitTree() implementations do not invoke the VisitCallback directly, but instead call VisitContext.invokeVisitCallback(jakarta.faces.component.UIComponent, jakarta.faces.component.visit.VisitCallback) to invoke the callback. This allows VisitContext implementations to provide optimized tree traversals, for example by only calling the VisitCallback for a subset of components.

UIComponent.visitTree() implementations must call UIComponent.pushComponentToEL() before performing the visit and UIComponent.popComponentFromEL() after the visit.

Overrides:

visitTree in class UINamingContainer

Parameters:

context - the VisitContext for this visit

callback - the VisitCallback instance whose visit method will be called for each node visited.

Returns:

true if tree should be visited, false otherwise.

See Also:

• UIComponent.visitTree(jakarta.faces.component.visit.VisitContext, jakarta.faces.component.visit.VisitCallback)

processDecodes

public void processDecodes(FacesContext faces)

Description copied from class: UIComponent

Perform the component tree processing required by the Apply Request Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows.

• If the rendered property of this UIComponent is false, skip further processing.
• Call UIComponent.pushComponentToEL(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent).
• Call the processDecodes() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren().
• Call the decode() method of this component.
• Call UIComponent.popComponentFromEL(jakarta.faces.context.FacesContext) from inside of a finally block, just before returning.
• If a RuntimeException is thrown during decode processing, call FacesContext.renderResponse() and re-throw the exception.

Overrides:

processDecodes in class UIComponentBase

Parameters:

faces - FacesContext for the request we are processing

processUpdates

public void processUpdates(FacesContext faces)

Description copied from class: UIComponent

Perform the component tree processing required by the Update Model Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows.

• If the rendered property of this UIComponent is false, skip further processing.
• Call UIComponent.pushComponentToEL(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent).
• Call the processUpdates() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). After returning from the processUpdates() method on a child or facet, call UIComponent.popComponentFromEL(jakarta.faces.context.FacesContext)

Overrides:

processUpdates in class UIComponentBase

Parameters:

faces - FacesContext for the request we are processing

processValidators

public void processValidators(FacesContext faces)

Description copied from class: UIComponent

Perform the component tree processing required by the Process Validations phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows.

• If the rendered property of this UIComponent is false, skip further processing.
• Call UIComponent.pushComponentToEL(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent).
• Call the processValidators() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren().
• After returning from calling getFacetsAndChildren() call UIComponent.popComponentFromEL(jakarta.faces.context.FacesContext).

Overrides:

processValidators in class UIComponentBase

Parameters:

faces - FacesContext for the request we are processing

See Also:

• PreValidateEvent
• PostValidateEvent

broadcast

public void broadcast(FacesEvent event)
               throws AbortProcessingException

Description copied from class: UIComponent

Broadcast the specified FacesEvent to all registered event listeners who have expressed an interest in events of this type. Listeners are called in the order in which they were added.

If the event is an instance of BehaviorEvent and the current component is the source of the event call BehaviorEvent.getBehavior() to get the Behavior for the event. Call Behavior.broadcast(jakarta.faces.event.BehaviorEvent) on the Behavior instance.

Overrides:

broadcast in class UIComponentBase

Parameters:

event - The FacesEvent to be broadcast

Throws:

AbortProcessingException - Signal the Jakarta Faces implementation that no further processing on the current event should be performed

queueEvent

public void queueEvent(FacesEvent event)

Description copied from class: UIComponent

Queue an event for broadcast at the end of the current request processing lifecycle phase. The default implementation in UIComponentBase must delegate this call to the queueEvent() method of the parent UIComponent.

Overrides:

queueEvent in class UIComponentBase

Parameters:

event - FacesEvent to be queued

markInitialState

public void markInitialState()

Override the base class method to take special action if the method is being invoked when StateManager.IS_BUILDING_INITIAL_STATE is true and the rowStatePreserved property for this instance is true.

The additional action taken is to traverse the descendents and save their state without regard to any particular row value.

Specified by:

markInitialState in interface PartialStateHolder

Overrides:

markInitialState in class UIComponentBase

Since:

4.1

restoreState

public void restoreState(FacesContext faces,
 Object object)

Description copied from interface: StateHolder

Perform any processing required to restore the state from the entries in the state Object.

If the class that implements this interface has references to instances that also implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the StateHolder.restoreState(jakarta.faces.context.FacesContext, java.lang.Object) method on all those instances as well.

If the state argument is null, take no action and return.

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class UIComponentBase

Parameters:

faces - the Faces context.

object - the state.

saveState

public Object saveState(FacesContext faces)

Description copied from interface: StateHolder

Gets the state of the instance as a Serializable Object.

If the class that implements this interface has references to instances that implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the StateHolder.saveState(jakarta.faces.context.FacesContext) method on all those instances as well. This method must not save the state of children and facets. That is done via the StateManager

This method must not alter the state of the implementing object. In other words, after executing this code:

 
 Object state = component.saveState(facesContext);
 
 

component should be the same as before executing it.

The return from this method must be Serializable

Specified by:

saveState in interface StateHolder

Overrides:

saveState in class UIComponentBase

Parameters:

faces - the Faces context.

Returns:

the saved state.

encodeChildren

public void encodeChildren(FacesContext faces)
                    throws IOException

Description copied from class: UIComponent

If our rendered property is true, render the child UIComponents of this UIComponent. This method will only be called if the rendersChildren property is true.

If a Renderer is associated with this UIComponent, the actual encoding will be delegated to Renderer.encodeChildren(FacesContext, UIComponent). If no Renderer is associated with this UIComponent, iterate over each of the children of this component and call UIComponent.encodeAll(jakarta.faces.context.FacesContext).

Overrides:

encodeChildren in class UIComponentBase

Parameters:

faces - FacesContext for the response we are creating

Throws:

IOException - if an input/output error occurs while rendering

getRendersChildren

public boolean getRendersChildren()

Description copied from class: UIComponent

Return a flag indicating whether this component is responsible for rendering its child components. The default implementation in UIComponentBase.getRendersChildren() tries to find the renderer for this component. If it does, it calls Renderer.getRendersChildren() and returns the result. If it doesn't, it returns false. As of version 1.2 of the Jakarta Faces Specification, component authors are encouraged to return true from this method and rely on UIComponentBase.encodeChildren(jakarta.faces.context.FacesContext).

Overrides:

getRendersChildren in class UIComponentBase

Returns:

true if the component renders its children, false otherwise.