The
modal interface enables your plug-in to manage modal
dialog windows.
modal.open()
method
| Signature | modal.open(configObj:ModalConfig):void |
| Description | Opens a modal dialog box
specified by the
configObj parameter. |
Parameter:
configObj | Specifies the
properties of this modal dialog box. |
modal.close()
method
| Signature | modal.close(data:any):void |
| Description | Closes the modal dialog
box in the parent iframe. |
Parameter:
data | Passes
data to the callback function specified by
onClosed property at dialog open. |
modal.setOptions()
method
| Signature | modal.setOptions(options:DynamicModalOptions):void |
| Description | Called by the parent view
to modify some properties for a modal dialog box in the parent
iframe. |
Parameter:
options | Specifies values for
some dialog box properties. |
modal.getCustomData()
method
| Signature | modal.getCustomData():any |
| Description | Returns the
customData object provided when a modal dialog box
was opened, or
null if no
customData object was provided. |
modal.DynamicModalOptions
type
| Description | Specifies values for some
properties of a modal dialog box. |
| Name | Type | Required? | Notes |
|---|
title | string | no | Dialog
title. May not contain an icon. (If not present, no change to dialog
title.) |
height | number | no | Dialog
size. Specified in pixels. (If not specified, no change to dialog
height.) |
modal.ModalConfig
type
| Description | Specifies the properties
of a modal dialog box. |
| Name | Type | Required? | Notes |
|---|
url | string | yes | Location
of HTML content for the dialog. |
title | string | no | Dialog
title. May not contain an icon. (default='') |
size | (width:number,
height:number) | yes | Dialog size.
Specified in pixels. |
closable | boolean | no | Whether
the dialog displays a close button. (default=true) |
onClosed | callbackFn | no | Function
runs when the dialog closes. |
customData | any | no | Data
the calling module passes to the dialog. |
contextObjects | string[] | no | IDs
of relevant objects the calling module passes to the dialog. |