oracle.adf.view.faces.component.core.nav
Class CoreProcessTrain

java.lang.Object
  javax.faces.component.UIComponent
      oracle.adf.view.faces.component.UIXComponent
          oracle.adf.view.faces.component.UIXComponentBase
              oracle.adf.view.faces.component.UIXCollection
                  oracle.adf.view.faces.component.UIXHierarchy
                      oracle.adf.view.faces.component.UIXMenuHierarchy
                          oracle.adf.view.faces.component.UIXProcess
                              oracle.adf.view.faces.component.core.nav.CoreProcessTrain

All Implemented Interfaces:

CollectionComponent, NamingContainer, RowKeyIndex, StateHolder

public class CoreProcessTrain

extends UIXProcess

ProcessTrain is a UIXProcess component that renders a train. A processTrain is a horizontal series of train stations connected by a horizontal line. Each train station is an image and text describing the page in the multi-page process.

Model

The train takes a model of type oracle.adf.view.faces.model.MenuModel. The last node along the focusPath and its siblings are rendered.

MenuModel extends TreeModel, but it also knows how to go from the current viewId to the focus path. Notice that the menuModel has no special knowledge of page navigation and places no requirements on the nodes that go into the tree. The nodes in the tree are stamped out with the 'nodeStamp' facet, which should contain a commandMenuItem or goMenuItem component, which allows the default actionListener mechanism to be used for page navigation.

There are two common scenarios for processes, "Plus One" and "Max Visited" which are explained below.

• "Plus One" - from the current step the user can navigate to any previous page and the next page. If the user is on the 5th step of a process and goes back to step 2, then the user can only navigate from step 2 to step 1 and step 3.
• "Max Visited" - the user can navigate to the max visited page. If the user is currently on the max visited page then the user can also navigate to the next page. If the user is on the 5th step of a process and goes back to step 2, then the user can navigate from step 2 to steps 1, 2, 3, 4, and 5.

The class oracle.adf.view.faces.model.ProcessMenuModel and oracle.adf.view.faces.model.ProcessUtils were created to support the "Plus One" and "Max Visited" scenarios. Please see the javadoc for these classes for more information.

When the focusPath is not focused on a top level node, images are rendered before and after the train to indicate that this train is part of a sub-process

Example:

This is an example of a processTrain.

 <af:processTrain var="node" value="#{processMenuModel}">
   <f:facet name="nodeStamp">
     <af:commandMenuItem text="#{node.label}"
                         action="#{node.getOutcome}"
                         immediate="#{processMenuModel.immediate}"
                         readOnly="#{processMenuModel.readOnly}"/>
   </f:facet>
 </af:processTrain>             
           

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static PropertyKey	INLINE_STYLE_KEY
static PropertyKey	ONCLICK_KEY
static PropertyKey	ONDBLCLICK_KEY
static PropertyKey	ONKEYDOWN_KEY
static PropertyKey	ONKEYPRESS_KEY
static PropertyKey	ONKEYUP_KEY
static PropertyKey	ONMOUSEDOWN_KEY
static PropertyKey	ONMOUSEMOVE_KEY
static PropertyKey	ONMOUSEOUT_KEY
static PropertyKey	ONMOUSEOVER_KEY
static PropertyKey	ONMOUSEUP_KEY
static PropertyKey	PARTIAL_TRIGGERS_KEY
static PropertyKey	SHORT_DESC_KEY
static PropertyKey	STYLE_CLASS_KEY
static FacesBean.Type	TYPE

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

NODE_STAMP_FACET, VALUE_KEY, VAR_KEY, VAR_STATUS_KEY

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

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

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

Method Summary

