Dialog is an implementation of Panel that can be used to submit form data. Built-in functionality for buttons with event handlers is included, and button sets can be build dynamically, or the preincluded ones for Submit/Cancel and OK/Cancel can be utilized. Forms can be processed in 3 ways -- via an asynchronous Connection utility call, a simple form POST or GET, or manually.
|
BOTTOM_LEFT<static> : String |
Overlay |
<static> Constant representing the top bottom left corner of an element, used for configuring the context eleme... |
|
BOTTOM_RIGHT<static> : String |
Overlay |
<static> Constant representing the bottom right corner of an element, used for configuring the context element ... |
|
CSS_DIALOG<static> : String |
Dialog |
<static> Constant representing the default CSS class used for a Dialog |
|
CSS_OVERLAY<static> : String |
Overlay |
<static> Constant representing the default CSS class used for an Overlay |
|
CSS_PANEL<static> : String |
Panel |
<static> Constant representing the default CSS class used for a Panel |
|
CSS_PANEL_CONTAINER<static> : String |
Panel |
<static> Constant representing the default CSS class used for a Panel's wrapping container |
|
TOP_LEFT<static> : String |
Overlay |
<static> Constant representing the top left corner of an element, used for configuring the context element alig... |
|
TOP_RIGHT<static> : String |
Overlay |
<static> Constant representing the top right corner of an element, used for configuring the context element ali... |
|
argument : Object |
Dialog |
The arbitraty argument or arguments to pass to the Connection callback functions |
|
callback : Object |
Dialog |
The internally maintained callback object for use with the Connection utility |
|
cfg : Object[]
@default |
Dialog |
Object literal(s) defining the buttons for the Dialog's footer.
@config buttons |
|
failure : Function |
Dialog |
The function to execute upon failure of the Connection submission |
|
javascript : String |
Overlay |
<static> The URL that will be placed in the iframe |
|
success : Function |
Dialog |
The function to execute upon success of the Connection submission |
|
Dialog(String el , HTMLElement el , Object userConfig ) |
Dialog |
|
|
align(String elementAlign , String contextAlign ) : void |
Overlay |
Aligns the Overlay to its context element using the specified corner points (represented by the constants TOP_LEFT, T... |
|
blurButtons() : void |
Dialog |
Blurs all the html buttons |
|
buildMask() : void |
Panel |
Builds the mask that is laid over the document when the Panel is configured to be modal. |
|
buildWrapper() : void |
Panel |
Builds the wrapping container around the Panel that is used for positioning the shadow and matte underlays. The conta... |
|
cancel() : void |
Dialog |
Executes the cancel of the Dialog followed by a hide. |
|
center() : void |
Overlay |
Centers the container in the viewport. |
|
cfg() : void |
Dialog |
The method to use for posting the Dialog's form. Possible values are "async", "form", and "manual".
@config postmethod |
|
configButtons(String type , Object[] args , Object obj ) : void |
Dialog |
The default event handler for the "buttons" configuration property |
|
configClose(String type , Object[] args , Object obj ) : void |
Panel |
The default event handler fired when the "close" property is changed. The method controls the appending or hiding of ... |
|
configConstrainToViewport(String type , Object[] args , Object obj ) : void |
Overlay |
The default event handler fired when the "constraintoviewport" property is changed. |
|
configContext(String type , Object[] args , Object obj ) : void |
Overlay |
The default event handler fired when the "context" property is changed. |
|
configDraggable(String type , Object[] args , Object obj ) : void |
Panel |
The default event handler fired when the "draggable" property is changed. |
|
configFixedCenter(String type , Object[] args , Object obj ) : void |
Overlay |
The default event handler fired when the "fixedcenter" property is changed. |
|
configHeight(String type , Object[] args , Object obj ) : void |
Overlay |
The default event handler fired when the "height" property is changed. |
|
configIframe(String type , Object[] args , Object obj ) : void |
Overlay |
The default event handler fired when the "iframe" property is changed. |
|
configKeyListeners(String type , Object[] args , Object obj ) : void |
Panel |
The default event handler fired when the "keylisteners" property is changed. |
|
configModal(String type , Object[] args , Object obj ) : void |
Panel |
The default event handler fired when the "modal" property is changed. This handler subscribes or unsubscribes to the ... |
|
configUnderlay(String type , Object[] args , Object obj ) : void |
Panel |
The default event handler fired when the "underlay" property is changed. |
|
configVisible(String type , Object[] args , Object obj ) : void |
Overlay |
The default event handler fired when the "visible" property is changed. This method is responsible for firing showEve... |
|
configWidth(String type , Object[] args , Object obj ) : void |
Overlay |
The default event handler fired when the "width" property is changed. |
|
configX(String type , Object[] args , Object obj ) : void |
Overlay |
The default event handler fired when the "x" property is changed. |
|
configXY(String type , Object[] args , Object obj ) : void |
Overlay |
The default event handler fired when the "xy" property is changed. |
|
configY(String type , Object[] args , Object obj ) : void |
Overlay |
The default event handler fired when the "y" property is changed. |
|
configzIndex(String type , Object[] args , Object obj ) : void |
Overlay |
The default event handler fired when the "zIndex" property is changed. |
|
destroy() : void |
Overlay |
Removes the Overlay element from the DOM and sets all child elements to null. |
|
doCenterOnDOMEvent() : void |
Overlay |
Center event handler used for centering on scroll/resize, but only if the Overlay is visible |
|
doSubmit() : void |
Dialog |
Performs the submission of the Dialog form depending on the value of "postmethod" property. |
|
enforceConstraints(String type , Object[] args , Object obj ) : void |
Overlay |
The default event handler executed when the moveEvent is fired, if the "constraintoviewport" is set to true. |
|
focusDefaultButton() : void |
Dialog |
Sets the focus to the button that is designated as the default. By default, his handler is executed when the show eve... |
|
focusFirst() : void |
Dialog |
The default event handler used to focus the first field of the form when the Dialog is shown. |
|
focusFirstButton() : void |
Dialog |
Sets the focus to the first button in the button list |
|
focusLast() : void |
Dialog |
Sets the focus to the last button in the button or form element in the Dialog |
|
focusLastButton() : void |
Dialog |
Sets the focus to the first button in the button list |
|
getData() : Object |
Dialog |
Returns a JSON-compatible data structure representing the data currently contained in the form. |
|
hideIframe() : void |
Overlay |
Hides the iframe shim, if it has been enabled |
|
hideMacGeckoScrollbars() : void |
Overlay |
Adds a special CSS class to the Overlay when Mac/Gecko is in use, to work around a Gecko bug where
scrollbars cannot ... |
|
hideMask() : void |
Panel |
Hides the modality mask. |
|
init(String el , HTMLElement el , Object userConfig ) : void |
Dialog |
The Dialog initialization method, which is executed for Dialog and all of its subclasses. This method is automaticall... |
|
initDefaultConfig() : void |
Dialog |
Initializes the class's configurable properties which can be changed using the Dialog's Config object (cfg). |
|
initEvents() : void |
Dialog |
Initializes the custom events for Dialog which are fired automatically at appropriate times by the Dialog class. |
|
moveTo(Number x , Number y ) : void |
Overlay |
Moves the Overlay to the specified position. This function is identical to calling this.cfg.setProperty("xy", [x,y]); |
|
onDomResize(DOMEvent e , Object obj ) : void |
Overlay |
Event handler fired when the resize monitor element is resized. |
|
registerDragDrop() : void |
Panel |
Registers the Panel's header for drag & drop capability. |
|
registerForm() : void |
Dialog |
Prepares the Dialog's internal FORM object, creating one if one is not currently present. |
|
removeMask() : void |
Panel |
Removes the modality mask. |
|
render(String appendToNode , HTMLElement appendToNode ) : boolean |
Panel |
Renders the Panel by inserting the elements that are not already in the main Panel into their correct places. Optiona... |
|
showIframe() : void |
Overlay |
Shows the iframe shim, if it has been enabled |
|
showMacGeckoScrollbars() : void |
Overlay |
Removes a special CSS class from the Overlay when Mac/Gecko is in use, to work around a Gecko bug where
scrollbars ca... |
|
showMask() : void |
Panel |
Shows the modality mask. |
|
sizeMask() : void |
Panel |
Sets the size of the modality mask to cover the entire scrollable area of the document |
|
sizeUnderlay() : void |
Panel |
Adjusts the size of the shadow based on the size of the element. |
|
submit() : void |
Dialog |
Executes a submit of the Dialog followed by a hide, if validation is successful. |
|
syncPosition() : void |
Overlay |
Synchronizes the Panel's "xy", "x", and "y" properties with the Panel's position in the DOM. This is primarily used t... |
|
toString() : String |
Dialog |
Returns a string representation of the object. |
|
validate() : void |
Dialog |
Built-in function hook for writing a validation function that will be checked for a "true" value prior to a submit. T... |
|
windowResizeHandler<static>(DOMEvent e ) : void |
Overlay |
<static> The DOM event handler used to fire the CustomEvent for window resize |
|
windowScrollHandler<static>(DOMEvent e ) : void |
Overlay |
<static> The DOM event handler used to fire the CustomEvent for window scroll |
BOTTOM_LEFT<static>
public String BOTTOM_LEFT<static>
<static> Constant representing the top bottom left corner of an element, used for configuring the context element alignment
This property is defined by
Overlay.
BOTTOM_RIGHT<static>
public String BOTTOM_RIGHT<static>
<static> Constant representing the bottom right corner of an element, used for configuring the context element alignment
This property is defined by
Overlay.
CSS_DIALOG<static>
public String CSS_DIALOG<static>
<static> Constant representing the default CSS class used for a Dialog
This property is defined by Dialog.
CSS_OVERLAY<static>
public String CSS_OVERLAY<static>
<static> Constant representing the default CSS class used for an Overlay
This property is defined by
Overlay.
CSS_PANEL<static>
public String CSS_PANEL<static>
<static> Constant representing the default CSS class used for a Panel
This property is defined by
Panel.
CSS_PANEL_CONTAINER<static>
public String CSS_PANEL_CONTAINER<static>
<static> Constant representing the default CSS class used for a Panel's wrapping container
This property is defined by
Panel.
TOP_LEFT<static>
public String TOP_LEFT<static>
<static> Constant representing the top left corner of an element, used for configuring the context element alignment
This property is defined by
Overlay.
TOP_RIGHT<static>
public String TOP_RIGHT<static>
<static> Constant representing the top right corner of an element, used for configuring the context element alignment
This property is defined by
Overlay.
argument
public Object argument
The arbitraty argument or arguments to pass to the Connection callback functions
This property is defined by Dialog.
callback
public Object callback
The internally maintained callback object for use with the Connection utility
This property is defined by Dialog.
cfg
public Object[]
@default cfg
Object literal(s) defining the buttons for the Dialog's footer.
@config buttons
This property is defined by Dialog.
failure
public Function failure
The function to execute upon failure of the Connection submission
This property is defined by Dialog.
javascript
public String javascript
<static> The URL that will be placed in the iframe
This property is defined by
Overlay.
success
public Function success
The function to execute upon success of the Connection submission
This property is defined by Dialog.