oracle.adf.view.faces.component
Class UIXMenuTree

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

All Implemented Interfaces:

CollectionComponent, NamingContainer, RowKeyIndex, StateHolder

Direct Known Subclasses:

CoreMenuTree

public class UIXMenuTree

extends UIXMenuHierarchy

ADF Faces menuTree components are used to display hierarchical menu data.

Example:

Events:

Type	Phases	Description
oracle.adf.view.faces.event.DisclosureEvent	Apply Request Values Invoke Application	This event is delivered when a node in the tree is expanded or collapsed by the user.

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static PropertyKey	DISCLOSURE_LISTENER_KEY
static PropertyKey	IMMEDIATE_KEY
static java.lang.String	NODE_STAMP_FACET
static PropertyKey	START_DEPTH_KEY
static PropertyKey	TREE_STATE_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

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

Method Summary

void	addDisclosureListener(DisclosureListener listener) Adds a DisclosureListener.
void	broadcast(FacesEvent event) Delivers an event.
CollectionModel	createCollectionModel(CollectionModel current, java.lang.Object value) Creates the CollectionModel to use with this component.
protected FacesBean.Type	getBeanType()
MethodBinding	getDisclosureListener() Gets a method reference to a disclosure listener
DisclosureListener[]	getDisclosureListeners() Retrieves all DisclosureListeners
java.lang.String	getFamily()
UIComponent	getNodeStamp() the component to use to stamp each element in the tree.
int	getStartDepth() Gets the starting depth, based on a 0 based index, in the menuModel to render based on the focusPath of the menuModel.
PathSet	getTreeState() Gets the set of expanded nodes for this component.
java.lang.Object	getValue() Gets the hierarchy of tree 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.
boolean	isImmediate() Gets whether or not data validation - client-side or server-side - should take place when events are generated by this component.
protected void	processFacetsAndChildren(FacesContext context, PhaseId phaseId) Process this component's facets and children.
void	queueEvent(FacesEvent event) Sets the phaseID of UI events depending on the "immediate" property.
void	removeDisclosureListener(DisclosureListener listener) Removes a DisclosureListener.
void	setDisclosureListener(MethodBinding disclosureListener) Sets a method reference to a disclosure 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	setNodeStamp(UIComponent nodeStampFacet) the component to use to stamp each element in the tree.
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	setTreeState(PathSet treeState) Sets the set of expanded nodes for this component.
void	setValue(java.lang.Object value) Sets the hierarchy of tree 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

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

clearCurrencyStringCache, createVarStatusMap, decodeChildrenImpl, encodeBegin, encodeEnd, getCollectionModel, getCollectionModel, getCurrencyString, getLocalClientId, getRowCount, getRowData, getRowData, getRowIndex, getRowKey, getSortCriteria, isRowAvailable, isRowAvailable, isSortable, postRowDataChange, preRowDataChange, processComponent, processDecodes, processSaveState, 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

TREE_STATE_KEY

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

IMMEDIATE_KEY

public static final PropertyKey IMMEDIATE_KEY

DISCLOSURE_LISTENER_KEY

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

UIXMenuTree

public UIXMenuTree()

Construct an instance of the UIXMenuTree.

UIXMenuTree

protected UIXMenuTree(java.lang.String rendererType)

Construct an instance of the UIXMenuTree.

Method Detail

addDisclosureListener

public final void addDisclosureListener(DisclosureListener listener)

Adds a DisclosureListener.

removeDisclosureListener

public final void removeDisclosureListener(DisclosureListener listener)

Removes a DisclosureListener.

getDisclosureListeners

public final DisclosureListener[] getDisclosureListeners()

Retrieves all DisclosureListeners

queueEvent

public void queueEvent(FacesEvent event)

Sets the phaseID of UI events depending on the "immediate" property.

Overrides:

queueEvent in class UIXCollection

Parameters:

event - a FacesEvent

broadcast

public void broadcast(FacesEvent event)
               throws AbortProcessingException

Delivers an event.

Overrides:

broadcast in class UIXCollection

Parameters:

event -

Throws:

AbortProcessingException

createCollectionModel

public CollectionModel createCollectionModel(CollectionModel current,
                                             java.lang.Object value)

Description copied from class: UIXCollection

Creates the CollectionModel to use with this component.

Overrides:

createCollectionModel in class UIXMenuHierarchy

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 tree. Only certain types of components are supported, including all components with no behavior and most components that implement the EditableValueHolder or ActionSource interfaces.

setNodeStamp

public final void setNodeStamp(UIComponent nodeStampFacet)

the component to use to stamp each element in the tree. Only certain types of components are supported, including all components with no behavior and most components that implement the EditableValueHolder or ActionSource interfaces.

getValue

public final java.lang.Object getValue()

Gets the hierarchy of tree 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 tree data - must be of type oracle.adf.view.faces.model.MenuModel

getTreeState

public final PathSet getTreeState()

Gets the set of expanded nodes for this component. Each entry in the set is a path of an expanded node.

setTreeState

public final void setTreeState(PathSet treeState)

Sets the set of expanded nodes for this component. Each entry in the set is a path of an expanded node.

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

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.

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.

getDisclosureListener

public final MethodBinding getDisclosureListener()

Gets a method reference to a disclosure listener

setDisclosureListener

public final void setDisclosureListener(MethodBinding disclosureListener)

Sets a method reference to a disclosure listener

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class UIXComponentBase

getBeanType

protected FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIXComponentBase