dijit/Menu.js

• Provides:

  • dijit.Menu

• Requires:

  • dojo.window in common
  • dijit._Widget in common
  • dijit._KeyNavContainer in common
  • dijit._Templated in common
  • dijit.MenuItem in common
  • dijit.PopupMenuItem in common
  • dijit.CheckedMenuItem in common
  • dijit.MenuSeparator in common

• dijit._MenuBase

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dijit._Templated.prototype: (prototype)
    • dijit._KeyNavContainer.prototype: (prototype)
    • dijit._Widget: (call)
    • dijit._Templated: (call)
    • dijit._KeyNavContainer: (call)
  • summary

    Base class for Menu and MenuBar

  • classlike

• dijit._MenuBase.parentMenu

  • prototype - dijit._MenuBase
  • tags: readonly
  • type

    Widget

  • summary

    pointer to menu that displayed me

• dijit._MenuBase.popupDelay

  • prototype - dijit._MenuBase
  • type

    Integer

  • summary

    number of milliseconds before hovering (without clicking) causes the popup to automatically open.

• dijit._MenuBase.startup

  • prototype - dijit._MenuBase
  • type

    Function

• dijit._MenuBase.onExecute

  • prototype - dijit._MenuBase
  • summary

    Attach point for notification about when a menu item has been executed.
    This is an internal mechanism used for Menus to signal to their parent to
    close them, because they are about to execute the onClick handler.   In
    general developers should not attach to or override this method.

  • tags:
  • protected - 1
  • type

    Function

• dijit._MenuBase.onCancel

  • prototype - dijit._MenuBase
  • parameters:
    • closeAll: (typeof Boolean)
  • summary

    Attach point for notification about when the user cancels the current menu
    This is an internal mechanism used for Menus to signal to their parent to
    close them.  In general developers should not attach to or override this method.

  • tags:
  • protected - 1
  • type

    Function

• dijit._MenuBase._moveToPopup

  • prototype - dijit._MenuBase
  • parameters:
    • evt: (typeof Event)
  • summary

    This handles the right arrow key (left arrow key on RTL systems),
    which will either open a submenu, or move to the next item in the
    ancestor MenuBar

  • tags:
  • private - 1
  • type

    Function

• dijit._MenuBase._onPopupHover

  • prototype - dijit._MenuBase
  • parameters:
    • evt: (typeof Event)
  • summary

    This handler is called when the mouse moves over the popup.

  • tags:
  • private - 1
  • type

    Function

• dijit._MenuBase.currentPopup.parentMenu

  • prototype - dijit._MenuBase

• dijit._MenuBase.currentPopup.parentMenu.focusedChild

  • prototype - dijit._MenuBase

• dijit._MenuBase.onItemHover

  • prototype - dijit._MenuBase
  • parameters:
    • item: (typeof MenuItem)
  • summary

    Called when cursor is over a MenuItem.

  • tags:
  • protected - 1
  • type

    Function

• dijit._MenuBase.hover_timer

  • prototype - dijit._MenuBase
  • type

    Object

• dijit._MenuBase._hoveredChild

  • prototype - dijit._MenuBase
  • private - 1
  • type

    Object

• dijit._MenuBase._onChildBlur

  • prototype - dijit._MenuBase
  • parameters:
    • item
  • summary

    Called when a child MenuItem becomes inactive because focus
    has been removed from the MenuItem *and* it's descendant menus.

  • tags:
  • private - 1
  • type

    Function

• dijit._MenuBase.onItemUnhover

  • prototype - dijit._MenuBase
  • parameters:
    • item: (typeof MenuItem)
  • summary

    Callback fires when mouse exits a MenuItem

  • tags:
  • protected - 1
  • type

    Function

• dijit._MenuBase._stopPopupTimer

  • prototype - dijit._MenuBase
  • summary

    Cancels the popup timer because the user has stop hovering
    on the MenuItem, etc.

  • tags:
  • private - 1
  • type

    Function

• dijit._MenuBase._stopPendingCloseTimer

  • prototype - dijit._MenuBase
  • parameters:
    • popup: (typeof dijit._Widget)
  • summary

    Cancels the pending-close timer because the close has been preempted

  • tags:
  • private - 1
  • type

    Function

• dijit._MenuBase._stopFocusTimer

  • prototype - dijit._MenuBase
  • summary

    Cancels the pending-focus timer because the menu was closed before focus occured

  • tags:
  • private - 1
  • type

    Function

