oracle.adf.view.faces.component
Class UIXProcess

java.lang.Object
  |
  +--javax.faces.component.UIComponent
        |
        +--oracle.adf.view.faces.component.UIXComponent
              |
              +--oracle.adf.view.faces.component.UIXComponentBase
                    |
                    +--oracle.adf.view.faces.component.UIXProcess

All Implemented Interfaces:

javax.faces.component.StateHolder

Direct Known Subclasses:

CoreProcessChoiceBar, CoreProcessTrain

public class UIXProcess

extends UIXComponentBase

UIXProcess is a base abstraction for components which indicate the current page of a multipage process that the user is on. Its children are commandLinks. The commandLinks describe each page in the multipage process: the text, if the page is the current page, and also the action method to navigate to another page.

It does not support any children.

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static PropertyKey	MAX_VISITED_KEY
static FacesBean.Type	TYPE

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

ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Constructor Summary

UIXProcess()
Construct an instance of the UIXProcess.

Method Summary

protected FacesBean.Type	getBeanType()
java.lang.String	getFamily()
int	getMaxVisited() Gets a zero-based index to indicate the highest visited page in the multi-page process.
void	setMaxVisited(int maxVisited) Sets a zero-based index to indicate the highest visited page in the multi-page process.

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

addFacesListener, broadcast, createFacesBean, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttribute, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getIntProperty, getLocalClientId, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreState, saveState, setAttribute, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, toString

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

MAX_VISITED_KEY

public static final PropertyKey MAX_VISITED_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

UIXProcess

public UIXProcess()

Construct an instance of the UIXProcess.

Method Detail

getMaxVisited

public final int getMaxVisited()

Gets a zero-based index to indicate the highest visited page in the multi-page process. It defaults to -1, which means the maxVisited page is the selected page. This attribute keeps the user from jumping more than one step ahead from the maximum visited page in the process.

setMaxVisited

public final void setMaxVisited(int maxVisited)

Sets a zero-based index to indicate the highest visited page in the multi-page process. It defaults to -1, which means the maxVisited page is the selected page. This attribute keeps the user from jumping more than one step ahead from the maximum visited page in the process.

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class UIXComponentBase

getBeanType

protected FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIXComponentBase