Classes

Files

Class YAHOO.widget.Dialog

Object
   |
   +--YAHOO.widget.Module
         |
         +--YAHOO.widget.Overlay
               |
               +--YAHOO.widget.Panel
                     |
                     +--YAHOO.widget.Dialog
Direct Known Subclasses:
YAHOO.widget.SimpleDialog
class YAHOO.widget.Dialog
extends YAHOO.widget.Panel
Quick Links:  Field Summary | Constructor Summary | Method Summary | Method Details

Field Summary [top]

YAHOO.util.CustomEvent asyncSubmitEvent
CustomEvent fired prior to asynchronous submission 
YAHOO.util.CustomEvent beforeSubmitEvent
CustomEvent fired prior to submission 
YAHOO.util.CustomEvent cancelEvent
CustomEvent fired after cancel 
YAHOO.util.CustomEvent formSubmitEvent
CustomEvent fired prior to form-based submission 
YAHOO.util.CustomEvent manualSubmitEvent
CustomEvent fired prior to manual submission 
YAHOO.util.CustomEvent submitEvent
CustomEvent fired after submission 
string CSS_DIALOG
Constant representing the default CSS class used for a Dialog 
class superclass
Reference to the Dialog's superclass, Panel 

Fields inherited from class YAHOO.widget.Panel [top]

showMaskEvent, hideMaskEvent

Fields inherited from class YAHOO.widget.Overlay [top]

beforeMoveEvent, moveEvent

Fields inherited from class YAHOO.widget.Module [top]

element, header, body, footer, id, childNodesInDOM, imageRoot, beforeInitEvent, initEvent, appendEvent, beforeRenderEvent, renderEvent, changeHeaderEvent, changeBodyEvent, changeFooterEvent, changeContentEvent, destroyEvent, beforeShowEvent, showEvent, beforeHideEvent, hideEvent

Constructor Summary [top]

YAHOO.widget.Dialog
Copyright (c) 2006, Yahoo! 

Method Summary [top]

void blurButtons ()
Blurs all the html buttons 
void cancel ()
Executes the cancel of the Dialog followed by a hide. 
void configButtons (type, args, obj)
The default event handler for the "buttons" configuration property 
void configOnFailure (type,args,obj)
The default handler fired when the "failure" property is changed. 
void configOnSuccess (type,args,obj)
The default handler fired when the "success" property is changed. 
void doSubmit ()
Executes a submission of the form based on the value of the postmethod property. 
void focusDefaultButton ()
Sets the focus to the button that is designated as the default. 
void focusFirst (type,args,obj)
The default event handler used to focus the first field of the form when the Dialog is shown. 
void focusFirstButton ()
Sets the focus to the first button in the button list 
void focusLast (type,args,obj)
Sets the focus to the last button in the button or form element in the Dialog 
void focusLastButton ()
Sets the focus to the first button in the button list 
object getData ()
Returns a JSON-compatible data structure representing the data currently contained in the form. 
void init (<string> <Element> el, <object> userConfig)
The Module class's initialization method, which is executed for Module and all of its subclasses. 
void initDefaultConfig ()
Initializes the class's configurable properties which can be changed using the Dialog's Config object (cfg). 
void initEvents ()
Initializes the custom events for Dialog which are fired automatically at appropriate times by the Dialog class. 
void registerForm ()
Prepares the Dialog's internal FORM object, creating one if one is not currently present. 
Object submit ()
Executes a submit of the Dialog followed by a hide, if validation is successful. 
Object validate ()
Built-in function hook for writing a validation function that will be checked for a "true" value prior to a submit. 

Methods inherited from class YAHOO.widget.Panel

configClose, configDraggable, configUnderlay, configModal, configKeyListeners, buildWrapper, sizeUnderlay, onDomResize, registerDragDrop, buildMask, hideMask, showMask, sizeMask, configHeight, configWidth, render

Methods inherited from class YAHOO.widget.Overlay

moveTo, hideMacGeckoScrollbars, showMacGeckoScrollbars, configVisible, doCenterOnDOMEvent, configFixedCenter, configzIndex, configXY, configX, configY, configIframe, configConstrainToViewport, configContext, align, enforceConstraints, center, syncPosition

