Class YAHOO.widget.SimpleDialog
- extends YAHOO.widget.Dialog
SimpleDialog is a simple implementation of Dialog that can be used to
submit a single value. Forms can be processed in 3 ways -- via an
asynchronous Connection utility call, a simple form POST or GET,
or manually.
Constructor
YAHOO.widget.SimpleDialog
(
el
,
userConfig
)
- Parameters:
-
el
<String>
The element ID representing the SimpleDialog
OR
-
el
<HTMLElement>
The element representing the SimpleDialog
-
userConfig
<Object>
The configuration object literal containing
the configuration that should be set for this SimpleDialog. See
configuration documentation for more details.
Properties
Constant representing the SimpleDialog's configuration properties
Constant representing the default CSS class used for a SimpleDialog
Constant for the standard network icon for alarm
Constant for the standard network icon for a blocking action
Constant representing the name of the CSS class applied to the element
created by the "icon" configuration property.
Constant for the standard network icon for help
Constant for the standard network icon for info
Constant for the standard network icon for a tip
Constant for the standard network icon for warn
body,
browser,
cacheEffects,
cfg,
contructor,
DEFAULT_CONFIG,
element,
EVENT_TYPES,
footer,
header,
id,
imageRoot,
isSecure,
platform
Methods
void
configIcon
(
type
,
args
,
obj
)
Fired when the "icon" property is set.
- Parameters:
-
type
<String>
The CustomEvent type (usually the property name)
-
args
<Object[]>
The CustomEvent arguments. For configuration
handlers, args[0] will equal the newly applied value for the property.
-
obj
<Object>
The scope object. For configuration handlers,
this will usually equal the owner.
void
configText
(
type
,
args
,
obj
)
Fired when the "text" property is set.
- Parameters:
-
type
<String>
The CustomEvent type (usually the property name)
-
args
<Object[]>
The CustomEvent arguments. For configuration
handlers, args[0] will equal the newly applied value for the property.
-
obj
<Object>
The scope object. For configuration handlers,
this will usually equal the owner.
void
init
(
el
,
userConfig
)
The SimpleDialog initialization method, which is executed for
SimpleDialog 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
<String>
The element ID representing the SimpleDialog
OR
-
el
<HTMLElement>
The element representing the SimpleDialog
-
userConfig
<Object>
The configuration object literal
containing the configuration that should be set for this
SimpleDialog. See configuration documentation for more details.
void
initDefaultConfig
(
)
Initializes the class's configurable properties which can be changed
using the SimpleDialog's Config object (cfg).
void
registerForm
(
)
Prepares the SimpleDialog's internal FORM object, creating one if one
is not currently present, and adding the value hidden field.
void
setBody
(
bodyContent
)
Sets the SimpleDialog's body content to the HTML specified.
If no body is present, one will be automatically created.
An empty string can be passed to the method to clear the contents of the body.
NOTE: SimpleDialog provides the text
and icon configuration properties to set the contents
of it's body element in accordance with the UI design for a SimpleDialog (an
icon and message text). Calling setBody on the SimpleDialog will not enforce this
UI design constraint and will replace the entire contents of the SimpleDialog body.
It should only be used if you wish the replace the default icon/text body structure
of a SimpleDialog with your own custom markup.
- Parameters:
-
bodyContent
<HTML>
The HTML used to set the body.
As a convenience, non HTMLElement objects can also be passed into
the method, and will be treated as strings, with the body innerHTML
set to their default toString implementations.
NOTE: Markup passed into this method is added to the DOM as HTML, and should be escaped by the implementor if coming from an external source.
OR
-
bodyContent
<HTMLElement>
The HTMLElement to add as the first and only child of the body element.
OR
-
bodyContent
<DocumentFragment>
The document fragment
containing elements which are to be added to the body
String
toString
(
)
Returns a string representation of the object.
- Returns:
String
- The string representation of the SimpleDialog
_addFocusHandlers,
_autoFillOnHeightChange,
_createHiddenFocusElement,
_doClose,
_focusFirstModal,
_focusOnShow,
_onElementFocus,
_removeFocusHandlers,
_renderBody,
_renderFooter,
_renderHeader,
_setTabLoop,
_testIfFocusable,
buildMask,
buildWrapper,
configClose,
configDraggable,
configHeight,
configKeyListeners,
configModal,
configStrings,
configUnderlay,
configWidth,
configzIndex,
destroy,
focusFirst,
focusLast,
forceUnderlayRedraw,
getFocusableElements,
hideMask,
init,
initDefaultConfig,
initEvents,
registerDragDrop,
removeMask,
render,
setFirstLastFocusable,
setTabLoop,
showMask,
sizeMask,
sizeUnderlay,
stackMask,
toString
_addToParent,
_createEffects,
_initResizeMonitor,
_renderBody,
_renderFooter,
_renderHeader,
_supportsCWResize,
appendToBody,
appendToFooter,
appendToHeader,
configEffect,
configMonitorResize,
configVisible,
destroy,
hide,
init,
initDefaultConfig,
initEvents,
initResizeMonitor,
onDomResize,
render,
setBody,
setFooter,
setHeader,
show,
toString
_doClose,
_getButton,
_getFormAttributes,
_setTabLoop,
_submitHandler,
blurButtons,
cancel,
configButtons,
configClose,
configPostMethod,
destroy,
doSubmit,
focusDefaultButton,
focusFirst,
focusFirstButton,
focusLast,
focusLastButton,
getButtons,
getData,
init,
initDefaultConfig,
initEvents,
registerForm,
setFirstLastFocusable,
setTabLoop,
submit,
toString,
validate
_alignOnTrigger,
_autoFillOnHeightChange,
_findTriggerCE,
_getComputedHeight,
_getConstrainedPos,
_getPreciseHeight,
_preventOverlap,
_primeXYFromDOM,
_processTriggers,
_setDomVisibility,
_validateAutoFillHeight,
align,
bringToTop,
center,
configAutoFillHeight,
configConstrainToViewport,
configContext,
configFixedCenter,
configHeight,
configIframe,
configVisible,
configWidth,
configX,
configXY,
configY,
configzIndex,
destroy,
doCenterOnDOMEvent,
enforceConstraints,
fillHeight,
fitsInViewport,
forceContainerRedraw,
getConstrainedX,
getConstrainedXY,
getConstrainedY,
hideIframe,
hideMacGeckoScrollbars,
init,
initDefaultConfig,
initEvents,
moveTo,
onDomResize,
showIframe,
showMacGeckoScrollbars,
stackIframe,
syncIframe,
syncPosition,
toString
appendEvent,
beforeHideEvent,
beforeInitEvent,
beforeRenderEvent,
beforeShowEvent,
changeBodyEvent,
changeContentEvent,
changeFooterEvent,
changeHeaderEvent,
destroyEvent,
hideEvent,
initEvent,
renderEvent
showEvent
YAHOO.widget.Module.textResizeEvent
Configuration Attributes
icon
- String
Sets the informational icon for the SimpleDialog
Default Value: "none"
Sets the text for the SimpleDialog. The text is inserted into the DOM as HTML, and should be escaped by the implementor if coming from an external source.
Default Value: ""