Class UIReload
java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
org.apache.myfaces.tobago.internal.component.AbstractUIReload
org.apache.myfaces.tobago.component.UIReload
- All Implemented Interfaces:
EventListener
,javax.faces.component.PartialStateHolder
,javax.faces.component.StateHolder
,javax.faces.event.ComponentSystemEventListener
,javax.faces.event.FacesListener
,javax.faces.event.SystemEventListenerHolder
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 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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionTime in milliseconds after which the parent component is automatically reloaded.boolean
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
(javax.faces.context.FacesContext context, Object state) void
setFrequency
(Integer frequency) void
setImmediate
(boolean immediate) void
setUpdate
(boolean update) Methods inherited from class javax.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, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree
Methods inherited from class javax.faces.component.UIComponent
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
-
Field Details
-
COMPONENT_TYPE
-
COMPONENT_FAMILY
- See Also:
-
-
Constructor Details
-
UIReload
public UIReload()
-
-
Method Details
-
getFamily
- Specified by:
getFamily
in classjavax.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 classAbstractUIReload
-
setUpdate
public void setUpdate(boolean update) -
getFrequency
Time in milliseconds after which the parent component is automatically reloaded.
Default:5000
- Specified by:
getFrequency
in classAbstractUIReload
-
setFrequency
-
restoreState
- Specified by:
restoreState
in interfacejavax.faces.component.StateHolder
- Overrides:
restoreState
in classjavax.faces.component.UIComponentBase
-