Class CAF.Dialog

Object
   |
   +--CAF.Dialog

class CAF.Dialog

Opens dialog "windows".
Defined in hidden.js

Field Detail

ErrorAppender

<static> Object ErrorAppender

CAF.Dialog

CAF.Dialog()

alert

<static> void alert(msg, fn, options)

Displays a simple, one-button alert dialog.

Parameters:
msg - Message to display (raw html).
fn - (optional) Function to execute when ok button is pressed.
options - (optional) Additional options. See show().

confirm

<static> void confirm(msg, okFn, cancelFn, options)

Displays a simple, two-button confirmation dialog.

Parameters:
msg - Message to display (raw html).
okFn - (optional) Function to execute when ok button is pressed.
cancelFn - (optional) Function to execute when cancel button is pressed.
options - (optional) Additional options. See show().

error

<static> void error(msg, fn, options)

Displays a simple, one-button error dialog.

Parameters:
msg - Message to display (raw html). If the message contains linefeeds ("\n"), content after the first linefeed is separated and placed inside a togglable details div, and all other linefeeds are converted into html br elements.
fn - (optional) Function to execute when ok button is pressed.
options - (optional) Additional options. See show().

prompt

<static> void prompt(msg, defaultValue, okFn, cancelFn, options)

Displays a simple, one-input prompt dialog.

Parameters:
msg - Message to display (raw html).
defaultValue - (optional) Default input field value.
okFn - (optional) Function to execute when ok button is pressed. Function is passed the following arguments:
1. input value
cancelFn - (optional) Function to execute when cancel button is pressed.
options - (optional) Additional options. See show().

show

<static> void show(options)

Displays a configurable dialog.

Parameters:
options - Dialog options object. The following properties are recognized:

id

Dialog id.

title

Dialog title (raw html).

content

Dialog content (raw html).

type

"modal" (default) for modal dialog, "modeless" for modeless dialog, or "overlay" for overlay dialog. If "overlay", id of element to overlay must be specified via "for" option.

styleClass

CSS className for dialog element.

for

Id of element to overlay, if type="overlay".

defaultFocus

Id of field to focus when dialog is shown.

onShow

Function to call when dialog finally is shown.

buttons

Buttons object (see below).

The buttons object specifies the buttons the dialog should contain. If no buttons are specified, the dialog automatically creates an ok button. The buttons object may have the following properties:

label

Button label (raw html).

id

Button id.

class

Button css class.

style

Button css inline-style.

defaultCommand

True to make button the dialog's default command (button actuated when user presses enter key).

fn

Function to execute when button is pressed. Function is called after the dialog has been closed. Function is passed a single argument, an object that contains a property for each named field in the dialog. For each property, the property name is the field name, and the property value is the field value.

validate

Function to use to validate form when button is pressed. Function is called before the dialog has been closed. Function is passed a single argument, an object that contains a property for each named field in the dialog. For each property, the property name is the field name, and the property value is the field value. Function should return empty string ("") if all the fields in the dialog are valid. Function can return either a non-empty string or an object to signal that some fields in the dialog are not valid. If the function returns an empty string, that string is displayed as a "global" error message at the top of the dialog. If the function returns an object, for each property of that object matching a named field in the dialog, an error message is displayed next to the named field, using the property's value.

warn

<static> void warn(msg, fn, options)

Displays a simple, one-button warning dialog.

Parameters:
msg - Message to display (raw html). If the message contains linefeeds ("\n"), content after the first linefeed is separated and placed inside a togglable details div, and all other linefeeds are converted into html br elements.
fn - (optional) Function to execute when ok button is pressed.
options - (optional) Additional options. See show().