org.richfaces.component
Class UIPoll

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UICommand
              extended by org.richfaces.component.AbstractActionComponent
                  extended by org.richfaces.component.AbstractPoll
                      extended by org.richfaces.component.UIPoll
All Implemented Interfaces:
EventListener, javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

@Generated(value={"RichFaces CDK","4.0.0-SNAPSHOT"})
public class UIPoll
extends AbstractPoll
implements javax.faces.component.behavior.ClientBehaviorHolder

Component for periodically call AJAX events on server ( poll actions )

Author:
shura

Nested Class Summary
protected static class UIPoll.Properties
           
 
Field Summary
static String COMPONENT_FAMILY
           
static String COMPONENT_TYPE
           
 
Fields inherited from class org.richfaces.component.AbstractPoll
ON_TIMER, TIMER
 
Fields 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
UIPoll()
           
 
Method Summary
 String getDefaultEventName()
           
 Collection<String> getEventNames()
           
 String getFamily()
           
 int getInterval()
           
 String getOnbeforedomupdate()
           
 String getOnbegin()
           
 String getOncomplete()
           
 String getOntimer()
           
 boolean isBypassUpdates()
           
 boolean isEnabled()
           
 void setBypassUpdates(boolean bypassUpdates)
           
 void setEnabled(boolean enabled)
           
 void setInterval(int interval)
           
 void setOnbeforedomupdate(String onbeforedomupdate)
           
 void setOnbegin(String onbegin)
           
 void setOncomplete(String oncomplete)
           
 void setOntimer(String ontimer)
           
 
Methods inherited from class org.richfaces.component.AbstractActionComponent
queueEvent
 
Methods inherited from class javax.faces.component.UICommand
addActionListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, getValue, isImmediate, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, setValue
 
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent, visitTree
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors
 

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

UIPoll

public UIPoll()
Method Detail

getFamily

public String getFamily()
Overrides:
getFamily in class javax.faces.component.UICommand

getEventNames

public Collection<String> getEventNames()
Specified by:
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
getEventNames in class javax.faces.component.UIComponentBase

getDefaultEventName

public String getDefaultEventName()
Specified by:
getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
getDefaultEventName in class javax.faces.component.UIComponentBase

isBypassUpdates

public boolean isBypassUpdates()
Specified by:
isBypassUpdates in class AbstractActionComponent

setBypassUpdates

public void setBypassUpdates(boolean bypassUpdates)
Specified by:
setBypassUpdates in class AbstractActionComponent

isEnabled

public boolean isEnabled()
Specified by:
isEnabled in class AbstractPoll

setEnabled

public void setEnabled(boolean enabled)

getInterval

public int getInterval()
Specified by:
getInterval in class AbstractPoll

setInterval

public void setInterval(int interval)

getOnbeforedomupdate

public String getOnbeforedomupdate()
Specified by:
getOnbeforedomupdate in class AbstractPoll

setOnbeforedomupdate

public void setOnbeforedomupdate(String onbeforedomupdate)

getOnbegin

public String getOnbegin()
Specified by:
getOnbegin in class AbstractPoll

setOnbegin

public void setOnbegin(String onbegin)

getOncomplete

public String getOncomplete()
Specified by:
getOncomplete in class AbstractPoll

setOncomplete

public void setOncomplete(String oncomplete)

getOntimer

public String getOntimer()
Specified by:
getOntimer in class AbstractPoll

setOntimer

public void setOntimer(String ontimer)


Copyright © 2010 JBoss, a division of Red Hat, Inc.. All Rights Reserved.