dijit/Dialog.js

• Provides:

  • dijit.Dialog

• Requires:

  • dojo.dnd.move in common
  • dojo.dnd.TimedMoveable in common
  • dojo.fx in common
  • dojo.window in common
  • dijit._Widget in common
  • dijit._Templated in common
  • dijit._CssStateMixin in common
  • dijit.form._FormMixin in common
  • dijit._DialogMixin in common
  • dijit.DialogUnderlay in common
  • dijit.layout.ContentPane in common
  • dijit.TooltipDialog in common

• dijit._DialogBase

  • type

    Function

  • chains:
    • dijit._Templated: (prototype)
    • dijit.form._FormMixin.prototype: (prototype)
    • dijit._DialogMixin.prototype: (prototype)
    • dijit._CssStateMixin.prototype: (prototype)
    • dijit._Templated: (call)
    • dijit.form._FormMixin: (call)
    • dijit._DialogMixin: (call)
    • dijit._CssStateMixin: (call)
  • summary

    A modal dialog Widget

  • description

    Pops up a modal dialog window, blocking access to the screen
    and also graying out the screen Dialog is extended from
    ContentPane so it supports all the same parameters (href, etc.)

  • example

    	<div dojoType="dijit.Dialog" href="test.html"></div>

  • example

    	var foo = new dijit.Dialog({ title: "test dialog", content: "test content" };
    	dojo.body().appendChild(foo.domNode);
    	foo.startup();

• dijit._DialogBase.templateString

  • type

    Object

• dijit._DialogBase.baseClass

  • type

    String

• dijit._DialogBase.cssStateNodes

  • type

    Object

• dijit._DialogBase.cssStateNodes.closeButtonNode

  • type

    String

• dijit._DialogBase.attributeMap

  • type

    Object

• dijit._DialogBase.open

  • tags: readonly
  • type

    Boolean

  • summary

    True if Dialog is currently displayed on screen.

• dijit._DialogBase.duration

  • alias - dijit.defaultDuration
  • type

    Integer

  • summary

    The time in milliseconds it takes the dialog to fade in and out

• dijit._DialogBase.refocus

  • type

    Boolean

  • summary

    A Toggle to modify the default focus behavior of a Dialog, which
    is to re-focus the element which had focus before being opened.
    False will disable refocusing. Default: true

• dijit._DialogBase.autofocus

  • type

    Boolean

  • summary

    A Toggle to modify the default focus behavior of a Dialog, which
    is to focus on the first dialog element after opening the dialog.
    False will disable autofocusing. Default: true

• dijit._DialogBase._firstFocusItem

  • tags: readonly
  • type

    DomNode

  • summary

    The pointer to the first focusable node in the dialog.
    Set by <code>dijit._DialogMixin._getFocusItems</code>.

• dijit._DialogBase._lastFocusItem

  • tags: readonly
  • type

    DomNode

  • summary

    The pointer to which node has focus prior to our dialog.
    Set by <code>dijit._DialogMixin._getFocusItems</code>.

• dijit._DialogBase.doLayout

  • tags:
  • type

    Boolean

  • summary

    Don't change this parameter from the default value.
    This ContentPane parameter doesn't make sense for Dialog, since Dialog
    is never a child of a layout container, nor can you specify the size of
    Dialog in order to control the size of an inner widget.

• dijit._DialogBase.draggable

  • type

    Boolean

  • summary

    Toggles the moveable aspect of the Dialog. If true, Dialog
    can be dragged by it's title. If false it will remain centered
    in the viewport.

• dijit._DialogBase.aria-describedby

  • type

    String

  • summary

    Allows the user to add an aria-describedby attribute onto the dialog.   The value should
    be the id of the container element of text that describes the dialog purpose (usually
    the first text in the dialog).
    <div dojoType="dijit.Dialog" aria-describedby="intro" .....>
    <div id="intro">Introductory text</div>
    <div>rest of dialog contents</div>
    </div>

• dijit._DialogBase.postMixInProperties

  • type

    Function

• dijit._DialogBase.postCreate

  • type

    Function

• dijit._DialogBase._modalconnects

  • type

    Array

• dijit._DialogBase.onLoad

  • summary

    Called when data has been loaded from an href.
    Unlike most other callbacks, this function can be connected to (via <code>dojo.connect</code>)
    but should *not* be overridden.

  • tags: callback
  • type

    Function

• dijit._DialogBase._endDrag

  • parameters:
    • e
  • summary

    Called after dragging the Dialog. Saves the position of the dialog in the viewport.

  • tags:
  • type

    Function

• dijit._DialogBase._relativePosition

  • type

    Object

• dijit._DialogBase._setup

  • summary

    Stuff we need to do before showing the Dialog for the first
    time (but we defer it until right beforehand, for
    performance reasons).

  • tags:
  • type

    Function

• dijit._DialogBase.domNode

• dijit._DialogBase._moveable

• dijit._DialogBase._dndListener

  • type

    Object

• dijit._DialogBase.underlayAttrs

  • type

    Object

• dijit._DialogBase._size

  • summary

    If necessary, shrink dialog contents so dialog fits in viewport

  • tags:
  • type

    Function

• dijit._DialogBase._singleChild.domNode.style.cssText

• dijit._DialogBase._singleChildOriginalStyle

• dijit._DialogBase._position

  • summary

    Position modal dialog in the viewport. If no relative offset
    in the viewport has been determined (by dragging, for instance),
    center the node. Otherwise, use the Dialog's stored relative offset,
    and position the node to top: left: values based on the viewport.

  • tags:
  • type

    Function

• dijit._DialogBase._onKey

  • parameters:
    • evt: (typeof Event)
  • returns

    just let it go

  • summary

    Handles the keyboard events for accessibility reasons

  • tags:
  • type

    Function

• dijit._DialogBase.show

  • summary

    Display the dialog

  • return_summary

    dojo.Deferred
    Deferred object that resolves when the display animation is complete

  • type

    Function

• dijit._DialogBase._alreadyInitialized

  • type

    Object

• dijit._DialogBase._fadeInDeferred

  • type

    Object

• dijit._DialogBase.hide

  • summary

    Hide the dialog

  • return_summary

    dojo.Deferred
    Deferred object that resolves when the hide animation is complete

  • type

    Function

• dijit._DialogBase._fadeOutDeferred

  • type

    Object

• dijit._DialogBase._scrollConnected

  • type

    bool

• dijit._DialogBase.layout

  • summary

    Position the Dialog and the underlay

  • tags:
  • type

    Function

• dijit._DialogBase.destroy

  • type

    Function

• dijit.Dialog

  • type

    Function

  • chains:
    • dijit.layout.ContentPane: (prototype)
    • dijit._DialogBase.prototype: (prototype)
    • dijit.layout.ContentPane: (call)
    • dijit._DialogBase: (call)

• dijit._underlay

  • parameters:
    • kwArgs
  • summary

    A shared instance of a <code>dijit.DialogUnderlay</code>

  • description

    A shared instance of a `dijit.DialogUnderlay` created and
    used by `dijit.Dialog`, though never created until some Dialog
    or subclass thereof is shown.

  • type

    Function

• dijit._DialogLevelManager

  • summary

    Controls the various active "levels" on the page, starting with the
    stuff initially visible on the page (at z-index 0), and then having an entry for
    each Dialog shown.

  • type

    Object

• dijit._DialogLevelManager.show

  • parameters:
    • dialog: (typeof dijit._Widget)
    • underlayAttrs: (typeof Object)
  • summary

    Call right before fade-in animation for new dialog.
    Saves current focus, displays/adjusts underlay for new dialog,
    and sets the z-index of the dialog itself.
    
    New dialog will be displayed on top of all currently displayed dialogs.
    
    Caller is responsible for setting focus in new dialog after the fade-in
    animation completes.

  • type

    Function

• dijit._DialogLevelManager.hide

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

    Called when the specified dialog is hidden/destroyed, after the fade-out
    animation ends, in order to reset page focus, fix the underlay, etc.
    If the specified dialog isn't open then does nothing.
    
    Caller is responsible for either setting display:none on the dialog domNode,
    or calling dijit.popup.hide(), or removing it from the page DOM.

  • type

    Function

• dijit._DialogLevelManager.isTop

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

    Returns true if specified Dialog is the top in the task

  • type

    Function

• dijit._dialogStack

  • alias - dijit._dialogStack
  • type

    Array

• dijit

  • type

    Object