• dijit._MenuBase._focus_timer

  • prototype - dijit._MenuBase
  • private - 1
  • type

    Object

• dijit._MenuBase._getTopMenu

  • prototype - dijit._MenuBase
  • summary

    Returns the top menu in this chain of Menus

  • tags:
  • private - 1
  • type

    Function

• dijit._MenuBase.onItemClick

  • prototype - dijit._MenuBase
  • parameters:
    • item: (typeof dijit._Widget)
    • evt: (typeof Event)
  • summary

    Handle clicks on an item.

  • tags:
  • private - 1
  • type

    Function

• dijit._MenuBase._openPopup

  • prototype - dijit._MenuBase
  • returns

    the focused child lost focus since the timer was started

  • summary

    Open the popup to the side of/underneath the current menu item

  • tags:
  • protected - 1
  • type

    Function

• dijit._MenuBase.focusedChild

  • prototype - dijit._MenuBase
  • type

    Object

• dijit._MenuBase.focusedChild.popup

  • prototype - dijit._MenuBase

• dijit._MenuBase.focusedChild.popup.parentMenu

  • prototype - dijit._MenuBase
  • type

    Object

• dijit._MenuBase.focusedChild.popup.from_item

  • prototype - dijit._MenuBase

• dijit._MenuBase.currentPopup

  • prototype - dijit._MenuBase
  • type

    Object

• dijit._MenuBase.focusedChild.popup._focus_timer

  • prototype - dijit._MenuBase
  • private - 1
  • type

    Object

• dijit._MenuBase._markActive

  • prototype - dijit._MenuBase
  • summary

    Mark this menu's state as active.
    Called when this Menu gets focus from:
    1) clicking it (mouse or via space/arrow key)
    2) being opened by a parent menu.
    This is not called just from mouse hover.
    Focusing a menu via TAB does NOT automatically set isActive
    since TAB is a navigation operation and not a selection one.
    For Windows apps, pressing the ALT key focuses the menubar
    menus (similar to TAB navigation) but the menu is not active
    (ie no dropdown) until an item is clicked.

  • private - 1
  • type

    Function

• dijit._MenuBase.isActive

  • prototype - dijit._MenuBase
  • type

    bool

• dijit._MenuBase.onOpen

  • prototype - dijit._MenuBase
  • parameters:
    • e: (typeof Event)
  • summary

    Callback when this menu is opened.
    This is called by the popup manager as notification that the menu
    was opened.

  • tags:
  • private - 1
  • type

    Function

• dijit._MenuBase.isShowingNow

  • prototype - dijit._MenuBase
  • type

    bool

• dijit._MenuBase._markInactive

  • prototype - dijit._MenuBase
  • summary

    Mark this menu's state as inactive.

  • private - 1
  • type

    Function

• dijit._MenuBase.onClose

  • prototype - dijit._MenuBase
  • summary

    Callback when this menu is closed.
    This is called by the popup manager as notification that the menu
    was closed.

  • tags:
  • private - 1
  • type

    Function

• dijit._MenuBase._closeChild

  • prototype - dijit._MenuBase
  • summary

    Called when submenu is clicked or focus is lost.  Close hierarchy of menus.

  • tags:
  • private - 1
  • type

    Function

• dijit._MenuBase._onItemFocus

  • prototype - dijit._MenuBase
  • parameters:
    • item: (typeof MenuItem)
  • summary

    Called when child of this Menu gets focus from:
    1) clicking it
    2) tabbing into it
    3) being opened by a parent menu.
    This is not called just from mouse hover.

  • private - 1
  • type

    Function

• dijit._MenuBase._onBlur

  • prototype - dijit._MenuBase
  • summary

    Called when focus is moved away from this Menu and it's submenus.

  • tags:
  • protected - 1
  • type

    Function

• dijit._MenuBase._cleanUp

  • prototype - dijit._MenuBase
  • summary

    Called when the user is done with this menu.  Closes hierarchy of menus.

  • tags:
  • private - 1
  • type

    Function

• dijit.Menu

  • type

    Function

  • chains:
    • dijit._MenuBase: (prototype)
    • dijit._MenuBase: (call)
  • classlike

• dijit.Menu.constructor

  • constructor - constructor
  • prototype - dijit.Menu
  • type

    Function

• dijit.Menu.templateString

  • prototype - dijit.Menu
  • type

    Object

• dijit.Menu.baseClass

  • prototype - dijit.Menu
  • type

    String

• dijit.Menu.targetNodeIds

  • prototype - dijit.Menu
  • tags: const
  • type

    String[]

  • summary

    Array of dom node ids of nodes to attach to.
    Fill this with nodeIds upon widget creation and it becomes context menu for those nodes.

• dijit.Menu.contextMenuForWindow

  • prototype - dijit.Menu
  • tags: const
  • type

    Boolean

  • summary

    If true, right clicking anywhere on the window will cause this context menu to open.
    If false, must specify targetNodeIds.

• dijit.Menu.leftClickToOpen

  • prototype - dijit.Menu
  • tags: const
  • type

    Boolean

  • summary

    If true, menu will open on left click instead of right click, similiar to a file menu.

• dijit.Menu.refocus

  • prototype - dijit.Menu
  • type

    Boolean

  • summary

    When this menu closes, re-focus the element which had focus before it was opened.

• dijit.Menu.postCreate

  • prototype - dijit.Menu
  • type

    Function

• dijit.Menu._openSubMenuKey

  • prototype - dijit.Menu
  • private - 1

• dijit.Menu._closeSubMenuKey

  • prototype - dijit.Menu
  • private - 1

• dijit.Menu._onKeyPress

  • prototype - dijit.Menu
  • parameters:
    • evt: (typeof Event)
  • summary

    Handle keyboard based menu navigation.

  • tags:
  • protected - 1
  • type

    Function

• dijit.Menu._iframeContentWindow

  • prototype - dijit.Menu
  • parameters:
    • iframe_el: (typeof HTMLIFrameElement)
  • returns

    Window

  • summary

    Returns the window reference of the passed iframe

  • tags:
  • private - 1
  • type

    Function

• dijit.Menu._iframeContentDocument

  • prototype - dijit.Menu
  • parameters:
    • iframe_el: (typeof HTMLIFrameElement)
  • returns

    HTMLDocument

  • summary

    Returns a reference to the document object inside iframe_el

  • tags:
  • protected - 1
  • type

    Function

• dijit.Menu.bindDomNode

  • prototype - dijit.Menu
  • parameters:
    • node: (typeof String|DomNode)
  • summary

    Attach menu to given node

  • type

    Function

• dijit.Menu.unBindDomNode

  • prototype - dijit.Menu
  • parameters:
    • nodeName: (typeof String|DomNode)
  • summary

    Detach menu from given node

  • type

    Function

• dijit.Menu._scheduleOpen

  • prototype - dijit.Menu
  • parameters:
    • target: (typeof DomNode)
    • iframe: (typeof DomNode)
    • coords: (typeof Object)
  • summary

    Set timer to display myself.  Using a timer rather than displaying immediately solves
    two problems:
    
    1. IE: without the delay, focus work in "open" causes the system
    context menu to appear in spite of stopEvent.
    
    2. Avoid double-shows on linux, where shift-F10 generates an oncontextmenu event
    even after a dojo.stopEvent(e).  (Shift-F10 on windows doesn't generate the
    oncontextmenu event.)

  • private - 1
  • type

    Function

• dijit.Menu._openTimer

  • prototype - dijit.Menu
  • private - 1
  • type

    Object

• dijit.Menu._openMyself

  • prototype - dijit.Menu
  • parameters:
    • args: (typeof This)

      is an Object containing:
      * target:
      The node that is being clicked
      * iframe:
      If an <iframe> is being clicked, iframe points to that iframe
      * coords:
      Put menu at specified x/y position in viewport, or if iframe is
      specified, then relative to iframe.
      
      _openMyself() formerly took the event object, and since various code references
      evt.target (after connecting to _openMyself()), using an Object for parameters
      (so that old code still works).

  • summary

    Internal function for opening myself when the user does a right-click or something similar.

  • private - 1
  • type

    Function

• dijit.Menu._onBlur

  • prototype - dijit.Menu
  • private - 1
  • type

    Function

• dijit.Menu.uninitialize

  • prototype - dijit.Menu
  • type

    Function

• dijit.Menu._bindings

  • instance - dijit.Menu
  • private - 1
  • type

    Array

• dijit

  • type

    Object