libs/cq/gui/components/authoring/editors/clientlibs/core/js/

Class: Dialog

Granite.author.ui. Dialog

<abstract> new Dialog(def)

The abstract Dialog class

Parameters:
Name Type Description
def Granite.author.ui.Dialog~DialogDef

The definition of the Dialog
Source:
ui/ui.Dialog.js

Methods

getConfig()

Returns the configuration properties of the dialog

Source:
ui/ui.Dialog.js
Returns:
Type
Granite.author.ui.Dialog~DialogConfig

getRequestData()

Returns the additional data to be sent when requesting the Dialog

Source:
ui/ui.Dialog.js
Returns:
Type
Object

onClose()

The dialog has been closed

Callback

Source:
ui/ui.Dialog.js

onFocus()

The dialog is focused

Callback

Source:
ui/ui.Dialog.js

onOpen()

The dialog has been opened

Callback

Source:
ui/ui.Dialog.js

onReady()

The dialog is ready

Callback

Source:
ui/ui.Dialog.js

onSuccess()

The dialog form submission has succeeded

Callback

Source:
ui/ui.Dialog.js

Type Definitions

DialogConfig

Represents the Dialog Configuration object.

Type:
  • object
Properties:
Name Type Description
src string

The URL of the Dialog
isFloating boolean

Indicates if the Dialog should be floating
loadingMode string

The Dialog loading mode
layout layout

The Dialog layout
Source:
ui/ui.Dialog.js

DialogDef

Represents the Dialog Definition object.

Type:
  • object
Properties:
Name Type Description
getConfig function

Returns the Configuration of the dialog (see Granite.author.ui.Dialog~DialogConfig)
getRequestedData function

Returns the additional data to be sent when requesting the Dialog
onOpen function

The dialog has been opened (callback)
onReady function

The dialog is ready (callback)
onFocus function

The dialog has received focus (callback)
onSuccess function

The dialog form submission has succeeded (callback)
onClose function

The dialog has been closed (callback)
Source:
ui/ui.Dialog.js