webgui/www/extras/yui/docs/YAHOO.widget.Dialog.html
JT Smith 20f8df1291 upgrading to YUI 2.6
data tables are going to need some work yet, but the other stuff seems to be working 100%
2008-10-22 23:53:29 +00:00

2213 lines
124 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>API: container YAHOO.widget.Dialog (YUI Library)</title>
<link rel="stylesheet" type="text/css" href="assets/api.css">
<script type="text/javascript" src="assets/api-js"></script>
<script type="text/javascript" src="assets/ac-js"></script>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<a href="http://developer.yahoo.com/yui/"><h1>Yahoo! UI Library</h1></a>
<h3>Container&nbsp; <span class="subtitle">2.6.0</span></h3>
<p>
<a href="./index.html">Yahoo! UI Library</a>
&gt; <a href="./module_container.html">container</a>
&gt; YAHOO.widget.Dialog
</p>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form name="yui-classopts-form">
<span id="classopts"><input type="checkbox" name="showprivate" id="showprivate" /> <label for="showprivate">Show Private</label></span>
<span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> <label for="showprotected">Show Protected</label></span>
<span id="classopts"><input type="checkbox" name="showdeprecated" id="showdeprecated" /> <label for="showdeprecated">Show Deprecated</label></span>
</form>
<h2>
Class <b>YAHOO.widget.Dialog</b>
<span class="extends">
- extends <a href="YAHOO.widget.Panel.html">YAHOO.widget.Panel</a>
</span>
<span class="extends">
</span>
</code>
</h2>
<!-- class tree goes here -->
<dl class="subclasses">
<dt>Known Subclasses:</dd>
<dd>
<a href="YAHOO.widget.SimpleDialog.html">YAHOO.widget.SimpleDialog</a>
</dd>
</dl>
<div class="summary description">
<p>
Dialog is an implementation of Panel that can be used to submit form
data.
</p>
<p>
Built-in functionality for buttons with event handlers is included.
If the optional YUI Button dependancy is included on the page, the buttons
created will be instances of YAHOO.widget.Button, otherwise regular HTML buttons
will be created.
</p>
<p>
Forms can be processed in 3 ways -- via an asynchronous Connection utility call,
a simple form POST or GET, or manually. The YUI Connection utility should be
included if you're using the default "async" postmethod, but is not required if
you're using any of the other postmethod values.
</p>
</div>
<div class="section constructor details">
<h3 id="constructor">Constructor</h3>
<div class="content">
<div class="detail">
<strong>YAHOO.widget.Dialog</strong>
<code>
(
el
,
userConfig
)
</code>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>el
&lt;String&gt;
</code>
The element ID representing the Dialog <em>OR</em>
</dd>
<dd>
<code>el
&lt;HTMLElement&gt;
</code>
The element representing the Dialog
</dd>
<dd>
<code>userConfig
&lt;Object&gt;
</code>
The configuration object literal containing
the configuration that should be set for this Dialog. See configuration
documentation for more details.
</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="section field details">
<h3 id="properties">Properties</h3>
<div class="content">
<div class="">
<h4><a name="property_callback">callback</a>
<code>- Object</code>
</h4>
<div class="detail">
<div class="description">
The internally maintained callback object for use with the
Connection utility. The format of the callback object is
similar to Connection Manager's callback object and is
simply passed through to Connection Manager when the async
request is made.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_callback.argument">callback.argument</a>
<code>- Object</code>
</h4>
<div class="detail">
<div class="description">
The arbitraty argument or arguments to pass to the Connection
callback functions
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_callback.failure">callback.failure</a>
<code>- Function</code>
</h4>
<div class="detail">
<div class="description">
The function to execute upon failure of the
Connection submission
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_callback.success">callback.success</a>
<code>- Function</code>
</h4>
<div class="detail">
<div class="description">
The function to execute upon success of the
Connection submission (when the form does not
contain a file input element).
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_callback.upload">callback.upload</a>
<code>- Function</code>
</h4>
<div class="detail">
<div class="description">
<p>
The function to execute upon success of the
Connection submission, when the form contains
a file input element.
</p>
<p>
<em>NOTE:</em> Connection manager will not
invoke the success or failure handlers for the file
upload use case. This will be the only callback
handler invoked.
</p>
<p>
For more information, see the <a href="http://developer.yahoo.com/yui/connection/#file">
Connection Manager documenation on file uploads</a>.
</p>
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property_DEFAULT_CONFIG">DEFAULT_CONFIG</a>
<code>- private final Object</code>
</h4>
<div class="detail">
<div class="description">
Constant representing the Dialog's configuration properties
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property_EVENT_TYPES">EVENT_TYPES</a>
<code>- private final Object</code>
</h4>
<div class="detail">
<div class="description">
Constant representing the name of the Dialog's events
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_form">form</a>
<code>- <a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-40002357">HTMLFormElement</a></code>
</h4>
<div class="detail">
<div class="description">
Object reference to the Dialog's
<code>&#60;form&#62;</code> element.
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
<div class="">
<h4><a name="property_YAHOO.widget.Dialog.CSS_DIALOG">YAHOO.widget.Dialog.CSS_DIALOG</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Constant representing the default CSS class used for a Dialog
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<h4>Properties inherited from <a href="YAHOO.widget.Panel.html">YAHOO.widget.Panel</a>:</h4>
<div class="content">
<code>
<a class="private" href="YAHOO.widget.Panel.html#property_DEFAULT_CONFIG">DEFAULT_CONFIG</a><span class="private">,</span>
<a class="private" href="YAHOO.widget.Panel.html#property_EVENT_TYPES">EVENT_TYPES</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Properties inherited from <a href="YAHOO.widget.Module.html">YAHOO.widget.Module</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.widget.Module.html#property_body">body</a><span class="">,</span>
<a class=" deprecated" href="YAHOO.widget.Module.html#property_browser">browser</a><span class=" deprecated">,</span>
<a class="" href="YAHOO.widget.Module.html#property_cfg">cfg</a><span class="">,</span>
<a class="" href="YAHOO.widget.Module.html#property_contructor">contructor</a><span class="">,</span>
<a class="private" href="YAHOO.widget.Module.html#property_DEFAULT_CONFIG">DEFAULT_CONFIG</a><span class="private">,</span>
<a class="" href="YAHOO.widget.Module.html#property_element">element</a><span class="">,</span>
<a class="private" href="YAHOO.widget.Module.html#property_EVENT_TYPES">EVENT_TYPES</a><span class="private">,</span>
<a class="" href="YAHOO.widget.Module.html#property_footer">footer</a><span class="">,</span>
<a class="" href="YAHOO.widget.Module.html#property_header">header</a><span class="">,</span>
<a class="" href="YAHOO.widget.Module.html#property_id">id</a><span class="">,</span>
<a class=" deprecated" href="YAHOO.widget.Module.html#property_imageRoot">imageRoot</a><span class=" deprecated">,</span>
<a class="" href="YAHOO.widget.Module.html#property_isSecure">isSecure</a><span class="">,</span>
<a class="" href="YAHOO.widget.Module.html#property_platform">platform</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Properties inherited from <a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.widget.Overlay.html#property_CONTEXT_TRIGGERS">CONTEXT_TRIGGERS</a><span class="">,</span>
<a class="private" href="YAHOO.widget.Overlay.html#property_DEFAULT_CONFIG">DEFAULT_CONFIG</a><span class="private">,</span>
<a class="private" href="YAHOO.widget.Overlay.html#property_EVENT_TYPES">EVENT_TYPES</a><span class="private">,</span>
<a class="private" href="YAHOO.widget.Overlay.html#property_YAHOO.widget.Overlay._initialized">YAHOO.widget.Overlay._initialized</a>
</code>
</div>
</div>
<div class="section method details">
<h3 id="methods">Methods</h3>
<div class="content">
<div class="protected">
<h4>
<a name="method__doClose">_doClose</a></h4>
<div class="detail">
<code>
protected
void
<strong>_doClose</strong>
(
e
)
</code>
<div class="description">
Event handler for the close icon
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;DOMEvent&gt;</code>
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__getButton">_getButton</a></h4>
<div class="detail">
<code>
private
YAHOO.widget.Button|HTMLElement
<strong>_getButton</strong>
(
button
)
</code>
<div class="description">
Helper method to normalize button references. It either returns the
YUI Button instance for the given element if found,
or the passes back the HTMLElement reference if a corresponding YUI Button
reference is not found or YAHOO.widget.Button does not exist on the page.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>button &lt;HTMLElement&gt;</code>
</dd>
</dl>
<dl>
<dt>Returns:
<code>
YAHOO.widget.Button|HTMLElement
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="protected">
<h4>
<a name="method__getFormAttributes">_getFormAttributes</a></h4>
<div class="detail">
<code>
protected
Object
<strong>_getFormAttributes</strong>
(
oForm
)
</code>
<div class="description">
Retrieves important attributes (currently method and action) from
the form element, accounting for any elements which may have the same name
as the attributes. Defaults to "POST" and "" for method and action respectively
if the attribute cannot be retrieved.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oForm &lt;HTMLFormElement&gt;</code>
The HTML Form element from which to retrieve the attributes
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Object
</code></dt>
<dd>Object literal, with method and action String properties.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="protected">
<h4>
<a name="method__submitHandler">_submitHandler</a></h4>
<div class="detail">
<code>
protected
void
<strong>_submitHandler</strong>
(
e
)
</code>
<div class="description">
Internal handler for the form submit event
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;DOMEvent&gt;</code>
The DOM Event object
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_blurButtons">blurButtons</a></h4>
<div class="detail">
<code>
void
<strong>blurButtons</strong>
(
)
</code>
<div class="description">
Blurs all the buttons defined via the "buttons"
configuration property.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_cancel">cancel</a></h4>
<div class="detail">
<code>
void
<strong>cancel</strong>
(
)
</code>
<div class="description">
Executes the cancel of the Dialog followed by a hide.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_configButtons">configButtons</a></h4>
<div class="detail">
<code>
void
<strong>configButtons</strong>
(
type
,
args
,
obj
)
</code>
<div class="description">
The default event handler for the "buttons" configuration property
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>type &lt;String&gt;</code>
The CustomEvent type (usually the property name)
</dd>
<dd>
<code>args &lt;Object[]&gt;</code>
The CustomEvent arguments. For configuration
handlers, args[0] will equal the newly applied value for the property.
</dd>
<dd>
<code>obj &lt;Object&gt;</code>
The scope object. For configuration handlers,
this will usually equal the owner.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_configClose">configClose</a></h4>
<div class="detail">
<code>
void
<strong>configClose</strong>
(
type
,
args
,
obj
)
</code>
<div class="description">
The default event handler fired when the "close" property is
changed. The method controls the appending or hiding of the close
icon at the top right of the Dialog.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>type &lt;String&gt;</code>
The CustomEvent type (usually the property name)
</dd>
<dd>
<code>args &lt;Object[]&gt;</code>
The CustomEvent arguments. For
configuration handlers, args[0] will equal the newly applied value
for the property.
</dd>
<dd>
<code>obj &lt;Object&gt;</code>
The scope object. For configuration handlers,
this will usually equal the owner.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_configPostMethod">configPostMethod</a></h4>
<div class="detail">
<code>
void
<strong>configPostMethod</strong>
(
type
,
args
,
obj
)
</code>
<div class="description">
The default event handler for the "postmethod" configuration property
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>type &lt;String&gt;</code>
The CustomEvent type (usually the property name)
</dd>
<dd>
<code>args &lt;Object[]&gt;</code>
The CustomEvent arguments. For
configuration handlers, args[0] will equal the newly applied value
for the property.
</dd>
<dd>
<code>obj &lt;Object&gt;</code>
The scope object. For configuration handlers,
this will usually equal the owner.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_destroy">destroy</a></h4>
<div class="detail">
<code>
void
<strong>destroy</strong>
(
)
</code>
<div class="description">
Removes the Panel element from the DOM and sets all child elements
to null.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_doSubmit">doSubmit</a></h4>
<div class="detail">
<code>
void
<strong>doSubmit</strong>
(
)
</code>
<div class="description">
Submits the Dialog's form depending on the value of the
"postmethod" configuration property. <strong>Please note:
</strong> As of version 2.3 this method will automatically handle
asyncronous file uploads should the Dialog instance's form contain
<code>&#60;input type="file"&#62;</code> elements. If a Dialog
instance will be handling asyncronous file uploads, its
<code>callback</code> property will need to be setup with a
<code>upload</code> handler rather than the standard
<code>success</code> and, or <code>failure</code> handlers. For more
information, see the <a href="http://developer.yahoo.com/yui/
connection/#file">Connection Manager documenation on file uploads</a>.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_focusDefaultButton">focusDefaultButton</a></h4>
<div class="detail">
<code>
void
<strong>focusDefaultButton</strong>
(
)
</code>
<div class="description">
Sets the focus to the button that is designated as the default via
the "buttons" configuration property. By default, this method is
called when the Dialog is made visible.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_focusFirst">focusFirst</a></h4>
<div class="detail">
<code>
void
<strong>focusFirst</strong>
(
)
</code>
<div class="description">
Sets focus to the first element in the Dialog's form or the first
button defined via the "buttons" configuration property. Called
when the Dialog is made visible.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_focusFirstButton">focusFirstButton</a></h4>
<div class="detail">
<code>
void
<strong>focusFirstButton</strong>
(
)
</code>
<div class="description">
Sets the focus to the first button created via the "buttons"
configuration property.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_focusLast">focusLast</a></h4>
<div class="detail">
<code>
void
<strong>focusLast</strong>
(
)
</code>
<div class="description">
Sets focus to the last element in the Dialog's form or the last
button defined via the "buttons" configuration property.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_focusLastButton">focusLastButton</a></h4>
<div class="detail">
<code>
void
<strong>focusLastButton</strong>
(
)
</code>
<div class="description">
Sets the focus to the last button created via the "buttons"
configuration property.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getButtons">getButtons</a></h4>
<div class="detail">
<code>
Array
<strong>getButtons</strong>
(
)
</code>
<div class="description">
Returns an array containing each of the Dialog's
buttons, by default an array of HTML <code>&#60;BUTTON&#62;</code>
elements. If the Dialog's buttons were created using the
YAHOO.widget.Button class (via the inclusion of the optional Button
dependancy on the page), an array of YAHOO.widget.Button instances
is returned.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
Array
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getData">getData</a></h4>
<div class="detail">
<code>
Object
<strong>getData</strong>
(
)
</code>
<div class="description">
Returns a JSON-compatible data structure representing the data
currently contained in the form.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
Object
</code></dt>
<dd>A JSON object reprsenting the data of the
current form.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_init">init</a></h4>
<div class="detail">
<code>
void
<strong>init</strong>
(
el
,
userConfig
)
</code>
<div class="description">
The Dialog initialization method, which is executed for Dialog and
all of its subclasses. This method is automatically called by the
constructor, and sets up all DOM references for pre-existing markup,
and creates required markup if it is not already present.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>el &lt;String&gt;</code>
The element ID representing the Dialog <em>OR</em>
</dd>
<dd>
<code>el &lt;HTMLElement&gt;</code>
The element representing the Dialog
</dd>
<dd>
<code>userConfig &lt;Object&gt;</code>
The configuration object literal
containing the configuration that should be set for this Dialog.
See configuration documentation for more details.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_initDefaultConfig">initDefaultConfig</a></h4>
<div class="detail">
<code>
void
<strong>initDefaultConfig</strong>
(
)
</code>
<div class="description">
Initializes the class's configurable properties which can be changed
using the Dialog's Config object (cfg).
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_initEvents">initEvents</a></h4>
<div class="detail">
<code>
void
<strong>initEvents</strong>
(
)
</code>
<div class="description">
Initializes the custom events for Dialog which are fired
automatically at appropriate times by the Dialog class.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_registerForm">registerForm</a></h4>
<div class="detail">
<code>
void
<strong>registerForm</strong>
(
)
</code>
<div class="description">
Prepares the Dialog's internal FORM object, creating one if one is
not currently present.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_setFirstLastFocusable">setFirstLastFocusable</a></h4>
<div class="detail">
<code>
void
<strong>setFirstLastFocusable</strong>
(
)
</code>
<div class="description">
Configures instance properties, pointing to the
first and last focusable elements in the Dialog's form.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_setTabLoop">setTabLoop</a></h4>
<div class="detail">
<code>
void
<strong>setTabLoop</strong>
(
firstElement
,
lastElement
)
</code>
<div class="description">
Sets up a tab, shift-tab loop between the first and last elements
provided. NOTE: Sets up the preventBackTab and preventTabOut KeyListener
instance properties, which are reset everytime this method is invoked.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>firstElement &lt;HTMLElement&gt;</code>
</dd>
<dd>
<code>lastElement &lt;HTMLElement&gt;</code>
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_submit">submit</a></h4>
<div class="detail">
<code>
void
<strong>submit</strong>
(
)
</code>
<div class="description">
Executes a submit of the Dialog if validation
is successful. By default the Dialog is hidden
after submission, but you can set the "hideaftersubmit"
configuration property to false, to prevent the Dialog
from being hidden.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_toString">toString</a></h4>
<div class="detail">
<code>
String
<strong>toString</strong>
(
)
</code>
<div class="description">
Returns a string representation of the object.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
String
</code></dt>
<dd>The string representation of the Dialog</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_validate">validate</a></h4>
<div class="detail">
<code>
void
<strong>validate</strong>
(
)
</code>
<div class="description">
Built-in function hook for writing a validation function that will
be checked for a "true" value prior to a submit. This function, as
implemented by default, always returns true, so it should be
overridden if validation is necessary.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<h4>Methods inherited from <a href="YAHOO.widget.Panel.html">YAHOO.widget.Panel</a>:</h4>
<div class="content">
<code>
<a class="protected" href="YAHOO.widget.Panel.html#method__addFocusHandlers">_addFocusHandlers</a><span class="protected">,</span> <a class="protected" href="YAHOO.widget.Panel.html#method__autoFillOnHeightChange">_autoFillOnHeightChange</a><span class="protected">,</span> <a class="private" href="YAHOO.widget.Panel.html#method__createHiddenFocusElement">_createHiddenFocusElement</a><span class="private">,</span> <a class="protected" href="YAHOO.widget.Panel.html#method__doClose">_doClose</a><span class="protected">,</span> <a class="private" href="YAHOO.widget.Panel.html#method__onElementFocus">_onElementFocus</a><span class="private">,</span> <a class="protected" href="YAHOO.widget.Panel.html#method__removeFocusHandlers">_removeFocusHandlers</a><span class="protected">,</span> <a class="" href="YAHOO.widget.Panel.html#method_buildMask">buildMask</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#method_buildWrapper">buildWrapper</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#method_configClose">configClose</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#method_configDraggable">configDraggable</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#method_configHeight">configHeight</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#method_configKeyListeners">configKeyListeners</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#method_configModal">configModal</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#method_configStrings">configStrings</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#method_configUnderlay">configUnderlay</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#method_configWidth">configWidth</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#method_configzIndex">configzIndex</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#method_destroy">destroy</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#method_focusFirst">focusFirst</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#method_focusLast">focusLast</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#method_getFocusableElements">getFocusableElements</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#method_hideMask">hideMask</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#method_init">init</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#method_initDefaultConfig">initDefaultConfig</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#method_initEvents">initEvents</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#method_registerDragDrop">registerDragDrop</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#method_removeMask">removeMask</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#method_render">render</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#method_setFirstLastFocusable">setFirstLastFocusable</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#method_setTabLoop">setTabLoop</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#method_showMask">showMask</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#method_sizeMask">sizeMask</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#method_sizeUnderlay">sizeUnderlay</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#method_stackMask">stackMask</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#method_toString">toString</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Methods inherited from <a href="YAHOO.widget.Module.html">YAHOO.widget.Module</a>:</h4>
<div class="content">
<code>
<a class="protected" href="YAHOO.widget.Module.html#method__addToParent">_addToParent</a><span class="protected">,</span> <a class="protected" href="YAHOO.widget.Module.html#method__initResizeMonitor">_initResizeMonitor</a><span class="protected">,</span> <a class="private" href="YAHOO.widget.Module.html#method__supportsCWResize">_supportsCWResize</a><span class="private">,</span> <a class="" href="YAHOO.widget.Module.html#method_appendToBody">appendToBody</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_appendToFooter">appendToFooter</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_appendToHeader">appendToHeader</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_configMonitorResize">configMonitorResize</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_configVisible">configVisible</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_destroy">destroy</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_hide">hide</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_init">init</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_initDefaultConfig">initDefaultConfig</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_initEvents">initEvents</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_initResizeMonitor">initResizeMonitor</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_onDomResize">onDomResize</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_render">render</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_setBody">setBody</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_setFooter">setFooter</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_setHeader">setHeader</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_show">show</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_toString">toString</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Methods inherited from <a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a>:</h4>
<div class="content">
<code>
<a class="protected" href="YAHOO.widget.Overlay.html#method__alignOnTrigger">_alignOnTrigger</a><span class="protected">,</span> <a class="protected" href="YAHOO.widget.Overlay.html#method__autoFillOnHeightChange">_autoFillOnHeightChange</a><span class="protected">,</span> <a class="private" href="YAHOO.widget.Overlay.html#method__findTriggerCE">_findTriggerCE</a><span class="private">,</span> <a class="private" href="YAHOO.widget.Overlay.html#method__getComputedHeight">_getComputedHeight</a><span class="private">,</span> <a class="private" href="YAHOO.widget.Overlay.html#method__getPreciseHeight">_getPreciseHeight</a><span class="private">,</span> <a class="protected" href="YAHOO.widget.Overlay.html#method__primeXYFromDOM">_primeXYFromDOM</a><span class="protected">,</span> <a class="protected" href="YAHOO.widget.Overlay.html#method__processTriggers">_processTriggers</a><span class="protected">,</span> <a class="protected" href="YAHOO.widget.Overlay.html#method__validateAutoFillHeight">_validateAutoFillHeight</a><span class="protected">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_align">align</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_bringToTop">bringToTop</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_center">center</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_configAutoFillHeight">configAutoFillHeight</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_configConstrainToViewport">configConstrainToViewport</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_configContext">configContext</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_configFixedCenter">configFixedCenter</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_configHeight">configHeight</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_configIframe">configIframe</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_configVisible">configVisible</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_configWidth">configWidth</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_configX">configX</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_configXY">configXY</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_configY">configY</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_configzIndex">configzIndex</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_destroy">destroy</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_doCenterOnDOMEvent">doCenterOnDOMEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_enforceConstraints">enforceConstraints</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_fillHeight">fillHeight</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_getConstrainedX">getConstrainedX</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_getConstrainedXY">getConstrainedXY</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_getConstrainedY">getConstrainedY</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_hideIframe">hideIframe</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_hideMacGeckoScrollbars">hideMacGeckoScrollbars</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_init">init</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_initDefaultConfig">initDefaultConfig</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_initEvents">initEvents</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_moveTo">moveTo</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_onDomResize">onDomResize</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_showIframe">showIframe</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_showMacGeckoScrollbars">showMacGeckoScrollbars</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_stackIframe">stackIframe</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_syncIframe">syncIframe</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_syncPosition">syncPosition</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_toString">toString</a>
</code>
</div>
</div>
<div class="section method details">
<h3 id="events">Events</h3>
<div class="content">
<div class="">
<h4>
<a name="event_asyncSubmitEvent">asyncSubmitEvent</a></h4>
<div class="detail">
<code>
<strong>asyncSubmitEvent</strong>
(
)
</code>
<div class="description">
CustomEvent fired prior to asynchronous submission
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeSubmitEvent">beforeSubmitEvent</a></h4>
<div class="detail">
<code>
<strong>beforeSubmitEvent</strong>
(
)
</code>
<div class="description">
CustomEvent fired prior to submission
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_cancelEvent">cancelEvent</a></h4>
<div class="detail">
<code>
<strong>cancelEvent</strong>
(
)
</code>
<div class="description">
CustomEvent fired after cancel
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_formSubmitEvent">formSubmitEvent</a></h4>
<div class="detail">
<code>
<strong>formSubmitEvent</strong>
(
)
</code>
<div class="description">
CustomEvent fired prior to form-based submission
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_manualSubmitEvent">manualSubmitEvent</a></h4>
<div class="detail">
<code>
<strong>manualSubmitEvent</strong>
(
)
</code>
<div class="description">
CustomEvent fired prior to manual submission
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_submitEvent">submitEvent</a></h4>
<div class="detail">
<code>
<strong>submitEvent</strong>
(
)
</code>
<div class="description">
CustomEvent fired after submission
</div>
<div class="description">
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<h4>Events inherited from <a href="YAHOO.widget.Panel.html">YAHOO.widget.Panel</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.widget.Panel.html#event_dragEvent">dragEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#event_hideMaskEvent">hideMaskEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#event_showMaskEvent">showMaskEvent</a><span class="">,</span>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Events inherited from <a href="YAHOO.widget.Module.html">YAHOO.widget.Module</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.widget.Module.html#event_appendEvent">appendEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#event_beforeHideEvent">beforeHideEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#event_beforeInitEvent">beforeInitEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#event_beforeRenderEvent">beforeRenderEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#event_beforeShowEvent">beforeShowEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#event_changeBodyEvent">changeBodyEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#event_changeContentEvent">changeContentEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#event_changeFooterEvent">changeFooterEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#event_changeHeaderEvent">changeHeaderEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#event_destroyEvent">destroyEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#event_hideEvent">hideEvent</a> <a class="" href="YAHOO.widget.Module.html#event_initEvent">initEvent</a> <a class="" href="YAHOO.widget.Module.html#event_renderEvent">renderEvent</a> <a class="" href="YAHOO.widget.Module.html#event_showEvent">showEvent</a> <a class="" href="YAHOO.widget.Module.html#event_YAHOO.widget.Module.textResizeEvent">YAHOO.widget.Module.textResizeEvent</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Events inherited from <a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.widget.Overlay.html#event_beforeMoveEvent">beforeMoveEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#event_moveEvent">moveEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#event_YAHOO.widget.Overlay.windowResizeEvent">YAHOO.widget.Overlay.windowResizeEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#event_YAHOO.widget.Overlay.windowScrollEvent">YAHOO.widget.Overlay.windowScrollEvent</a><span class="">,</span>
</code>
</div>
</div>
<div class="section field details">
<h3 id="configattributes">Configuration Attributes</h3>
<div class="content">
<div class="">
<h4><a name="config_buttons">buttons</a>
<code>- {Array|String}</code>
</h4>
<div class="detail">
<div class="description">
Array of object literals, each containing a set of properties
defining a button to be appended into the Dialog's footer.
Each button object in the buttons array can have three properties:
<dt>text:</dt>
<dd>The text that will display on the face of the button. The text can
include HTML, as long as it is compliant with HTML Button specifications.
</dd>
<dt>handler:</dt>
<dd>Can be either:
<ol>
<li>A reference to a function that should fire when the
button is clicked. (In this case scope of this function is
always its Dialog instance.)</li>
<li>An object literal representing the code to be
executed when the button is clicked. Format:<br> <code> {<br>
<strong>fn:</strong> Function, &#47;&#47; The handler to call
when the event fires.<br> <strong>obj:</strong> Object,
&#47;&#47; An object to pass back to the handler.<br> <strong>
scope:</strong> Object &#47;&#47; The object to use for the
scope of the handler. <br> } </code> <br></li>
</ol>
</dd>
<dt>isDefault:</dt>
<dd>An optional boolean value that specifies that a button
should be highlighted and focused by default.</dd>
<em>NOTE:</em>If the YUI Button Widget is included on the page,
the buttons created will be instances of YAHOO.widget.Button.
Otherwise, HTML Buttons (<code>&#60;BUTTON&#62;</code>) will be
created.
</div>
</div>
<div class="default">
Default Value: "none"
</div>
<hr />
</div>
<div class="">
<h4><a name="config_hideaftersubmit">hideaftersubmit</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
This property is used to configure whether or not the
dialog should be automatically hidden after submit.
</div>
</div>
<div class="default">
Default Value: true
</div>
<hr />
</div>
<div class="">
<h4><a name="config_postmethod">postmethod</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The method to use for posting the Dialog's form. Possible values
are "async", "form", and "manual".
</div>
</div>
<div class="default">
Default Value: async
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<h4>Configuration attributes inherited from <a href="YAHOO.widget.Panel.html">YAHOO.widget.Panel</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.widget.Panel.html#config_close">close</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#config_draggable">draggable</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#config_dragOnly">dragOnly</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#config_keylisteners">keylisteners</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#config_modal">modal</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#config_strings">strings</a><span class="">,</span> <a class="" href="YAHOO.widget.Panel.html#config_underlay">underlay</a><span class="">,</span>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Configuration attributes inherited from <a href="YAHOO.widget.Module.html">YAHOO.widget.Module</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.widget.Module.html#config_appendtodocumentbody">appendtodocumentbody</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#config_effect">effect</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#config_monitorresize">monitorresize</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#config_visible">visible</a><span class="">,</span>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Configuration attributes inherited from <a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.widget.Overlay.html#config_autofillheight">autofillheight</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#config_constraintoviewport">constraintoviewport</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#config_context">context</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#config_fixedcenter">fixedcenter</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#config_height">height</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#config_iframe">iframe</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#config_preventcontextoverlap">preventcontextoverlap</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#config_width">width</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#config_x">x</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#config_xy">xy</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#config_y">y</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#config_zIndex">zIndex</a><span class="">,</span>
</code>
</div>
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div class="module">
<h4>Modules</h4>
<ul class="content">
<li class=""><a href="module_animation.html">animation</a></li>
<li class=""><a href="module_autocomplete.html">autocomplete</a></li>
<li class=""><a href="module_button.html">button</a></li>
<li class=""><a href="module_calendar.html">calendar</a></li>
<li class=""><a href="module_carousel.html">carousel</a></li>
<li class=""><a href="module_charts.html">charts</a></li>
<li class=""><a href="module_colorpicker.html">colorpicker</a></li>
<li class=""><a href="module_connection.html">connection</a></li>
<li class="selected"><a href="module_container.html">container</a></li>
<li class=""><a href="module_cookie.html">cookie</a></li>
<li class=""><a href="module_datasource.html">datasource</a></li>
<li class=""><a href="module_datatable.html">datatable</a></li>
<li class=""><a href="module_dom.html">dom</a></li>
<li class=""><a href="module_dragdrop.html">dragdrop</a></li>
<li class=""><a href="module_editor.html">editor</a></li>
<li class=""><a href="module_element.html">element</a></li>
<li class=""><a href="module_event.html">event</a></li>
<li class=""><a href="module_get.html">get</a></li>
<li class=""><a href="module_history.html">history</a></li>
<li class=""><a href="module_imagecropper.html">imagecropper</a></li>
<li class=""><a href="module_imageloader.html">imageloader</a></li>
<li class=""><a href="module_json.html">json</a></li>
<li class=""><a href="module_layout.html">layout</a></li>
<li class=""><a href="module_logger.html">logger</a></li>
<li class=""><a href="module_menu.html">menu</a></li>
<li class=""><a href="module_paginator.html">paginator</a></li>
<li class=""><a href="module_profiler.html">profiler</a></li>
<li class=""><a href="module_profilerviewer.html">profilerviewer</a></li>
<li class=""><a href="module_resize.html">resize</a></li>
<li class=""><a href="module_selector.html">selector</a></li>
<li class=""><a href="module_slider.html">slider</a></li>
<li class=""><a href="module_tabview.html">tabview</a></li>
<li class=""><a href="module_treeview.html">treeview</a></li>
<li class=""><a href="module_uploader.html">uploader</a></li>
<li class=""><a href="module_yahoo.html">yahoo</a></li>
<li class=""><a href="module_yuiloader.html">yuiloader</a></li>
<li class=""><a href="module_yuitest.html">yuitest</a></li>
</ul>
</div>
<div class="module">
<h4>Classes</h4>
<ul class="content">
<li class=""><a href="YAHOO.util.Config.html">YAHOO.util.Config</a></li>
<li class=""><a href="YAHOO.widget.ContainerEffect.html">YAHOO.widget.ContainerEffect</a></li>
<li class="selected"><a href="YAHOO.widget.Dialog.html">YAHOO.widget.Dialog</a></li>
<li class=""><a href="YAHOO.widget.Module.html">YAHOO.widget.Module</a></li>
<li class=""><a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a></li>
<li class=""><a href="YAHOO.widget.OverlayManager.html">YAHOO.widget.OverlayManager</a></li>
<li class=""><a href="YAHOO.widget.Panel.html">YAHOO.widget.Panel</a></li>
<li class=""><a href="YAHOO.widget.SimpleDialog.html">YAHOO.widget.SimpleDialog</a></li>
<li class=""><a href="YAHOO.widget.Tooltip.html">YAHOO.widget.Tooltip</a></li>
</ul>
</div>
<div class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="Config.js.html">Config.js</a></li>
<li class=""><a href="ContainerEffect.js.html">ContainerEffect.js</a></li>
<li class=""><a href="Dialog.js.html">Dialog.js</a></li>
<li class=""><a href="Module.js.html">Module.js</a></li>
<li class=""><a href="Overlay.js.html">Overlay.js</a></li>
<li class=""><a href="OverlayManager.js.html">OverlayManager.js</a></li>
<li class=""><a href="Panel.js.html">Panel.js</a></li>
<li class=""><a href="SimpleDialog.js.html">SimpleDialog.js</a></li>
<li class=""><a href="Tooltip.js.html">Tooltip.js</a></li>
</ul>
</div>
<div class="module">
<h4>Properties</h4>
<ul class="content">
<li class=""><a href="#property_callback">callback</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_callback.argument">callback.argument</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_callback.failure">callback.failure</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_callback.success">callback.success</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_callback.upload">callback.upload</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property_DEFAULT_CONFIG">DEFAULT_CONFIG</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property_EVENT_TYPES">EVENT_TYPES</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_form">form</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_YAHOO.widget.Dialog.CSS_DIALOG">YAHOO.widget.Dialog.CSS_DIALOG</a>
<!--<code>&lt;String&gt;</code>-->
</li>
</ul>
</div>
<div class="module">
<h4>Methods</h4>
<ul class="content">
<li class="protected"><!--<code>void</code>-->
<a href="#method__doClose">_doClose</a>
</li>
<li class="private"><!--<code>YAHOO.widget.Button|HTMLElement</code>-->
<a href="#method__getButton">_getButton</a>
</li>
<li class="protected"><!--<code>Object</code>-->
<a href="#method__getFormAttributes">_getFormAttributes</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__submitHandler">_submitHandler</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_blurButtons">blurButtons</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_cancel">cancel</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_configButtons">configButtons</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_configClose">configClose</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_configPostMethod">configPostMethod</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_destroy">destroy</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_doSubmit">doSubmit</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_focusDefaultButton">focusDefaultButton</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_focusFirst">focusFirst</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_focusFirstButton">focusFirstButton</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_focusLast">focusLast</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_focusLastButton">focusLastButton</a>
</li>
<li class=""><!--<code>Array</code>-->
<a href="#method_getButtons">getButtons</a>
</li>
<li class=""><!--<code>Object</code>-->
<a href="#method_getData">getData</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_init">init</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_initDefaultConfig">initDefaultConfig</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_initEvents">initEvents</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_registerForm">registerForm</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_setFirstLastFocusable">setFirstLastFocusable</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_setTabLoop">setTabLoop</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_submit">submit</a>
</li>
<li class=""><!--<code>String</code>-->
<a href="#method_toString">toString</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_validate">validate</a>
</li>
</ul>
</div>
<div class="module">
<h4>Events</h4>
<ul class="content">
<li class="">
<a href="#event_asyncSubmitEvent">asyncSubmitEvent</a>
</li>
<li class="">
<a href="#event_beforeSubmitEvent">beforeSubmitEvent</a>
</li>
<li class="">
<a href="#event_cancelEvent">cancelEvent</a>
</li>
<li class="">
<a href="#event_formSubmitEvent">formSubmitEvent</a>
</li>
<li class="">
<a href="#event_manualSubmitEvent">manualSubmitEvent</a>
</li>
<li class="">
<a href="#event_submitEvent">submitEvent</a>
</li>
</ul>
</div>
<div class="module">
<h4>Configuration Attributes</h4>
<ul class="content">
<li class="">
<a href="#config_buttons">buttons</a>
</li>
<li class="">
<a href="#config_hideaftersubmit">hideaftersubmit</a>
</li>
<li class="">
<a href="#config_postmethod">postmethod</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright &copy; 2008 Yahoo! Inc. All rights reserved.
</div>
</div>
</body>
</html>