|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXPoll
public class UIXPoll
The poll component initiates poll to the server.
Type | Phases | Description |
---|---|---|
org.apache.myfaces.trinidad.event.PollEvent |
Apply Request Values Invoke Application |
Event delivered when the poll component polls the server. |
org.apache.myfaces.trinidad.event.AttributeChangeEvent |
Invoke Application Apply Request Values |
Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing. |
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_FAMILY
|
static java.lang.String |
COMPONENT_TYPE
|
static PropertyKey |
IMMEDIATE_KEY
|
static PropertyKey |
POLL_LISTENER_KEY
|
static FacesBean.Type |
TYPE
|
Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
---|
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY |
Constructor Summary | |
---|---|
|
UIXPoll()
Construct an instance of the UIXPoll. |
protected |
UIXPoll(java.lang.String rendererType)
Construct an instance of the UIXPoll. |
Method Summary | |
---|---|
void |
addPollListener(PollListener listener)
Adds a poll listener. |
void |
broadcast(javax.faces.event.FacesEvent event)
|
protected FacesBean.Type |
getBeanType()
|
java.lang.String |
getFamily()
|
javax.faces.el.MethodBinding |
getPollListener()
Gets a method reference to a poll listener |
PollListener[] |
getPollListeners()
Returns an array of attached poll listeners. |
boolean |
isImmediate()
Gets whether data validation should be skipped when poll events are generated by this component. |
void |
queueEvent(javax.faces.event.FacesEvent e)
|
void |
removePollListener(PollListener listener)
Removes a poll listener. |
void |
setImmediate(boolean immediate)
Sets whether data validation should be skipped when poll events are generated by this component. |
void |
setPollListener(javax.faces.el.MethodBinding pollListener)
Sets a method reference to a poll listener |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final FacesBean.Type TYPE
public static final PropertyKey IMMEDIATE_KEY
public static final PropertyKey POLL_LISTENER_KEY
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public UIXPoll()
protected UIXPoll(java.lang.String rendererType)
Method Detail |
---|
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
broadcast
in class UIXComponentBase
javax.faces.event.AbortProcessingException
public void queueEvent(javax.faces.event.FacesEvent e)
queueEvent
in class UIXComponentBase
public final boolean isImmediate()
public final void setImmediate(boolean immediate)
immediate
- the new immediate valuepublic final javax.faces.el.MethodBinding getPollListener()
public final void setPollListener(javax.faces.el.MethodBinding pollListener)
pollListener
- the new pollListener valuepublic final void addPollListener(PollListener listener)
listener
- the poll listener to addpublic final void removePollListener(PollListener listener)
listener
- the poll listener to removepublic final PollListener[] getPollListeners()
public java.lang.String getFamily()
getFamily
in class UIXComponentBase
protected FacesBean.Type getBeanType()
getBeanType
in class UIXComponentBase
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |