oracle.adf.view.faces.component
Class UIXMenu

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.UIXMenu

All Implemented Interfaces:

CollectionComponent, NamingContainer, RowKeyIndex, StateHolder

Direct Known Subclasses:

CoreMenuBar, CoreMenuButtons, CoreMenuChoice, CoreMenuList, CoreMenuTabs

public class UIXMenu

extends UIXMenuHierarchy

Signifies an element that can contain a series of UIXCommand components.

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	NODE_STAMP_FACET
static PropertyKey	START_DEPTH_KEY
static FacesBean.Type	TYPE
static PropertyKey	VALUE_KEY
static PropertyKey	VAR_KEY
static PropertyKey	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

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

Method Summary

protected FacesBean.Type	getBeanType()
java.lang.String	getFamily()
UIComponent	getNodeStamp() the component to use to stamp each element in the menu.
int	getStartDepth() Gets the starting depth, based on a 0 based index, in the menuModel to render based on the focusPath of the menuModel.
java.lang.Object	getValue() Gets the hierarchy of menu data - must be of type oracle.adf.view.faces.model.MenuModel
java.lang.String	getVar() Gets Name of the EL variable used to reference each element of this collection.
java.lang.String	getVarStatus() Gets Name of the EL variable used to reference the varStatus information.
protected void	processFacetsAndChildren(FacesContext context, PhaseId phaseId) Process this component's facets and children.
void	setNodeStamp(UIComponent nodeStampFacet) the component to use to stamp each element in the menu.
void	setStartDepth(int startDepth) Sets the starting depth, based on a 0 based index, in the menuModel to render based on the focusPath of the menuModel.
void	setValue(java.lang.Object value) Sets the hierarchy of menu data - must be of type oracle.adf.view.faces.model.MenuModel
void	setVar(java.lang.String var) Sets Name of the EL variable used to reference each element of this collection.
void	setVarStatus(java.lang.String varStatus) Sets Name of the EL variable used to reference the varStatus information.

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

VALUE_KEY

public static final PropertyKey VALUE_KEY

START_DEPTH_KEY

public static final PropertyKey START_DEPTH_KEY

VAR_KEY

public static final PropertyKey VAR_KEY

VAR_STATUS_KEY

public static final PropertyKey VAR_STATUS_KEY

NODE_STAMP_FACET

public static final java.lang.String NODE_STAMP_FACET

See Also:

Constant Field Values

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

UIXMenu

public UIXMenu()

Construct an instance of the UIXMenu.

UIXMenu

protected UIXMenu(java.lang.String rendererType)

Construct an instance of the UIXMenu.

Method Detail

processFacetsAndChildren

protected void processFacetsAndChildren(FacesContext context,
                                        PhaseId phaseId)

Description copied from class: UIXCollection

Process this component's facets and children. This method should call UIXCollection.processComponent(javax.faces.context.FacesContext, javax.faces.component.UIComponent, javax.faces.event.PhaseId) as many times as necessary for each facet and child. UIXCollection.processComponent(javax.faces.context.FacesContext, javax.faces.component.UIComponent, javax.faces.event.PhaseId) may be called repeatedly for the same child if that child is being stamped.

Specified by:

processFacetsAndChildren in class UIXCollection

getNodeStamp

public final UIComponent getNodeStamp()

the component to use to stamp each element in the menu. A CommandMenuItem or GoMenuItem is expected.

setNodeStamp

public final void setNodeStamp(UIComponent nodeStampFacet)

the component to use to stamp each element in the menu. A CommandMenuItem or GoMenuItem is expected.

getValue

public final java.lang.Object getValue()

Gets the hierarchy of menu data - must be of type oracle.adf.view.faces.model.MenuModel

Specified by:

getValue in class UIXCollection

setValue

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

Sets the hierarchy of menu data - must be of type oracle.adf.view.faces.model.MenuModel

getStartDepth

public final int getStartDepth()

Gets the starting depth, based on a 0 based index, in the menuModel to render based on the focusPath of the menuModel.

setStartDepth

public final void setStartDepth(int startDepth)

Sets the starting depth, based on a 0 based index, in the menuModel to render based on the focusPath of the menuModel.

getVar

public final java.lang.String getVar()

Gets Name of the EL variable used to reference each element of this collection. Once this component has completed rendering, this variable is removed (or reverted back to its previous value).

Specified by:

getVar in interface CollectionComponent

Specified by:

getVar in class UIXCollection

setVar

public final void setVar(java.lang.String var)

Sets Name of the EL variable used to reference each element of this collection. Once this component has completed rendering, this variable is removed (or reverted back to its previous value).

getVarStatus

public final java.lang.String getVarStatus()

Gets Name of the EL variable used to reference the varStatus information. Once this component has completed rendering, this variable is removed (or reverted back to its previous value). The VarStatus provides contextual information about the state of the component to EL expressions. For components that iterate, varStatus also provides loop counter information. Please see the this component's documentation for the specific properties on the varStatus. The common properties on varStatus include:

• "model" - returns the CollectionModel for this component
• "index" - returns the zero based row index

Specified by:

getVarStatus in class UIXCollection

See Also:

UIXCollection.createVarStatusMap()

setVarStatus

public final void setVarStatus(java.lang.String varStatus)

Sets Name of the EL variable used to reference the varStatus information. Once this component has completed rendering, this variable is removed (or reverted back to its previous value). The VarStatus provides contextual information about the state of the component to EL expressions. For components that iterate, varStatus also provides loop counter information. Please see the this component's documentation for the specific properties on the varStatus. The common properties on varStatus include:

• "model" - returns the CollectionModel for this component
• "index" - returns the zero based row index

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class UIXComponentBase

getBeanType

protected FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIXComponentBase