dijit/_HasDropDown.js

• Provides:

  • dijit._HasDropDown

• Requires:

  • dijit._Widget in common

• dijit._HasDropDown

  • type

    Function

  • summary

    Mixin for widgets that need drop down ability.

• dijit._HasDropDown._buttonNode

  • tags:
  • type

    DomNode

  • summary

    The button/icon/node to click to display the drop down.
    Can be set via a dojoAttachPoint assignment.
    If missing, then either focusNode or domNode (if focusNode is also missing) will be used.

• dijit._HasDropDown._arrowWrapperNode

  • tags:
  • type

    DomNode

  • summary

    Will set CSS class dijitUpArrow, dijitDownArrow, dijitRightArrow etc. on this node depending
    on where the drop down is set to be positioned.
    Can be set via a dojoAttachPoint assignment.
    If missing, then _buttonNode will be used.

• dijit._HasDropDown._popupStateNode

  • tags:
  • type

    DomNode

  • summary

    The node to set the popupActive class on.
    Can be set via a dojoAttachPoint assignment.
    If missing, then focusNode or _buttonNode (if focusNode is missing) will be used.

• dijit._HasDropDown._aroundNode

  • tags:
  • type

    DomNode

  • summary

    The node to display the popup around.
    Can be set via a dojoAttachPoint assignment.
    If missing, then domNode will be used.

• dijit._HasDropDown.dropDown

  • tags:
  • type

    Widget

  • summary

    The widget to display as a popup.  This widget *must* be
    defined before the startup function is called.

• dijit._HasDropDown.autoWidth

  • tags:
  • type

    Boolean

  • summary

    Set to true to make the drop down at least as wide as this
    widget.  Set to false if the drop down should just be its
    default width

• dijit._HasDropDown.forceWidth

  • tags:
  • type

    Boolean

  • summary

    Set to true to make the drop down exactly as wide as this
    widget.  Overrides autoWidth.

• dijit._HasDropDown.maxHeight

  • tags:
  • type

    Integer

  • summary

    The max height for our dropdown.
    Any dropdown taller than this will have scrollbars.
    Set to 0 for no max height, or -1 to limit height to available space in viewport

• dijit._HasDropDown.dropDownPosition

  • tags: const
  • type

    String[]

  • summary

    This variable controls the position of the drop down.
    It's an array of strings with the following values:
    
    * before: places drop down to the left of the target node/widget, or to the right in
    the case of RTL scripts like Hebrew and Arabic
    * after: places drop down to the right of the target node/widget, or to the left in
    the case of RTL scripts like Hebrew and Arabic
    * above: drop down goes above target node
    * below: drop down goes below target node
    
    The list is positions is tried, in order, until a position is found where the drop down fits
    within the viewport.

• dijit._HasDropDown._stopClickEvents

  • type

    Boolean

  • summary

    When set to false, the click events will not be stopped, in
    case you want to use them in your subwidget

• dijit._HasDropDown._onDropDownMouseDown

  • parameters:
    • e: (typeof Event)
  • summary

    Callback when the user mousedown's on the arrow icon

  • type

    Function

• dijit._HasDropDown._docHandler

  • type

    Object

• dijit._HasDropDown._onDropDownMouseUp

  • parameters:
    • e: (typeof Event)
  • summary

    Callback when the user lifts their mouse after mouse down on the arrow icon.
    If the drop is a simple menu and the mouse is over the menu, we execute it, otherwise, we focus our
    dropDown node.  If the event is missing, then we are not
    a mouseup event.
    
    This is useful for the common mouse movement pattern
    with native browser <select> nodes:
    1. mouse down on the select node (probably on the arrow)
    2. move mouse to a menu item while holding down the mouse button
    3. mouse up.  this selects the menu item as though the user had clicked it.

  • type

    Function

• dijit._HasDropDown._onDropDownClick

  • parameters:
    • e: (typeof Event)
  • type

    Function

• dijit._HasDropDown.buildRendering

  • type

    Function

• dijit._HasDropDown.dropDownPosition.0

  • type

    String

• dijit._HasDropDown.postCreate

  • summary

    set up nodes and connect our mouse and keypress events

  • type

    Function

• dijit._HasDropDown.destroy

  • type

    Function

• dijit._HasDropDown._onKey

  • parameters:
    • e: (typeof Event)
  • summary

    Callback when the user presses a key while focused on the button node

  • type

    Function

• dijit._HasDropDown._toggleOnKeyUp

  • type

    Object

• dijit._HasDropDown._onKeyUp

  • type

    Function

• dijit._HasDropDown._onBlur

  • summary

    Called magically when focus has shifted away from this widget and it's dropdown

  • type

    Function

• dijit._HasDropDown.isLoaded

  • summary

    Returns whether or not the dropdown is loaded.  This can
    be overridden in order to force a call to loadDropDown().

  • tags:
  • type

    Function

• dijit._HasDropDown.loadDropDown

  • parameters:
    • loadCallback: (typeof Function)
  • summary

    Loads the data for the dropdown, and at some point, calls
    the given callback.   This is basically a callback when the
    user presses the down arrow button to open the drop down.

  • tags:
  • type

    Function

• dijit._HasDropDown.toggleDropDown

  • summary

    Callback when the user presses the down arrow button or presses
    the down arrow key to open/close the drop down.
    Toggle the drop-down widget; if it is up, close it, if not, open it

  • tags:
  • type

    Function

• dijit._HasDropDown.openDropDown

  • summary

    Opens the dropdown for this widget.   To be called only when this.dropDown
    has been created and is ready to display (ie, it's data is loaded).

  • return_summary

    return value of dijit.popup.open()

  • tags:
  • type

    Function

• dijit._HasDropDown.dropDown.domNode

• dijit._HasDropDown._preparedNode

  • type

    Object

• dijit._HasDropDown._explicitDDWidth

  • type

    Object

• dijit._HasDropDown._explicitDDHeight

  • type

    Object

• dijit._HasDropDown._opened

  • type

    bool

• dijit._HasDropDown.closeDropDown

  • parameters:
    • focus: (typeof Boolean)

      If true, refocuses the button widget

  • summary

    Closes the drop down on this widget

  • tags:
  • type

    Function

• dijit

  • type

    Object