java.lang.Object
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
org.apache.myfaces.tobago.internal.component.AbstractUIReload
org.apache.myfaces.tobago.component.UIReload
- All Implemented Interfaces:
jakarta.faces.component.PartialStateHolder,jakarta.faces.component.StateHolder,jakarta.faces.component.TransientStateHolder,jakarta.faces.event.ComponentSystemEventListener,jakarta.faces.event.FacesListener,jakarta.faces.event.SystemEventListenerHolder,EventListener
Update the parent component
<br/>
WARNING <br/>
<br/>
This feature is preliminary and may be subject of change in later versions! <br/>
UIComponent class, generated from template
component.stg with class
ReloadTagDeclaration.-
Field Summary
FieldsFields inherited from class jakarta.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionTime in milliseconds after which the parent component is automatically reloaded.booleanFlag indicating that the update check should be performed immediately (that is, during Apply Request Values phase) rather than waiting until Render Response phase.booleanisUpdate()Is update required.voidrestoreState(jakarta.faces.context.FacesContext context, Object state) voidsetFrequency(Integer frequency) voidsetImmediate(boolean immediate) voidsetUpdate(boolean update) Methods inherited from class jakarta.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, visitTreeMethods inherited from class jakarta.faces.component.UIComponent
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
-
Field Details
-
COMPONENT_TYPE
-
COMPONENT_FAMILY
- See Also:
-
-
Constructor Details
-
UIReload
public UIReload()
-
-
Method Details
-
getFamily
- Specified by:
getFamilyin classjakarta.faces.component.UIComponent
-
isImmediate
public boolean isImmediate()Flag indicating that the update check should be performed immediately (that is, during Apply Request Values phase) rather than waiting until Render Response phase.
Default:true -
setImmediate
public void setImmediate(boolean immediate) -
isUpdate
public boolean isUpdate()Is update required.
Default:true- Specified by:
isUpdatein classAbstractUIReload
-
setUpdate
public void setUpdate(boolean update) -
getFrequency
Time in milliseconds after which the parent component is automatically reloaded.
Default:5000- Specified by:
getFrequencyin classAbstractUIReload
-
setFrequency
-
restoreState
- Specified by:
restoreStatein interfacejakarta.faces.component.StateHolder- Overrides:
restoreStatein classjakarta.faces.component.UIComponentBase
-