org.apache.myfaces.trinidad.component

## Class UIXPoll

- java.lang.Object
- - javax.faces.component.UIComponent
  - - org.apache.myfaces.trinidad.component.UIXComponent
    - - org.apache.myfaces.trinidad.component.UIXComponentBase
      - - org.apache.myfaces.trinidad.component.UIXPoll

- All Implemented Interfaces:
    javax.faces.component.StateHolder
  Direct Known Subclasses:
    CorePoll

      public class UIXPoll
      extends UIXComponentBase

  The poll component initiates poll to the server.

  #### Events:

  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

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static String` | `COMPONENT_FAMILY`
    `static 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`

    - ### Fields inherited from class javax.faces.component.UIComponent

      `bindings`

  - ### Constructor Summary

    Constructors
    Modifier | Constructor and Description
    --- | ---
    `` | `UIXPoll()` Construct an instance of the UIXPoll.
    `protected` | `UIXPoll(String rendererType)` Construct an instance of the UIXPoll.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `addPollListener(PollListener listener)` Adds a poll listener.
    `void` | `broadcast(javax.faces.event.FacesEvent event)`
    `protected FacesBean.Type` | `getBeanType()`
    `String` | `getFamily()`
    `javax.el.MethodExpression` | `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 binding)` Deprecated.
    `void` | `setPollListener(javax.el.MethodExpression pollListener)` Sets a method reference to a poll listener

    - ### Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

      `adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl`

    - ### Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

      `addPartialTarget, clearCachedClientIds, clearCachedClientIds, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitChildren, visitTree, visitTree`

    - ### Methods inherited from class javax.faces.component.UIComponent

      `encodeAll, getContainerClientId`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Field Detail

    - #### TYPE

          public static final FacesBean.Type TYPE

    - #### IMMEDIATE_KEY

          public static final PropertyKey IMMEDIATE_KEY

    - #### POLL_LISTENER_KEY

          public static final PropertyKey POLL_LISTENER_KEY

    - #### COMPONENT_FAMILY

          public static final String COMPONENT_FAMILY

      See Also:
        Constant Field Values

    - #### COMPONENT_TYPE

          public static final String COMPONENT_TYPE

      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### UIXPoll

          public UIXPoll()

      Construct an instance of the UIXPoll.

    - #### UIXPoll

          protected UIXPoll(String rendererType)

      Construct an instance of the UIXPoll.

  - ### Method Detail

    - #### setPollListener

          @Deprecated
          public void setPollListener(javax.faces.el.MethodBinding binding)

      Deprecated.

    - #### broadcast

          public void broadcast(javax.faces.event.FacesEvent event)
                         throws javax.faces.event.AbortProcessingException

      Overrides:
        `broadcast` in class `UIXComponentBase`
      Throws:
        `javax.faces.event.AbortProcessingException`

    - #### queueEvent

          public void queueEvent(javax.faces.event.FacesEvent e)

      Overrides:
        `queueEvent` in class `UIXComponentBase`

    - #### isImmediate

          public final boolean isImmediate()

      Gets whether data validation should be skipped when poll events are generated by this component. When immediate is false (the default), events will be delivered during the Invoke Application phase, which will trigger validation. When set to true, events will be executed during the Apply Request Values phase.
      Returns:
        the new immediate value

    - #### setImmediate

          public final void setImmediate(boolean immediate)

      Sets whether data validation should be skipped when poll events are generated by this component. When immediate is false (the default), events will be delivered during the Invoke Application phase, which will trigger validation. When set to true, events will be executed during the Apply Request Values phase.
      Parameters:
        `immediate` - the new immediate value

    - #### getPollListener

          public final javax.el.MethodExpression getPollListener()

      Gets a method reference to a poll listener
      Returns:
        the new pollListener value

    - #### setPollListener

          public final void setPollListener(javax.el.MethodExpression pollListener)

      Sets a method reference to a poll listener
      Parameters:
        `pollListener` - the new pollListener value

    - #### addPollListener

          public final void addPollListener(PollListener listener)

      Adds a poll listener.
      Parameters:
        `listener` - the poll listener to add

    - #### removePollListener

          public final void removePollListener(PollListener listener)

      Removes a poll listener.
      Parameters:
        `listener` - the poll listener to remove

    - #### getPollListeners

          public final PollListener[] getPollListeners()

      Returns an array of attached poll listeners.
      Returns:
        an array of attached poll listeners.

    - #### getFamily

          public String getFamily()

      Specified by:
        `getFamily` in class `UIXComponentBase`

    - #### getBeanType

          protected FacesBean.Type getBeanType()

      Overrides:
        `getBeanType` in class `UIXComponentBase`

Copyright © 2001-2016 The Apache Software Foundation. All Rights Reserved.