Class UIReload
- 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
@Generated("component.stg") public class UIReload extends AbstractUIReloadUpdate 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 templatecomponent.stgwith classReloadTagDeclaration.
-
-
Field Summary
Fields Modifier and Type Field Description static StringCOMPONENT_FAMILYstatic StringCOMPONENT_TYPE
-
Constructor Summary
Constructors Constructor Description UIReload()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetFamily()IntegergetFrequency()Time in milliseconds after which the parent component is automatically reloaded.booleanisImmediate()Flag 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, visitTree
-
Methods 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 Detail
-
COMPONENT_TYPE
public static final String COMPONENT_TYPE
-
COMPONENT_FAMILY
public static final String COMPONENT_FAMILY
- See Also:
- Constant Field Values
-
-
Method Detail
-
getFamily
public String 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
public Integer getFrequency()
Time in milliseconds after which the parent component is automatically reloaded.
Default:5000- Specified by:
getFrequencyin classAbstractUIReload
-
setFrequency
public void setFrequency(Integer frequency)
-
restoreState
public void restoreState(jakarta.faces.context.FacesContext context, Object state)- Specified by:
restoreStatein interfacejakarta.faces.component.StateHolder- Overrides:
restoreStatein classjakarta.faces.component.UIComponentBase
-
-