JavaScript API Reference for Oracle ADF Faces

Overview

Package

Class

Tree

Deprecated

Index

Help

Oracle Fusion Middleware Javascript API Reference for Oracle ADF Faces
12c (12.2.1.1)
E67023-01

PREV NEXT

FRAMES NO FRAMES Warning: private items are visible

SUMMARY: FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

oracle.adfinternal.view.js.laf.dhtml.rich.subids
Class AdfDhtmlMenuPeer

Warning:

This is an unsupported, internal implementation class.
Use an API class that might provide equivalent functionality instead.
This class will change without notice.
It is not recommended that you use anything in this class.

org.ecmascript.object.Object
   |
   +--oracle.adfinternal.view.js.laf.dhtml.rich.subids.AdfDhtmlMenuPeer

public class AdfDhtmlMenuPeer
extends Object

menu component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1. [text --> the text value (mapped programmatically)] 2. [bar-item-text --> the text value when present on a menuBar (mapped programmatically)] 3. [bar-item-icon --> the icon when present on a menuBar (mapped programmatically)] 4. [submenu-text --> the text value when present inside a menu (mapped programmatically)] 5. [submenu-icon --> icon when present inside a menu (mapped programmatically)] 6. [scroll_up_button --> button present inside a menu when scrolling is necessary] 7. [scroll_down_button --> button present inside a menu when scrolling is necessary] 8. [popup --> the menu popup] 9. [close_button --> detached menu's close button] 10. [detach_handle --> the handle for dragging a detachable menu] 11. [popup_scroll_box --> the box containing the menu items inside a scrollable menu popup] Ids that are mapped programmatically do not have a corresponding ID to map to. Instead it is determined programmatically in the associated GetSubIdDomElement() methods.

Field Summary
`private static Object`	`_SUB_ID_MAP` menu component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1.

Fields inherited from org.ecmascript.object.Object

constructor, prototype

Constructor Summary
`public`	`AdfDhtmlMenuPeer()` menu component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1.

Method Summary
`protected Object`	`GetBestMatchSubId(Object childElement)` Returns the best match subId for the given domElement.
`protected HTMLElement`	`GetSubIdDomElement(String subElementId)` Returns the DOM element identified by the passed in subId.

Field Detail

_SUB_ID_MAP

private static Object _SUB_ID_MAP: menu component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1. [text --> the text value (mapped programmatically)] 2. [bar-item-text --> the text value when present on a menuBar (mapped programmatically)] 3. [bar-item-icon --> the icon when present on a menuBar (mapped programmatically)] 4. [submenu-text --> the text value when present inside a menu (mapped programmatically)] 5. [submenu-icon --> icon when present inside a menu (mapped programmatically)] 6. [scroll_up_button --> button present inside a menu when scrolling is necessary] 7. [scroll_down_button --> button present inside a menu when scrolling is necessary] 8. [popup --> the menu popup] 9. [close_button --> detached menu's close button] 10. [detach_handle --> the handle for dragging a detachable menu] 11. [popup_scroll_box --> the box containing the menu items inside a scrollable menu popup] Ids that are mapped programmatically do not have a corresponding ID to map to. Instead it is determined programmatically in the associated GetSubIdDomElement() methods.

Constructor Detail

AdfDhtmlMenuPeer

public AdfDhtmlMenuPeer(): menu component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1. [text --> the text value (mapped programmatically)] 2. [bar-item-text --> the text value when present on a menuBar (mapped programmatically)] 3. [bar-item-icon --> the icon when present on a menuBar (mapped programmatically)] 4. [submenu-text --> the text value when present inside a menu (mapped programmatically)] 5. [submenu-icon --> icon when present inside a menu (mapped programmatically)] 6. [scroll_up_button --> button present inside a menu when scrolling is necessary] 7. [scroll_down_button --> button present inside a menu when scrolling is necessary] 8. [popup --> the menu popup] 9. [close_button --> detached menu's close button] 10. [detach_handle --> the handle for dragging a detachable menu] 11. [popup_scroll_box --> the box containing the menu items inside a scrollable menu popup] Ids that are mapped programmatically do not have a corresponding ID to map to. Instead it is determined programmatically in the associated GetSubIdDomElement() methods.

Method Detail

GetBestMatchSubId

protected Object GetBestMatchSubId(Object childElement)

Returns the best match subId for the given domElement. This can be enhanced further to return programmatically determined subIds. WARNING - You must make sure to bind the component to the peer before calling this function.

Parameters:

childElement

Return:

Object

See also:

AdfRichUIPeer.GetSubIdDomElement(Object)

GetSubIdDomElement

protected HTMLElement GetSubIdDomElement(String subElementId)

Returns the DOM element identified by the passed in subId.

Parameters:

subElementId - the subId of the DOM element to locate

Return:

HTMLElement - the corresponding dom element