Methods inherited from class YAHOO.widget.Module

platform, browser, isSecure, initResizeMonitor, setHeader, appendToHeader, setBody, appendToBody, setFooter, appendToFooter, destroy, show, hide, configMonitorResize

Field Detail [top]

asyncSubmitEvent

YAHOO.util.CustomEvent   asyncSubmitEvent
CustomEvent fired prior to asynchronous submission

beforeSubmitEvent

YAHOO.util.CustomEvent   beforeSubmitEvent
CustomEvent fired prior to submission

cancelEvent

YAHOO.util.CustomEvent   cancelEvent
CustomEvent fired after cancel

formSubmitEvent

YAHOO.util.CustomEvent   formSubmitEvent
CustomEvent fired prior to form-based submission

manualSubmitEvent

YAHOO.util.CustomEvent   manualSubmitEvent
CustomEvent fired prior to manual submission

submitEvent

YAHOO.util.CustomEvent   submitEvent
CustomEvent fired after submission

CSS_DIALOG

string   CSS_DIALOG
Constant representing the default CSS class used for a Dialog

superclass

class   superclass
Reference to the Dialog's superclass, Panel

Constructor Detail [top]

YAHOO.widget.Dialog

YAHOO.widget.Dialog ()
Copyright (c) 2006, Yahoo! Inc. All rights reserved. Code licensed under the BSD License: http://developer.yahoo.net/yui/license.txt
Parameters:
el - The element ID representing the Dialog OR
el - The element representing the Dialog
userConfig - The configuration object literal containing the configuration that should be set for this Dialog. See configuration documentation for more details.
HASH(0x1e1e2dc)

Method Detail [top]

blurButtons

void blurButtons ()
Blurs all the html buttons HASH(0x1d78064)

cancel

void cancel ()
Executes the cancel of the Dialog followed by a hide. HASH(0x1d78184)

configButtons

void configButtons (type, args, obj)
The default event handler for the "buttons" configuration property HASH(0x1d782a4)

configOnFailure

void configOnFailure (type,args,obj)
The default handler fired when the "failure" property is changed. Used for asynchronous submission only. HASH(0x1d783c4)

configOnSuccess

void configOnSuccess (type,args,obj)
The default handler fired when the "success" property is changed. Used for asynchronous submission only. HASH(0x1d784e4)

doSubmit

void doSubmit ()
Executes a submission of the form based on the value of the postmethod property. HASH(0x1d78604)

focusDefaultButton

void focusDefaultButton ()
Sets the focus to the button that is designated as the default. By default, his handler is executed when the show event is fired. HASH(0x1d78724)

focusFirst

void focusFirst (type,args,obj)
The default event handler used to focus the first field of the form when the Dialog is shown. HASH(0x1d78844)

focusFirstButton

void focusFirstButton ()
Sets the focus to the first button in the button list HASH(0x1d78964)

focusLast

void focusLast (type,args,obj)
Sets the focus to the last button in the button or form element in the Dialog HASH(0x1d78a84)

focusLastButton

void focusLastButton ()
Sets the focus to the first button in the button list HASH(0x1d78ba4)

getData

object getData ()
Returns a JSON-compatible data structure representing the data currently contained in the form.
Returns:
A JSON object reprsenting the data of the current form.
HASH(0x1d78cac)

init

void init (<string> <Element> el, <object> userConfig)
The Module class's initialization method, which is executed for Module 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.
Parameters:
el - The element ID representing the Module OR
el - The element representing the Module
userConfig - The configuration object literal containing the configuration that should be set for this module. See configuration documentation for more details.
HASH(0x1d78db4)

initDefaultConfig

void initDefaultConfig ()
Initializes the class's configurable properties which can be changed using the Dialog's Config object (cfg). HASH(0x1d78f58)

initEvents

void initEvents ()
Initializes the custom events for Dialog which are fired automatically at appropriate times by the Dialog class. HASH(0x1d8408c)

registerForm

void registerForm ()
Prepares the Dialog's internal FORM object, creating one if one is not currently present. HASH(0x1d841ac)

submit

Object submit ()
Executes a submit of the Dialog followed by a hide, if validation is successful. HASH(0x1d842cc)

validate

Object validate ()
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. HASH(0x1d843e0)