BX.UI.StepProcessing.Dialog

Constructor

Class constructor

constructor(settings: DialogOptions = {})

Structure fields for initializing dialog DialogOptions.

Options

List of options – DialogOptions.

getSetting(name: $Keys, defaultVal: ?any = null)

setSetting(name: $Keys, value: any)

Sets function callback at the event window

setHandler(type: string, handler: any => void)

callHandler(type: string, args: {[string]: any})

Start/stop

start()

stop()

Hide/show

show()

close(

Dialog button

Structure fields for initializing input fields – OptionsField.

getButton(bid: string): ?Button – Link to button object.

lockButton(bid: string, lock: boolean, wait: boolean) – Block/Wait/Button unblocking.

showButton(bid: string, show: boolean) – Hide/Show button.

Progress annotation

setSummary(content: string, isHtml: boolean = false) – Sets annotation text.

setDownloadButtons(downloadLink: string, fileName: string, purgeHandler: any => {}) – Sets button for file download.

Errors and warnings

setErrors(errors: Array, isHtml: bool = false) – Prints error text.

setError(content, isHtml) – Prints error text.

clearErrors() – Error reset.

setWarning(err: string, isHtml: boolean = false) – Prints warning text.

clearWarnings()

Progress bar

setProgressBar(totalItems: number, processedItems: number, textBefore: string) – Sets progress value.

hideProgressBar()

Fields for input by user

getOptionField(name: string): ?BaseField – Link to button object.

getOptionFieldValues() – Sets values in fields.

checkOptionFields(): boolean – Checks fields completion.

lockOptionFields(flag: boolean = true) – Blocks user input to fields.

BX.UI.StepProcessing.DialogOptions

Structure fields for initializing dialog.

messages?: {} – Phrases in dialog:

title – Title.
summary – Annotation.
startButton – Start button.
stopButton – Stop button.
closeButton – Close button.

minWidth?: number – Dialog minimal width.

maxWidth?: number – Dialog maximum width.

optionsFields?: Array – Fields for input by user OptionsField.

optionsFieldsValue?: {} – Values for input fields.

showButtons?: {} – What buttons to display in dialog:

start?: boolean
stop?: boolean
close?: boolean

handlers?: {} – Function callback in window:

start?: function – Click at Start./li>
stop?: function – Click at Stop.
dialogShown?: function – Show dialog.
dialogClosed?: function – Hide dialog.