protected FacesBean.Type	getBeanType()
java.lang.String	getFamily()
java.lang.String	getInlineStyle() Gets the inline CSS style for this element
java.lang.String	getOnclick() Gets an onclick Javascript handler.
java.lang.String	getOndblclick() Gets an ondblclick Javascript handler.
java.lang.String	getOnkeydown() Gets an onkeydown Javascript handler.
java.lang.String	getOnkeypress() Gets an onkeypress Javascript handler.
java.lang.String	getOnkeyup() Gets an onkeyup Javascript handler.
java.lang.String	getOnmousedown() Gets an onmousedown Javascript handler.
java.lang.String	getOnmousemove() Gets an onmousemove Javascript handler.
java.lang.String	getOnmouseout() Gets an onmouseout Javascript handler.
java.lang.String	getOnmouseover() Gets an onmouseover Javascript handler.
java.lang.String	getOnmouseup() Gets an onmouseup Javascript handler.
java.lang.String[]	getPartialTriggers() Gets the IDs of the components that should trigger a partial update.
java.lang.String	getShortDesc() Gets the short description of the bean.
java.lang.String	getStyleClass() Gets the CSS style class of the bean.
void	setInlineStyle(java.lang.String inlineStyle) Sets the inline CSS style for this element
void	setOnclick(java.lang.String onclick) Sets an onclick Javascript handler.
void	setOndblclick(java.lang.String ondblclick) Sets an ondblclick Javascript handler.
void	setOnkeydown(java.lang.String onkeydown) Sets an onkeydown Javascript handler.
void	setOnkeypress(java.lang.String onkeypress) Sets an onkeypress Javascript handler.
void	setOnkeyup(java.lang.String onkeyup) Sets an onkeyup Javascript handler.
void	setOnmousedown(java.lang.String onmousedown) Sets an onmousedown Javascript handler.
void	setOnmousemove(java.lang.String onmousemove) Sets an onmousemove Javascript handler.
void	setOnmouseout(java.lang.String onmouseout) Sets an onmouseout Javascript handler.
void	setOnmouseover(java.lang.String onmouseover) Sets an onmouseover Javascript handler.
void	setOnmouseup(java.lang.String onmouseup) Sets an onmouseup Javascript handler.
void	setPartialTriggers(java.lang.String[] partialTriggers) Sets the IDs of the components that should trigger a partial update.
void	setShortDesc(java.lang.String shortDesc) Sets the short description of the bean.
void	setStyleClass(java.lang.String styleClass) Sets the CSS style class of the bean.

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

getNodeStamp, getValue, getVar, getVarStatus, processFacetsAndChildren, setNodeStamp, setValue, setVar, setVarStatus

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

createCollectionModel, getFocusRowKey, getMenuModel

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

enterContainer, exitContainer, getAllAncestorContainerRowKeys, getContainerRowKey, getContainerRowKey, getDepth, getDepth, getFirst, getRows, getStamps, getTreeModel, isContainer, isContainerEmpty

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

broadcast, clearCurrencyStringCache, createVarStatusMap, decodeChildrenImpl, encodeBegin, encodeEnd, getCollectionModel, getCollectionModel, getCurrencyString, getLocalClientId, getRowCount, getRowData, getRowData, getRowIndex, getRowKey, getSortCriteria, isRowAvailable, isRowAvailable, isSortable, postRowDataChange, preRowDataChange, processComponent, processDecodes, processSaveState, queueEvent, resetStampState, restoreStampState, restoreState, saveStampState, saveState, setCurrencyString, setRowIndex, setRowKey, setSortCriteria, updateChildrenImpl, validateChildrenImpl

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.adf.view.faces.model.RowKeyIndex

getRowCount, getRowData, getRowData, getRowIndex, getRowKey, isRowAvailable, isRowAvailable, setRowIndex, setRowKey

Field Detail

TYPE

public static final FacesBean.Type TYPE

SHORT_DESC_KEY

public static final PropertyKey SHORT_DESC_KEY

PARTIAL_TRIGGERS_KEY

public static final PropertyKey PARTIAL_TRIGGERS_KEY

ONCLICK_KEY

public static final PropertyKey ONCLICK_KEY

ONDBLCLICK_KEY

public static final PropertyKey ONDBLCLICK_KEY

ONMOUSEDOWN_KEY

public static final PropertyKey ONMOUSEDOWN_KEY

ONMOUSEUP_KEY

public static final PropertyKey ONMOUSEUP_KEY

