oracle.adf.view.faces.component
Class UIXProgress

java.lang.Object
  javax.faces.component.UIComponent
      oracle.adf.view.faces.component.UIXComponent
          oracle.adf.view.faces.component.UIXComponentBase
              oracle.adf.view.faces.component.UIXProgress

All Implemented Interfaces:

ActionSource, StateHolder

Direct Known Subclasses:

CoreProgressIndicator

public class UIXProgress

extends UIXComponentBase

implements ActionSource

UIXProgress is a base abstraction for components that implement ActionSource and indicate the progress of tasks running in the server, typically navigating to a special page once the task is complete. When the task is complete, an ActionEvent is delivered.

Events:

Type	Phases	Description
javax.faces.event.ActionEvent	Any Phase Invoke Application	Event delivered when the task is complete. The completeness of the task is usually determined from state of the model attached to the progress component.

Field Summary

static PropertyKey	ACTION_KEY
static PropertyKey	ACTION_LISTENER_KEY
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static PropertyKey	IMMEDIATE_KEY
static FacesBean.Type	TYPE
static PropertyKey	VALUE_KEY

Fields inherited from class oracle.adf.view.faces.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Constructor Summary

	UIXProgress() Construct an instance of the UIXProgress.
protected	UIXProgress(java.lang.String rendererType) Construct an instance of the UIXProgress.

Method Summary

void	addActionListener(ActionListener listener)
void	broadcast(FacesEvent event)
MethodBinding	getAction() Gets A reference to an action method sent by the progress component, or the static outcome of an action.
MethodBinding	getActionListener() Gets A method reference to an action listener.
ActionListener[]	getActionListeners()
protected FacesBean.Type	getBeanType()
java.lang.String	getFamily()
java.lang.Object	getValue() Gets The data model being used by this progress component.
boolean	isImmediate() Gets whether or not data validation - client-side or server-side - should take place when events are generated by this component.
void	queueEvent(FacesEvent e)
void	removeActionListener(ActionListener listener)
void	setAction(MethodBinding action) Sets A reference to an action method sent by the progress component, or the static outcome of an action.
void	setActionListener(MethodBinding actionListener) Sets A method reference to an action listener.
void	setImmediate(boolean immediate) Sets whether or not data validation - client-side or server-side - should take place when events are generated by this component.
void	setValue(java.lang.Object value) Sets The data model being used by this progress component.

Methods inherited from class oracle.adf.view.faces.component.UIXComponentBase

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

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

VALUE_KEY

public static final PropertyKey VALUE_KEY

ACTION_KEY

public static final PropertyKey ACTION_KEY

ACTION_LISTENER_KEY

public static final PropertyKey ACTION_LISTENER_KEY

IMMEDIATE_KEY

public static final PropertyKey IMMEDIATE_KEY

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

UIXProgress

public UIXProgress()

Construct an instance of the UIXProgress.

UIXProgress

protected UIXProgress(java.lang.String rendererType)

Construct an instance of the UIXProgress.

Method Detail

addActionListener

public void addActionListener(ActionListener listener)

Specified by:

addActionListener in interface ActionSource

removeActionListener

public void removeActionListener(ActionListener listener)

Specified by:

removeActionListener in interface ActionSource

getActionListeners

public ActionListener[] getActionListeners()

Specified by:

getActionListeners in interface ActionSource

queueEvent

public void queueEvent(FacesEvent e)

Overrides:

queueEvent in class UIXComponentBase

broadcast

public void broadcast(FacesEvent event)
               throws AbortProcessingException

Overrides:

broadcast in class UIXComponentBase

Throws:

AbortProcessingException

getValue

public final java.lang.Object getValue()

Gets The data model being used by this progress component. The model should be of type oracle.adf.view.faces.model.BoundedRangeModel.

setValue

public final void setValue(java.lang.Object value)

Sets The data model being used by this progress component. The model should be of type oracle.adf.view.faces.model.BoundedRangeModel.

getAction

public final MethodBinding getAction()

Gets A reference to an action method sent by the progress component, or the static outcome of an action. This is invoked when the task under progress is complete.

Specified by:

getAction in interface ActionSource

setAction

public final void setAction(MethodBinding action)

Sets A reference to an action method sent by the progress component, or the static outcome of an action. This is invoked when the task under progress is complete.

Specified by:

setAction in interface ActionSource

getActionListener

public final MethodBinding getActionListener()

Gets A method reference to an action listener. This is invoked after the task in progress is complete.

Specified by:

getActionListener in interface ActionSource

setActionListener

public final void setActionListener(MethodBinding actionListener)

Sets A method reference to an action listener. This is invoked after the task in progress is complete.

Specified by:

setActionListener in interface ActionSource

isImmediate

public final boolean isImmediate()

Gets whether or not data validation - client-side or server-side - should take place when events are generated by this component. When immediate is true, the default ActionListener provided by the JavaServer Faces implementation should be executed during Apply Request Values phase of the request processing lifecycle, rather than waiting until the Invoke Application phase.

Specified by:

isImmediate in interface ActionSource

setImmediate

public final void setImmediate(boolean immediate)

Sets whether or not data validation - client-side or server-side - should take place when events are generated by this component. When immediate is true, the default ActionListener provided by the JavaServer Faces implementation should be executed during Apply Request Values phase of the request processing lifecycle, rather than waiting until the Invoke Application phase.

Specified by:

setImmediate in interface ActionSource

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class UIXComponentBase

getBeanType

protected FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIXComponentBase