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.component.TransientStateHolder
,javax.faces.event.ComponentSystemEventListener
,javax.faces.event.FacesListener
,javax.faces.event.SystemEventListenerHolder
@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 templatecomponent.stg
with classReloadTagDeclaration
.
-
-
Field Summary
Fields Modifier and Type Field Description static String
COMPONENT_FAMILY
static String
COMPONENT_TYPE
-
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(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, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, 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, 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:
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
public Integer getFrequency()
Time in milliseconds after which the parent component is automatically reloaded.
Default:5000
- Specified by:
getFrequency
in classAbstractUIReload
-
setFrequency
public void setFrequency(Integer frequency)
-
restoreState
public void restoreState(javax.faces.context.FacesContext context, Object state)
- Specified by:
restoreState
in interfacejavax.faces.component.StateHolder
- Overrides:
restoreState
in classjavax.faces.component.UIComponentBase
-
-