JavaScript API Reference for Oracle ADF Faces

oracle.adfinternal.view.js.laf.dhtml.rich
Class AdfMenuUtils

org.ecmascript.object.Object
   |
   +--oracle.adf.view.js.base.AdfObject
         |
         +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfMenuUtils

public class AdfMenuUtils
extends AdfObject

AFR_TARGETCOMPONENTID

public static Object AFR_TARGETCOMPONENTID

AFR_TARGETROWCURRENCY

public static Object AFR_TARGETROWCURRENCY

DEPRESSED_STYLE_CLASS

public static Object DEPRESSED_STYLE_CLASS

DETACHED_STYLE_CLASS

public static Object DETACHED_STYLE_CLASS

FOCUSED_STYLE_CLASS

public static Object FOCUSED_STYLE_CLASS

HIGHLIGHTED_STYLE_CLASS

public static Object HIGHLIGHTED_STYLE_CLASS

MENU_DEPTH_KEY

public static Object MENU_DEPTH_KEY

OVERFLOW_CELL_STYLE_CLASS

public static Object OVERFLOW_CELL_STYLE_CLASS

OVERFLOW_KEY

public static Object OVERFLOW_KEY

_sOpenedMenus

private static Object _sOpenedMenus

AdfMenuUtils

public AdfMenuUtils()

Utility class used by various menu peers - menu, commandMenuItem, and goMenuItem

addOpenMenu

public static Object addOpenMenu(Object menuId)

If not already present, add the menu popup id to the open menu array.

Parameters:

menuId

-

the client id for the menu popup

Return:

Object

areMenusOpened

public static Object areMenusOpened()

Returns true if any menus are opened.

Return:

Object

closeAllMenus

public static Object closeAllMenus(Object restoreFocus)

Closes all menus. This method is also called by commandMenuItem and goMenuItem peer. It is up to caller (if needed) to first the menuBar auto open state via .setMenuBarAutoOpenMode() method.

Parameters:

restoreFocus

-

If true, the last opened root menu regains focus and highlighting after close

Return:

Object

dismiss

public static Object dismiss(Object element,
                             Object immediate,
                             Object keepOpen)

Closes every opened menu on the stack higher than the provided element. In this way, you can close menus higher in the stack than a particular open menu.

Parameters:

element	-	The element to be found
immediate	-	When true, there's no delay before showing the menu. When false there is a 300ms delay before the menu is closed. Menus are delay closed when you mouseOver a different menu item, allowing you time to 'get back' to the menu before it closes.
keepOpen	-	When true, the menus removed from the stack but not closed. This is for when a menu becomes detached - we don't want it to close but it needs to be removed from the open menu stack.

Return:

Object

getContextMenuItemTargetAttrs

public static Object getContextMenuItemTargetAttrs(Object menuItem)

For compatibility with context menus, get target attributes for handling row key

Parameters:

menuItem

-

the menuItem component

Return:

Object

GetLastOpenedRootMenuId

protected static Object GetLastOpenedRootMenuId()

Get the last opened root menu id (if present)

Return:

Object - the client id for the menu.

highlightRootMenuItem

public static Object highlightRootMenuItem(Object domElement)

Helper method to call when highlighting a root menu - clears any previously highlighted root menu.

Parameters:

domElement

-

menu item dom element to be highlighted

Return:

Object

InitClass

protected static Object InitClass()

Return:

Object

isInMenu

public static Object isInMenu(Object component)

Returns true if menu item is in a menu

Parameters:

component

-

the peer's component

Return:

Object

isInOverflow

public static Object isInOverflow(Object rootElement)

Returns true if menu item is in a menuBar overflow popup

Parameters:

rootElement

-

the peer's root dom element

Return:

Object

isMenuBarAutoOpenMode

public static Object isMenuBarAutoOpenMode()

Returns boolean (or null which is also false) indicating if we are in menubar auto open mode.

Return:

Object - boolean menubar auto open mode (may be null)

isMenuOpen

public static Object isMenuOpen(Object menuId)

Checks if a menu is already in the open menus.

Parameters:

menuId

-

the client id for the menu popup

Return:

Object

isOnMenuBar

public static Object isOnMenuBar(Object component)

Returns true if menu item is on a menuBar

Parameters:

component

-

the peer's component

Return:

Object

menuItemDisabledChanged

public static Object menuItemDisabledChanged(AdfUIComponent component,
                                             Object domElement,
                                             String newValue,
                                             HTMLElement menuContainerElement)

Handle component disabled changes for menu items.

Parameters:

component	-	the component
domElement
newValue	-	new disabled value
menuContainerElement	-	for submenu's this is the submenu's menu container. Can be null.

Return:

Object

menuItemVisibleChanged

public static Object menuItemVisibleChanged(AdfUIComponent component,
                                            Object domElement,
                                            String newValue,
                                            HTMLElement menuContainerElement)

Handle component visible changes for menu items.

Parameters:

component	-	the component
domElement
newValue	-	new disabled value
menuContainerElement	-	for submenu's this is the submenu's menu container. Can be null.

Return:

Object

removeOpenMenu

public static Object removeOpenMenu(Object menuId)

Remove the menu with the matching menuId from the opened menu array.

Parameters:

menuId

-

the client id for the menu popup

Return:

Object

restoreFocusToLastOpenedRootMenu

public static Object restoreFocusToLastOpenedRootMenu()

Restore the focus to the last opened root menu (if present).

Return:

Object

setContextMenuItemTargetAttrs

public static Object setContextMenuItemTargetAttrs(Object menuItem,
                                                   Object targetAttrs)

For compatibility with context menus, set target attributes for handling row key

Parameters:

menuItem	-	the menuItem component
targetAttrs	-	menu item's target attributes (see method above)

Return:

Object

setLastOpenedRootMenuId

public static Object setLastOpenedRootMenuId(Object menuId)

Set the menu as the last opened root menu.

Parameters:

menuId

-

the client id for the menu.

Return:

Object

setMenuBarAutoOpenMode

public static Object setMenuBarAutoOpenMode(Object menuBarAutoOpenMode)

Set the menubar auto open mode

Parameters:

menuBarAutoOpenMode

-

new boolean value

Return:

Object

unhighlightRootMenuItem

public static Object unhighlightRootMenuItem()

Helper method to call to unhighlight the currently highlighted root menu (if there is one).

Return:

Object