Class 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 AbstractUIReload
    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

      Fields 
      Modifier and Type Field Description
      static String COMPONENT_FAMILY  
      static String COMPONENT_TYPE  
      • Fields 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 
      Constructor Description
      UIReload()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String getFamily()  
      Integer getFrequency()
      Time in milliseconds after which the parent component is automatically reloaded.
      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.
      boolean isUpdate()
      Is update required.
      void restoreState​(jakarta.faces.context.FacesContext context, Object state)  
      void setFrequency​(Integer frequency)  
      void setImmediate​(boolean immediate)  
      void setUpdate​(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
    • Constructor Detail

      • UIReload

        public UIReload()
    • Method Detail

      • getFamily

        public String getFamily()
        Specified by:
        getFamily in class jakarta.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:
        isUpdate in class AbstractUIReload
      • 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:
        getFrequency in class AbstractUIReload
      • setFrequency

        public void setFrequency​(Integer frequency)
      • restoreState

        public void restoreState​(jakarta.faces.context.FacesContext context,
                                 Object state)
        Specified by:
        restoreState in interface jakarta.faces.component.StateHolder
        Overrides:
        restoreState in class jakarta.faces.component.UIComponentBase