Interface IDialogBuilder

A class to build a dialog.

api-version: 1
user

Hierarchy

IDialogBuilder

Index

Methods

Methods

build

build(): IDialog

- Defined in src/api/dart-api.ts:8383
Create an instance of IDialog with the arguments supplied to this builder.

api-version
1

user
Returns IDialog
Return an instance of IDialog.

setBackgroundDim

setBackgroundDim(enabled: boolean): IDialogBuilder

- Defined in src/api/dart-api.ts:8343
Set a background dim on the dialog.

api-version
1

user
Parameters
- enabled: boolean
  
  Set whether the background dim is enabled or not.
Returns IDialogBuilder

setButton

setButton(which: number, text: string, enabled: boolean, listener: OnClickListener): IDialogBuilder

- Defined in src/api/dart-api.ts:8298
Set a button.

api-version
1

user
Parameters
- which: number
  
  Which button to set.
- text: string
  
  A text to display in the button.
- enabled: boolean
  
  True if this view is enabled, false otherwise.
- listener: OnClickListener
  
  A OnClickListener to be invoked when this button is pressed.
Returns IDialogBuilder

setButtonWithProps

setButtonWithProps(which: number, props: ButtonProps, listener: OnClickListener): IDialogBuilder

- Defined in src/api/dart-api.ts:8310
Set a button.

api-version
3

user
Parameters
- which: number
  
  Which button to set.
- props: ButtonProps
  
  ButtonProps
- listener: OnClickListener
  
  A OnClickListener to be invoked when this button is pressed.
Returns IDialogBuilder

setCancelable

setCancelable(cancelable: boolean): IDialogBuilder

- Defined in src/api/dart-api.ts:8333
Sets whether this dialog is canceled when touched outside the dialog's bounds. If user close a dialog via touched outside the dialog's bounds, then OnCancelListener will be called.

api-version
1

user
Parameters
- cancelable: boolean
  
  Whether the dialog should be canceled when touched outside the dialog's bounds.
Returns IDialogBuilder

setCloseButton

setCloseButton(enabled: boolean): IDialogBuilder

- Defined in src/api/dart-api.ts:8322
Sets a close button in the dialog. The button is shown at top right corner in the dialog. If user close a dialog via this button, then OnCancelListener will be called.

api-version
1

user
Parameters
- enabled: boolean
  
  Set whether the close button is enabled or not.
Returns IDialogBuilder

setContentView

setContentView(view: Element): IDialogBuilder

- Defined in src/api/dart-api.ts:8285
Set the content view for this dialog.

api-version
1

user
Parameters
- view: Element
  
  A view to display in the custom content view area.
Returns IDialogBuilder

setDetailMessage

setDetailMessage(text: string, collapsible: boolean, expanded: boolean): IDialogBuilder

- Defined in src/api/dart-api.ts:8275
Set the detail message for this dialog.

api-version
1

user
Parameters
- text: string
  
  A text to display in the detail content.
- collapsible: boolean
  
  Set as collapsible a detail message view.
- expanded: boolean
  
  Set as expand a detail message view. It works when you set {@link collapsible} as true.
Returns IDialogBuilder

setEmphasisMessage

setEmphasisMessage(text: string): IDialogBuilder

- Defined in src/api/dart-api.ts:8263
Set the emphasis message for this dialog.

api-version
1

user
Parameters
- text: string
  
  A text to display in the content.
Returns IDialogBuilder

setIcon

setIcon(icon: number): IDialogBuilder

- Defined in src/api/dart-api.ts:8213
Set an icon type. Available icon types are:
api-version
1

user
Parameters
- icon: number
  
  Type of an icon.
Returns IDialogBuilder

setMessage

setMessage(text: string): IDialogBuilder

- Defined in src/api/dart-api.ts:8243
Set the message for this dialog.

api-version
1

user
Parameters
- text: string
  
  A text to display in the content.
Returns IDialogBuilder

setOnCancelListener

setOnCancelListener(listener: OnCancelListener): IDialogBuilder

- Defined in src/api/dart-api.ts:8373
Sets a listener to be invoked when the dialog is canceled.

api-version
1

user
Parameters
- listener: OnCancelListener
  
  The OnCancelListener to use.
Returns IDialogBuilder

setOnDismissListener

setOnDismissListener(listener: OnDismissListener): IDialogBuilder

- Defined in src/api/dart-api.ts:8363
Sets a listener to be invoked when the dialog is dismissed.

api-version
1

user
Parameters
- listener: OnDismissListener
  
  The OnDismissListener to use.
Returns IDialogBuilder

setOnShowListener

setOnShowListener(listener: OnShowListener): IDialogBuilder

- Defined in src/api/dart-api.ts:8353
Sets a listener to be invoked when the dialog is shown.

api-version
1

user
Parameters
- listener: OnShowListener
  
  The OnShowListener to use.
Returns IDialogBuilder

setSecondaryMessage

setSecondaryMessage(text: string): IDialogBuilder

- Defined in src/api/dart-api.ts:8253
Set the secondary message for this dialog.

api-version
1

user
Parameters
- text: string
  
  A text to display in the content.
Returns IDialogBuilder

setTitle

setTitle(text: string): IDialogBuilder

- Defined in src/api/dart-api.ts:8223
Set the title text for this dialog.

api-version
1

user
Parameters
- text: string
  
  A text to display in the title.
Returns IDialogBuilder

setTitleView

setTitleView(view: Element): IDialogBuilder

- Defined in src/api/dart-api.ts:8233
Set the title view for this dialog.

api-version
1

user
Parameters
- view: Element
  
  A view to display in the custom title view area.
Returns IDialogBuilder

Generated using TypeDoc