oracle.apps.fnd.applcore.patterns.uishell.model
Class ApplicationsMenuModel

java.lang.Object
  javax.faces.model.DataModel
      org.apache.myfaces.trinidad.model.CollectionModel
          org.apache.myfaces.trinidad.model.TreeModel
              org.apache.myfaces.trinidad.model.MenuModel
                  org.apache.myfaces.trinidad.model.BaseMenuModel
                      org.apache.myfaces.trinidad.model.XMLMenuModel
                          oracle.adf.view.rich.model.MDSMenuModel
                              oracle.apps.fnd.applcore.patterns.uishell.model.ApplicationsMenuModel

All Implemented Interfaces:

org.apache.myfaces.trinidad.model.LocalRowKeyIndex, org.apache.myfaces.trinidad.model.RowKeyIndex, org.apache.myfaces.trinidad.model.TreeLocalRowKeyIndex

public class ApplicationsMenuModel
extends oracle.adf.view.rich.model.MDSMenuModel

Nested Class Summary

static interface

ApplicationsMenuModel.MenuContentHandler

Nested classes/interfaces inherited from interface org.apache.myfaces.trinidad.model.LocalRowKeyIndex

org.apache.myfaces.trinidad.model.LocalRowKeyIndex.Confidence, org.apache.myfaces.trinidad.model.LocalRowKeyIndex.LocalCachingStrategy

Field Summary

static java.util.Map<java.lang.String,ApplicationsMenuModel.MenuContentHandler>	_contentHandlerMap Although the contentHandlerMap variable is made public, it is for Applcore internal use only.
static java.lang.String	_ROOT_MODEL_KEY Although the ROOT_MODEL_KEY string is made public, it is for Applcore internal use only.

Fields inherited from class org.apache.myfaces.trinidad.model.XMLMenuModel

SHARED_MODEL_INDICATOR_KEY

Constructor Summary

ApplicationsMenuModel()

Method Summary

java.lang.Object	getFocusRowKey()
java.lang.Object	getNode(java.lang.String id) Get a the MenuNode corresponding to the key "id" from the node id hashmap.
java.lang.String	getSource() Gets the URI to the XML menu metadata.
java.io.InputStream	getStream(java.lang.String uri)
java.lang.String	getTopRootModel()
java.util.Map<java.lang.String,java.util.List<java.lang.Object>>	getViewIdFocusPathMap()
boolean	isTopMenuModel()
void	setSource(java.lang.String menuMetadataUri) setSource - specifies the XML metadata and creates the XML Menu Model.
void	setTopMenuModel(boolean topMenuModel)
void	setTopRootModel(java.lang.String topRootModel)
void	setWrappedData(java.lang.Object data) Makes the TreeModel part of the menu model.

Methods inherited from class oracle.adf.view.rich.model.MDSMenuModel

clearContentHandlerMap, getContentHandlerId, getContentHandlerMap

Methods inherited from class org.apache.myfaces.trinidad.model.XMLMenuModel

addViewId, getCacheKey, getCreateHiddenNodes, getCustomProperty, isCompatibilityMode, setCreateHiddenNodes, setCurrentlyPostedNode

Methods inherited from class org.apache.myfaces.trinidad.model.BaseMenuModel

enterContainer, exitContainer, getContainerRowKey, getRowCount, getRowData, getRowIndex, getRowKey, getWrappedData, isContainer, isRowAvailable, setRowIndex, setRowKey

Methods inherited from class org.apache.myfaces.trinidad.model.TreeModel

areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, getAllAncestorContainerRowKeys, getContainerRowKey, getDepth, getDepth, isChildCollectionLocallyAvailable, isChildCollectionLocallyAvailable, isChildCollectionLocallyAvailable, isContainerEmpty

Methods inherited from class org.apache.myfaces.trinidad.model.CollectionModel

areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearLocalCache, getCachingStrategy, getEstimatedRowCount, getEstimatedRowCountConfidence, getRowData, getSortCriteria, isRowAvailable, isRowLocallyAvailable, isRowLocallyAvailable, isSortable, setSortCriteria

Methods inherited from class javax.faces.model.DataModel

addDataModelListener, getDataModelListeners, removeDataModelListener

Methods inherited from class java.lang.Object

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

Field Detail

_contentHandlerMap

public static java.util.Map<java.lang.String,ApplicationsMenuModel.MenuContentHandler> _contentHandlerMap

Although the contentHandlerMap variable is made public, it is for Applcore internal use only. Apps teams are not authorized to use it. It's not used after bug 11935176, but keep it here for backward compatibility

_ROOT_MODEL_KEY

public static final java.lang.String _ROOT_MODEL_KEY

Although the ROOT_MODEL_KEY string is made public, it is for Applcore internal use only. Apps teams are not authorized to use it.

See Also:

Constant Field Values

Constructor Detail

ApplicationsMenuModel

public ApplicationsMenuModel()

Method Detail

isTopMenuModel

public boolean isTopMenuModel()

setTopMenuModel

public void setTopMenuModel(boolean topMenuModel)

getTopRootModel

public java.lang.String getTopRootModel()

setTopRootModel

public void setTopRootModel(java.lang.String topRootModel)

setSource

public void setSource(java.lang.String menuMetadataUri)

setSource - specifies the XML metadata and creates the XML Menu Model.

Overrides:

setSource in class org.apache.myfaces.trinidad.model.XMLMenuModel

Parameters:

menuMetadataUri - - String URI to the XML metadata.

getSource

public java.lang.String getSource()

Gets the URI to the XML menu metadata. tmak: Need to copy this method from parent class because _mdSource is private in parent class. We have to override setSource() to call our own _createModel() method, thus also need to define the private _mdSource here.

Overrides:

getSource in class org.apache.myfaces.trinidad.model.XMLMenuModel

Returns:

String URI to the XML menu metadata.

setWrappedData

public void setWrappedData(java.lang.Object data)

Makes the TreeModel part of the menu model. Also creates the _viewIdFocusPathMap, _nodeFocusPathMap, and idNodeMaps. tmak: Need to override this because we need to call the modified _getRootModel() method here, and this method is private. And therefore, we also have to create the private member variables: _viewIdFocusPathMap, _nodeFocusPathMap and _idNodeMap.

Overrides:

setWrappedData in class org.apache.myfaces.trinidad.model.XMLMenuModel

Parameters:

data - The Tree Model instance

getNode

public java.lang.Object getNode(java.lang.String id)

Get a the MenuNode corresponding to the key "id" from the node id hashmap.

Overrides:

getNode in class org.apache.myfaces.trinidad.model.XMLMenuModel

Parameters:

id - - String node id key for the hashmap entry.

Returns:

The Node Object that corresponds to id.

getViewIdFocusPathMap

public java.util.Map<java.lang.String,java.util.List<java.lang.Object>> getViewIdFocusPathMap()

Overrides:

getViewIdFocusPathMap in class org.apache.myfaces.trinidad.model.XMLMenuModel

getFocusRowKey

public java.lang.Object getFocusRowKey()

Overrides:

getFocusRowKey in class org.apache.myfaces.trinidad.model.XMLMenuModel

getStream

public java.io.InputStream getStream(java.lang.String uri)

Overrides:

getStream in class oracle.adf.view.rich.model.MDSMenuModel