org.apache.myfaces.tobago.component
Class UIReload

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by org.apache.myfaces.tobago.component.UIReload
All Implemented Interfaces:
StateHolder

public class UIReload
extends UIComponentBase

Update the parent component UIComponent class, generated from template component1.2.stg with class org.apache.myfaces.tobago.internal.taglib.component.ReloadTagDeclaration.


Field Summary
static String COMPONENT_FAMILY
           
static String COMPONENT_TYPE
           
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Constructor Summary
UIReload()
           
 
Method Summary
 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(FacesContext context, Object componentState)
           
 Object saveState(FacesContext context)
           
 void setFrequency(Integer frequency)
           
 void setImmediate(boolean immediate)
           
 void setUpdate(boolean update)
           
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId, getValueExpression, setValueExpression
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY
See Also:
Constant Field Values
Constructor Detail

UIReload

public UIReload()
Method Detail

getFamily

public String getFamily()
Specified by:
getFamily in class UIComponent

isUpdate

public boolean isUpdate()
Is update required.
Default: true


setUpdate

public void setUpdate(boolean update)

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)

getFrequency

public Integer getFrequency()
Time in milliseconds after which the parent component is automatically reloaded.
Default: 5000


setFrequency

public void setFrequency(Integer frequency)

restoreState

public void restoreState(FacesContext context,
                         Object componentState)
Specified by:
restoreState in interface StateHolder
Overrides:
restoreState in class UIComponentBase

saveState

public Object saveState(FacesContext context)
Specified by:
saveState in interface StateHolder
Overrides:
saveState in class UIComponentBase


Copyright © 2002-2011 Apache Software Foundation. All Rights Reserved.