dijit/_base/popup.js

• Provides:

  • dijit._base.popup

• Requires:

  • dijit._base.focus in common
  • dijit._base.place in common
  • dijit._base.window in common

• dijit.BackgroundIframe

  • type

    Function

  • parameters:
    • node: (typeof DomNode)
  • summary

    For IE/FF z-index schenanigans. id attribute is required.

  • description

    new dijit.BackgroundIframe(node)
    Makes a background iframe as a child of node, that fills
    area (and position) of node

• dijit.BackgroundIframe.resize

  • parameters:
    • node
  • summary

    Resize the iframe so it's the same size as node.
    Needed on IE6 and IE/quirks because height:100% doesn't work right.

  • type

    Function

• dijit.BackgroundIframe.destroy

  • summary

    destroy the iframe

  • type

    Function

• dijit.BackgroundIframe.destroy._conn

  • type

    Object

• dijit.popup.__OpenArgs

  • type

    Function

• dijit.popup.__OpenArgs.popup

  • type

    Widget

  • summary

    widget to display

• dijit.popup.__OpenArgs.parent

  • type

    Widget

  • summary

    the button etc. that is displaying this popup

• dijit.popup.__OpenArgs.around

  • type

    DomNode

  • summary

    DOM node (typically a button); place popup relative to this node.  (Specify this *or* "x" and "y" parameters.)

• dijit.popup.__OpenArgs.x

  • type

    Integer

  • summary

    Absolute horizontal position (in pixels) to place node at.  (Specify this *or* "around" parameter.)

• dijit.popup.__OpenArgs.y

  • type

    Integer

  • summary

    Absolute vertical position (in pixels) to place node at.  (Specify this *or* "around" parameter.)

• dijit.popup.__OpenArgs.orient

  • type

    Object|String

  • summary

    When the around parameter is specified, orient should be an
    ordered list of tuples of the form (around-node-corner, popup-node-corner).
    dijit.popup.open() tries to position the popup according to each tuple in the list, in order,
    until the popup appears fully within the viewport.
    
    The default value is {BL:'TL', TL:'BL'}, which represents a list of two tuples:
    1. (BL, TL)
    2. (TL, BL)
    where BL means "bottom left" and "TL" means "top left".
    So by default, it first tries putting the popup below the around node, left-aligning them,
    and then tries to put it above the around node, still left-aligning them.   Note that the
    default is horizontally reversed when in RTL mode.
    
    When an (x,y) position is specified rather than an around node, orient is either
    "R" or "L".  R (for right) means that it tries to put the popup to the right of the mouse,
    specifically positioning the popup's top-right corner at the mouse position, and if that doesn't
    fit in the viewport, then it tries, in order, the bottom-right corner, the top left corner,
    and the top-right corner.

• dijit.popup.__OpenArgs.onCancel

  • type

    Function

  • summary

    callback when user has canceled the popup by
    1. hitting ESC or
    2. by using the popup widget's proprietary cancel mechanism (like a cancel button in a dialog);
    i.e. whenever popupWidget.onCancel() is called, args.onCancel is called

• dijit.popup.__OpenArgs.onClose

  • type

    Function

  • summary

    callback whenever this popup is closed

• dijit.popup.__OpenArgs.onExecute

  • type

    Function

  • summary

    callback when user "executed" on the popup/sub-popup by selecting a menu choice, etc. (top menu only)

• dijit.popup.__OpenArgs.padding

  • type

    dijit.__Position

  • summary

    adding a buffer around the opening position. This is only useful when around is not set.

• dijit.popup

  • summary

    This singleton is used to show/hide widgets as popups.

  • type

    Object

• dijit.popup._stack

  • type

    dijit._Widget[]

  • summary

    Stack of currently popped up widgets.
    (someone opened _stack[0], and then it opened _stack[1], etc.)

• dijit.popup._beginZIndex

  • type

    Number

  • summary

    Z-index of the first popup.   (If first popup opens other
    popups they get a higher z-index.)

• dijit.popup._idGen

  • type

    Number

• dijit.popup._createWrapper

  • parameters:
    • widget: (typeof Widget)

      || DomNode

  • summary

    Initialization for widgets that will be used as popups.
    Puts widget inside a wrapper DIV (if not already in one),
    and returns pointer to that wrapper DIV.

  • type

    Function

• dijit.popup.moveOffScreen

  • parameters:
    • widget: (typeof Widget)

      || DomNode

  • summary

    Moves the popup widget off-screen.
    Do not use this method to hide popups when not in use, because
    that will create an accessibility issue: the offscreen popup is
    still in the tabbing order.

  • type

    Function

• dijit.popup.hide

  • parameters:
    • widget: (typeof dijit._Widget)
  • summary

    Hide this popup widget (until it is ready to be shown).
    Initialization for widgets that will be used as popups
    
    Also puts widget inside a wrapper DIV (if not already in one)
    
    If popup widget needs to layout it should
    do so when it is made visible, and popup._onShow() is called.

  • type

    Function

• dijit.popup.getTopPopup

  • summary

    Compute the closest ancestor popup that's *not* a child of another popup.
    Ex: For a TooltipDialog with a button that spawns a tree of menus, find the popup of the button.

  • type

    Function

• dijit.popup.getTopPopup._stack

• dijit.popup.open

  • parameters:
    • args: (typeof dijit.popup.__OpenArgs)
  • summary

    Popup the widget at the specified position

  • example

    opening at the mouse position
    		dijit.popup.open({popup: menuWidget, x: evt.pageX, y: evt.pageY});

  • example

    opening the widget as a dropdown
    		dijit.popup.open({parent: this, popup: menuWidget, around: this.domNode, onClose: function(){...}});
    
    Note that whatever widget called dijit.popup.open() should also listen to its own _onBlur callback
    (fired from _base/focus.js) to know that focus has moved somewhere else and thus the popup should be closed.

  • type

    Function

• dijit.popup.open._stack

• dijit.popup.close

  • parameters:
    • popup: (typeof dijit._Widget)
  • summary

    Close specified popup and any popups that it parented.
    If no popup is specified, closes all popups.

  • type

    Function

• dijit.popup.close._stack

• dijit._frames

  • type

    Object

• dijit.BackgroundIframe.iframe

  • type

    Object

• dijit.BackgroundIframe._conn

  • type

    Object

• dijit._base.popup

  • type

    Object

• dijit._base

  • type

    Object

• dijit

  • type

    Object