StarUML API

Modules (50)

Dialogs

Description

Variables Summary

Functions Summary

Classes Summary

Variables

Public API

DIALOG_BTN_CLASS_PRIMARY

Dialog Buttons Class Names

Public API

DIALOG_BTN_OK

Dialog Modal Results

Functions

_keydownHook

Handles the keyDown event for the dialogs

e $.Event
autoDismiss boolean
Returns: boolean
Public API

cancelModalDialogIfOpen

Immediately closes any dialog instances with the given class. The dialog callback for each instance will be called with the special buttonId DIALOG_CANCELED (note: callback is run asynchronously).

dlgClass string
The class name identifier for the dialog.
buttonId optional string
The button id to use when closing the dialog. Defaults to DIALOG_CANCELED
Public API

showAlertDialog

Show Alert Dialog

message string
Returns: Dialog
Public API

showColorDialog

Show Color Dialog

color string
initial color
Returns: Dialog
Public API

showConfirmDialog

Show Confirm Dialog

message string
Returns: Dialog
Public API

showErrorDialog

Show Error Dialog

message string
Returns: Dialog
Public API

showFontDialog

Show Font Dialog

font Graphics.Font
Initial font
Returns: Dialog
Public API

showInfoDialog

Show Information Dialog

message string
Returns: Dialog
Public API

showInputDialog

Show Input Dialog

message string
Returns: Dialog
Public API

showModalDialog

Show typical modal dialog

dlgClass string
title string
message string
buttons Array.<{id:string,text:string,className:string}>
autoDismiss boolean
Returns: Dialog
Public API

showModalDialogUsingTemplate

Show Modal Dialog using Template

template string
autoDismiss boolean
beforeClosing function($.Element)
Returns: Dialog
Public API

showSaveConfirmDialog

Show Save Confirmation Dialog

filename string
Returns: Dialog
Public API

showSelectDropdownDialog

Show Select Dialog (Dropdown-type)

message string
items Array.<{text:string,value:string}>
Returns: Dialog
Public API

showSelectRadioDialog

Show Select Dialog (Radio-type)

message string
items Array.<{text:string,value:string}>
Returns: Dialog
Public API

showSimpleDialog

Show Simple Dialog

message string
Returns: Dialog
Public API

showTextDialog

Show Text Dialog (Multiline Text)

message string
text string
initial text
Returns: Dialog

Classes

Constructor

Dialog

$dlg $.Element
The dialog jQuery element
promise $.Promise
A promise that will be resolved with the ID of the clicked button when the dialog is dismissed. Never rejected.
Methods

Methods

close

Closes the dialog if is visible

done

Adds a done callback to the dialog promise

getElement

getPromise