Class Dialog

Object
   |
   +--Dialog

Direct Known Subclasses:

ModalDialog

class Dialog

Defined in widgets/dialog.js

Field Detail

buttons

Array buttons

Dialog buttons

buttonsClass

String buttonsClass

CSS class for the dialog's buttons

container

Object container

If a container element is provided, the dialog will use relative positioning

contentEl

Object contentEl

Dialog's content container

contents

Object contents

Dialog contents (string or element reference)

contentsClass

String contentsClass

CSS class for the dialog's content

el

Object el

Dialog's root element

focusId

Object focusId

Element ID that must receive focus when dialog opens

followScroll

Boolean followScroll

Whether the dialog must follow window scroll (absolute positioning only)

hoverClose

Boolean hoverClose

Whether the dialog must be closed upon mouseout event

i

<private> Object i

id

String id

Dialog ID

left

Number left

Left offset, when using relative positioning

loadMethod

String loadMethod

Load method (get or post)

loadParams

Object loadParams

Request parameters to be used while loading contents with AJAX

loadUri

String loadUri

URI to load dialog contents from, using AJAX

onBeforeClose

Function onBeforeClose

Called before closing the dialog, can be used to cancel this event

onBeforeOpen

Function onBeforeOpen

Called before opening the dialog, can be used to cancel this event

onClose

Function onClose

Called after the dialog is closed

onOpen

Function onOpen

Called after the dialog is opened

parent

Object parent

Dialog's parent element

top

Number top

Top offset, when using relative positioning

trigger

Object trigger

Element that must open the dialog

visible

Boolean visible

Indicates if the dialog is visible (opened)

zIndex

Number zIndex

Dialog z-index

Dialog

Dialog(<Object> opts)

Base class of the dialogs API. Builds simple dialogs that can be placed absolutely (centered) or relative to a container element. These dialogs can be populated with string contents, an existent element reference or an AJAX call

Parameters:
opts - Configuration options

addButton

void addButton(text, fn, def)

Adds a button on the dialog

Parameters:
Caption -
Handler - function
Is - this the default button?

close

void close()

Closes the dialog

hide

void hide()

Hides the dialog

open

void open()

Opens the dialog

place

void place()

Places the dialog according to the provided settings

resizeHandler

 <private> void resizeHandler(e)

Called upon window.onresize

scrollHandler

 <private> void scrollHandler(e)

Called upon window.onscroll

setButtonAction

void setButtonAction(<Number> idx, <Function> fn)

Changes the handler function of a dialog's button

Parameters:
idx - Button index (zero based)
fn - Handler function

setContents

void setContents(<Object> contents)

Set dialog's contents

Parameters:
contents - String or element reference

setup

void setup()

Performs initialization routines on the dialog

setupContents

void setupContents()

Initializes the contents of the dialog

show

void show()

Shows the dialog