ConfirmationBar
Widget

This widget is a Toolbar with default buttons for items common to system dialogs. Button order is appropriate for the platform. For example, on Windows, OK/Cancel buttons are presented in that order, while on Mac OS X and many flavors of Linux, these buttons are presented in Cancel/OK order.

No results

Configs

Configs are options you supply in a configuration object when creating an instance of this class

defaultButton : 'cancel'/'ok'/'no'/'yes'ok

The name of the default button. Must match with the defaults in namedItems.

Has a corresponding runtime defaultButton property.
items : String/Object<String, WidgetConfig | MenuItemEntry>/(WidgetConfig|MenuItemEntry|Widget)[]ok,cancel
In addition to normal form of items, this class supports a comma-delimited string.

For example:
```
 items : 'ok,cancel',
 // or
 items : 'yes,no',
```
These are equivalent to:
```
 items : {
     ok     : true,
     cancel : true
 },
 // or
 items : {
     yes : true,
     no  : true
 },
```
Both forms use the pre-defined buttons: 'cancel', 'ok', 'no', 'yes'.
keyMap : Object<String, KeyMapConfig>{"Enter":"doDefault","NumpadEnter":"doDefault","Escape":"doCancel"}

Maps Enter and Escape to doDefault and doCancel, respectively.
namedItems : Object<String, WidgetConfig>{"yes":"","no":"","ok":"","cancel":""}

The default buttons available for use in the items config.
syncWidthButtons : Booleantrue

Set to false to disable synchronizing button widths. By default, buttons are assigned a minWidth based on the longest text. The default OK and Cancel buttons (in the en-US locale) will be assigned minWidth = '6em'.

Has a corresponding runtime syncWidthButtons property.

Properties

Properties are getters/setters or publicly accessible variables on this class

isConfirmationBar : Booleantrue

READONLY

static

ADVANCED

Identifies an object as an instance of ConfirmationBar class, or subclass thereof.

cancelButton : Button

READONLY

Returns the cancel button if present in the items config or null if not present.
defaultButton : 'cancel'/'ok'/'no'/'yes'ok

The name of the default button. Must match with the defaults in namedItems.

Has a corresponding defaultButton config.
noButton : Button

READONLY

Returns the no button if present in the items config or null if not present.
okButton : Button

READONLY

Returns the ok button if present in the items config or null if not present.
syncWidthButtons : Booleantrue

Set to false to disable synchronizing button widths. By default, buttons are assigned a minWidth based on the longest text. The default OK and Cancel buttons (in the en-US locale) will be assigned minWidth = '6em'.

Has a corresponding syncWidthButtons config.
yesButton : Button

READONLY

Returns the yes button if present in the items config or null if not present.
isConfirmationBar : Booleantrue

READONLY

ADVANCED

Identifies an object as an instance of ConfirmationBar class, or subclass thereof.

Functions

Functions are methods available for calling on the class

doCancel( event )

internal
Called by the keyMap to process Escape. This triggers a click from the first button in the items config that is present:
- cancelButton
- noButton
- the first button that is not the defaultButton
doDefault( event )

internal

Called by the keyMap to process Enter or NumpadEnter. This triggers a click from the defaultButton.

Events

Events are triggered for certain actions in this class and can be listened for to react to those actions in your code

choice

This event is fired when the user clicks one of the buttons.

Event handlers

Event handlers are callbacks called as a result of certain actions in this class

onChoice

This event is called when the user clicks one of the buttons.

Type definitions

ConfirmationBarChoice
A description of the chosen button in a ConfirmationBar.
Properties
- name : 'ok'/'cancel'/'no'/'yes'
  
  The name of the chosen button.
- approve : Boolean
  
  Set to true when name is either 'ok' or 'yes'.
- ok : Boolean
  
  Set to true when name is 'ok'.
- cancel : Boolean
  
  Set to true when name is 'cancel'.
- no : Boolean
  
  Set to true when name is 'no'.
- yes : Boolean
  
  Set to true when name is 'yes'.

ConfirmationBar
Widget

Configs

Properties

Functions

Events

Event handlers

Type definitions

Properties

Source path

Inheritance tree5

Mixins6

Contents

ConfirmationBar Widget

Configs

Properties

Functions

Events

Event handlers

Type definitions

Properties

Source path

Inheritance tree5

Mixins6

Contents

ConfirmationBar
Widget