dijit.Dialog
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.)
| parameter | type | description |
|---|---|---|
| params | Object | Optional. |
| srcNodeRef | DomNode|String |
Examples
Example 1
<div dojoType="dijit.Dialog" href="test.html"></div>
Example 2
var foo = new dijit.Dialog({ title: "test dialog", content: "test content" }; dojo.body().appendChild(foo.domNode); foo.startup();
dijit._Contained (from dijit.layout.ContentPane), dijit._Container (from dijit.layout.ContentPane), dijit._Templated, dijit.form._FormMixin, dijit._DialogMixin
FunctionsBack to top
Defined by dijit._Container, dijit.layout.ContentPane
Makes the given widget a child of this widget.
Defined by dijit._Widget
Set or get properties on a widget instance.
Construct the UI for this widget from a template, setting this.domNode.
Defined by dijit._Widget
Connects specified obj/event to specified method of this object
and registers for disconnect() on widget destroy.
Defined by dijit._Widget
Kick off the life-cycle of a widget
Overrides dijit._Widget
Destroy this widget, but not its descendants.
Will, however, destroy internal widgets such as those used within a template.
Destroy all the widgets inside the ContentPane and empty containerNode
Defined by dijit._Widget, dijit.layout.ContentPane
Destroy the ContentPane and it's contents
Defined by dijit._Widget
Destroys the DOM nodes associated with this widget
Defined by dijit._Widget
Disconnects handle created by this.connect.
Also removes handle from this widget's list of connects
Defined by dijit._DialogMixin
User defined function to do stuff when the user hits the submit button
Defined by dijit._Container, dijit.layout.ContentPane
Returns array of children widgets.
Defined by dijit._Widget
Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode.
Defined by dijit._Container
Gets the index of the child in this container or -1 if not found
Defined by dijit._Container
Returns true if widget has children, i.e. if this.containerNode contains something.
hide() Hide the dialog
Defined by dijit._Widget
Return true if this widget can currently be focused
and false if not
layout() Position the Dialog and the underlay
onBlur() Defined by dijit._Widget
stub function. Override or connect to this method to receive
notifications for when the widget moves out of focus.
onCancel() Defined by dijit._DialogMixin
Callback when user has canceled dialog, to notify container
(user shouldn't override)
Defined by dijit._Widget
Connect to this function to receive notifications of mouse click events.
onClose() Defined by dijit._Widget
Callback if someone tries to close the child, child will be closed if func returns true
Defined by dijit.layout.ContentPane
called on DOM faults, require fault etc in content
default is to display errormessage inside pane
Defined by dijit._Widget
Connect to this function to receive notifications of mouse double click events.
Defined by dijit.layout.ContentPane
Called when download error occurs, default is to display
errormessage inside pane. Overide function to change that.
The string returned by this function will be the html
that tells the user a error happend
Defined by dijit.layout.ContentPane
called before download starts
the string returned by this function will be the html
that tells the user we are loading something
override with your own function if you want to change text
Defined by dijit._DialogMixin
Callback when user is about to execute dialog, to notify container
(user shouldn't override)
onFocus() Defined by dijit._Widget
stub function. Override or connect to this method to receive
notifications for when the widget moves into focus.
Defined by dijit._Widget
Connect to this function to receive notifications of keys being pressed down.
Defined by dijit._Widget
Connect to this function to receive notifications of printable keys being typed.
Defined by dijit._Widget
Connect to this function to receive notifications of keys being released.
onLoad(data) Overrides dijit.layout.ContentPane
when href is specified we need to reposition the dialog after the data is loaded
Defined by dijit._Widget
Connect to this function to receive notifications of when the mouse button is pressed down.
Defined by dijit._Widget
Connect to this function to receive notifications of when the mouse moves onto this widget.
Defined by dijit._Widget
Connect to this function to receive notifications of when the mouse moves off of this widget.
Defined by dijit._Widget
Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget.
Defined by dijit._Widget
Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget.
Defined by dijit._Widget
Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget.
Defined by dijit._Widget
Connect to this function to receive notifications of when the mouse button is released.
Defined by dijit._Widget
Place this widget's domNode reference somewhere in the DOM based
on standard dojo.place conventions, or passing a Widget reference that
contains and addChild member.
Overrides dijit._Widget, dijit.layout.ContentPane
Called after a widget's dom has been setup
Overrides dijit._Widget, dijit.layout.ContentPane
Called after the parameters to the widget have been read-in,
but before the widget template is instantiated. Especially
useful to set properties that are referenced in the widget
template.
Defined by dijit._Widget
kicks off widget instantiation, see create() for details.
Defined by dijit._Container
Removes the passed widget instance from this widget but does
not destroy it. You can also pass in an integer indicating
the index within the container to remove
resize(size) Defined by dijit.layout.ContentPane
Defined by dijit._Widget
Defined by dijit.layout.ContentPane
Defined by dijit.layout.ContentPane
show() display the dialog
startup() Defined by dijit._Widget, dijit.layout.ContentPane
Called after a widget's children, and other widgets on the page, have been created.
Provides an opportunity to manipulate any children before they are displayed.
This is useful for composite widgets that need to control or layout sub-widgets.
Many layout widgets can use this as a wiring phase.
toString() Defined by dijit._Widget
returns a string that represents the widget. When a widget is
cast to a string, this method will be used to generate the
output. Currently, it does not implement any sort of reversable
serialization.
Overrides dijit._Widget
stub function. Override to implement custom widget tear-down
behavior.
Defined by dijit._Widget
Step during widget creation to copy all widget attributes to the
DOM as per attributeMap and _setXXXAttr functions.
Defined by dijit._Templated
Iterate through the template and attach functions and nodes accordingly.
Defined by dijit._Widget
Reflect a widget attribute (title, tabIndex, duration etc.) to
the widget DOM, as specified in attributeMap.
Defined by dijit.layout.ContentPane
Test if we have exactly one visible widget as a child,
and if so assume that we are a container for that widget,
and should propogate startup() and resize() calls to it.
Skips over things like data stores since they aren't visible.
_endDrag(e) Called after dragging the Dialog. Calculates the relative offset
of the Dialog in relation to the viewport.
Defined by dijit._Templated
relocate source contents to templated container node
this.containerNode must be able to receive children, or exceptions will be thrown
_firstElement(node) Defined by dijit._Container
_getAttrNames(name) Defined by dijit._Widget
helper function for Widget.attr()
cache attribute name values so we don't do the string ops every time
Defined by dijit._Widget
Search subtree under root, putting found widgets in outAry
Defined by dijit._DialogMixin
Defined by dijit._Container
Get the next or previous widget sibling of child
Defined by dijit.layout.ContentPane
Since I am a Container widget, each of my children expects me to
call resize() or layout() on them.
_nextElement(node) Defined by dijit._Container
_onBlur() Defined by dijit._Widget
Defined by dijit._Widget
Called when someone connects to one of my handlers.
"Turn on" that handler if it isn't active yet.
_onError(type, err, consoleText) Defined by dijit.layout.ContentPane
_onFocus(e) Defined by dijit._Widget
_onLoadHandler(data) Defined by dijit.layout.ContentPane
This is called whenever new content is being loaded
Defined by dijit.layout.ContentPane
This is called whenever the content is being unloaded
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.
Defined by dijit.layout.ContentPane
Call resize() on each of my child layout widgets, either now
(if I'm currently visible) or when I become visible
Defined by dijit._Widget
_setContent(cont, isFakeContent) Defined by dijit.layout.ContentPane
Insert the content into the container node
Defined by dijit.layout.ContentPane
Hook to make attr("content", ...) work.
Replaces old content with data content, include style classes from old content
Defined by dijit._Widget
_setup() stuff we need to do before showing the Dialog for the first
time (but we defer it until right beforehand, for
performance reasons)
_size() Make sure the dialog is small enough to fit in viewport.
_stringRepl(tmpl) Defined by dijit._Templated
PropertiesBack to top
Overrides dijit._Widget, dijit._DialogMixin
attributeMap sets up a "binding" between attributes (aka properties)
of the widget and the widget's DOM.
Changes to widget attributes listed in attributeMap will be
reflected into the DOM.
For example, calling attr('title', 'hello')
on a TitlePane will automatically cause the TitlePane's DOM to update
with the new title.
attributeMap is a hash where the key is an attribute of the widget,
and the value reflects a binding to a:
- DOM node attribute
focus: {node: "focusNode", type: "attribute"}
Maps this.focus to this.focusNode.focus
- DOM node innerHTML
title: { node: "titleNode", type: "innerHTML" }
Maps this.title to this.titleNode.innerHTML
- DOM node CSS class
myClass: { node: "domNode", type: "class" }
Maps this.myClass to this.domNode.className
If the value is an array, then each element in the array matches one of the
formats of the above list.
There are also some shorthands for backwards compatibility:
- string --> { node: string, type: "attribute" }, for example:
"focusNode" ---> { node: "focusNode", type: "attribute" }
- "" --> { node: "domNode", type: "attribute" }
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
Defined by dijit.layout.ContentPane
Defined by dijit._Widget
Designates where children of the source dom node will be placed.
"Children" in this case refers to both dom nodes and widgets.
For example, for myWidget:
<div dojoType=myWidget>
<b> here's a plain dom node
<span dojoType=subWidget>and a widget</span>
<i> and another plain dom node </i>
</div>
containerNode would point to:
<b> here's a plain dom node
<span dojoType=subWidget>and a widget</span>
<i> and another plain dom node </i>
In templated widgets, "containerNode" is set via a
dojoAttachPoint assignment.
containerNode must be defined for any widget that accepts innerHTML
(like ContentPane or BorderContainer or even Button), and conversely
is null for widgets that don't, like TextBox.
Defined by dijit.layout.ContentPane
Defined by dijit.layout.ContentPane
The innerHTML of the ContentPane.
Note that the initialization parameter / argument to attr("content", ...)
can be a String, DomNode, Nodelist, or widget.
Defined by dijit._Widget
Unsupported by Dijit, but here for completeness. Dijit only supports setting text direction on the
entire document.
Bi-directional support, as defined by the [HTML DIR](http://www.w3.org/TR/html401/struct/dirlang.html#adef-dir)
attribute. Either left-to-right "ltr" or right-to-left "rtl".
Defined by dijit._Widget
Defined by dijit._Widget
Overrides dijit.layout.ContentPane
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.
Defined by dijit._Widget, dijit._Templated
This is our visible representation of the widget! Other DOM
Nodes may by assigned to other properties, usually through the
template system's dojoAttachPoint syntax, but the domNode
property is the canonical "top level" node in widget UI.
Defined by dijit.layout.ContentPane
Toggles the moveable aspect of the Dialog. If true, Dialog
can be moved by it's title. If false it will remain centered
in the viewport.
The time in milliseconds it takes the dialog to fade in and out
Defined by dijit.layout.ContentPane
Extract visible content from inside of <body> .... </body>
Defined by dijit.layout.ContentPane
Defined by dijit._Widget
a unique, opaque ID string that can be assigned by users or by the
system. If the developer passes an ID which is known not to be
unique, the specified ID is ignored and the system-generated ID is
used instead.
Defined by dijit.layout.ContentPane
Parameters to pass to xhrGet() request, for example:
<div dojoType="dijit.layout.ContentPane" href="./bar" ioArgs="{timeout: 500}">
Defined by dijit._Container
Defined by dijit.layout.ContentPane
True if the ContentPane has data in it, either specified
during initialization (via href or inline content), or set
via attr('content', ...) / attr('href', ...)
False if it doesn't have any content, or if ContentPane is
still in the process of downloading href.
Defined by dijit._Widget
Rarely used. Overrides the default Dojo locale used to render this widget,
as defined by the [HTML LANG](http://www.w3.org/TR/html401/struct/dirlang.html#adef-lang) attribute.
Value must be among the list of locales specified during by the Dojo bootstrap,
formatted according to [RFC 3066](http://www.ietf.org/rfc/rfc3066.txt) (like en-us).
Defined by dijit._Widget
Defined by dijit._Widget
Defined by dijit._Widget
Defined by dijit._Widget
is True or False depending on state of dialog
Defined by dijit._Widget
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
Defined by dijit.layout.ContentPane
Refresh (re-download) content when pane goes from hidden to shown
Defined by dijit._Widget
Defined by dijit._Widget
Defined by dijit._Widget
Defined by dijit._Widget
Defined by dijit._Widget
Defined by dijit._Widget
Overrides dijit._Templated
Path to template (HTML file) for this widget relative to dojo.baseUrl
Overrides dijit._Templated
Defined by dijit._Widget
Defined by dijit._Widget
Defined by dijit._Widget
Defined by dijit._Templated
should we parse the template to find widgets that might be
declared in markup inside it? false by default.
Defined by dijit._Widget
Defined by dijit.layout.ContentPane
Defined by dijit._Widget
Defined by dijit._Widget
Defined by dijit.layout.ContentPane
Defined by dijit.layout.ContentPane
Defined by dijit._Widget
Defined by dijit._Widget
attributeMap addendum for event handlers that should be connected only on first use
Defined by dijit.layout.ContentPane
Defined by dijit.layout.ContentPane
Defined by dijit.layout.ContentPane
Defined by dijit.layout.ContentPane
Defined by dijit._Templated
Defined by dijit._Widget
Defined by dijit._Templated
Defined by dijit.layout.ContentPane
Defined by dijit.layout.ContentPane