ONMOUSEOVER_KEY

public static final PropertyKey ONMOUSEOVER_KEY

ONMOUSEMOVE_KEY

public static final PropertyKey ONMOUSEMOVE_KEY

ONMOUSEOUT_KEY

public static final PropertyKey ONMOUSEOUT_KEY

ONKEYPRESS_KEY

public static final PropertyKey ONKEYPRESS_KEY

ONKEYDOWN_KEY

public static final PropertyKey ONKEYDOWN_KEY

ONKEYUP_KEY

public static final PropertyKey ONKEYUP_KEY

STYLE_CLASS_KEY

public static final PropertyKey STYLE_CLASS_KEY

INLINE_STYLE_KEY

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

CoreProcessTrain

public CoreProcessTrain()

Construct an instance of the CoreProcessTrain.

CoreProcessTrain

protected CoreProcessTrain(java.lang.String rendererType)

Construct an instance of the CoreProcessTrain.

Method Detail

getShortDesc

public final java.lang.String getShortDesc()

Gets the short description of the bean. This text is commonly used by user agents to display tooltip help text.

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)

Sets the short description of the bean. This text is commonly used by user agents to display tooltip help text.

getPartialTriggers

public final java.lang.String[] getPartialTriggers()

Gets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.

setPartialTriggers

public final void setPartialTriggers(java.lang.String[] partialTriggers)

Sets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.

getOnclick

public final java.lang.String getOnclick()

Gets an onclick Javascript handler.

setOnclick

public final void setOnclick(java.lang.String onclick)

Sets an onclick Javascript handler.

getOndblclick

public final java.lang.String getOndblclick()

Gets an ondblclick Javascript handler.

setOndblclick

public final void setOndblclick(java.lang.String ondblclick)

Sets an ondblclick Javascript handler.

getOnmousedown

public final java.lang.String getOnmousedown()

Gets an onmousedown Javascript handler.

setOnmousedown

public final void setOnmousedown(java.lang.String onmousedown)

Sets an onmousedown Javascript handler.

getOnmouseup

public final java.lang.String getOnmouseup()

Gets an onmouseup Javascript handler.

setOnmouseup

public final void setOnmouseup(java.lang.String onmouseup)

Sets an onmouseup Javascript handler.

getOnmouseover

public final java.lang.String getOnmouseover()

Gets an onmouseover Javascript handler.

setOnmouseover

public final void setOnmouseover(java.lang.String onmouseover)

Sets an onmouseover Javascript handler.

getOnmousemove

public final java.lang.String getOnmousemove()

Gets an onmousemove Javascript handler.

setOnmousemove

public final void setOnmousemove(java.lang.String onmousemove)

Sets an onmousemove Javascript handler.

getOnmouseout

public final java.lang.String getOnmouseout()

Gets an onmouseout Javascript handler.

setOnmouseout

public final void setOnmouseout(java.lang.String onmouseout)

Sets an onmouseout Javascript handler.

getOnkeypress

public final java.lang.String getOnkeypress()

Gets an onkeypress Javascript handler.

setOnkeypress

public final void setOnkeypress(java.lang.String onkeypress)

Sets an onkeypress Javascript handler.

getOnkeydown

public final java.lang.String getOnkeydown()

Gets an onkeydown Javascript handler.

setOnkeydown

public final void setOnkeydown(java.lang.String onkeydown)

Sets an onkeydown Javascript handler.

getOnkeyup

public final java.lang.String getOnkeyup()

Gets an onkeyup Javascript handler.

setOnkeyup

public final void setOnkeyup(java.lang.String onkeyup)

Sets an onkeyup Javascript handler.

getStyleClass

public final java.lang.String getStyleClass()

Gets the CSS style class of the bean.

setStyleClass

public final void setStyleClass(java.lang.String styleClass)

Sets the CSS style class of the bean.

getInlineStyle

public final java.lang.String getInlineStyle()

Gets the inline CSS style for this element

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)

Sets the inline CSS style for this element

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class UIXProcess

getBeanType

protected FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIXProcess