goog.ui.Dialog.ButtonSet

Provided By	`goog.ui.Dialog.ButtonSet`
Extends	`goog.ui.Map`

A button set defines the behaviour of a set of buttons that the dialog can show. Uses the goog.structs.Map interface.

new ButtonSet( `opt_domHelper` )

Parameters

`opt_domHelper`	`(goog.dom.DomHelper\|null)=`
	Optional DOM helper; see `goog.ui.Component` for semantics.

VIEW SOURCE

Instance Methods

Adds multiple key-value pairs from another goog.ui.Map or Object.

Defined by

goog.ui.Map

Parameters

`map`	`Object<(K\|null), (V\|null)>`
	Object containing the data to add.

VIEW SOURCE

Adds a button (an object with a key and caption) to this button set. Buttons will be displayed in the order they are added.

Parameters

`button`	`{caption: string, key: string}`
	The button key and caption.
`opt_isDefault`	`boolean=`
	Whether this button is the default button. Dialog will dispatch for this button if enter is pressed.
`opt_isCancel`	`boolean=`
	Whether this button has the same behavior as cancel. If escape is pressed this button will fire.

Returns

goog.ui.Dialog.ButtonSet

The button set, to make it easy to chain "addButton" calls and build new ButtonSets.

See Also

goog.ui.Dialog.DefaultButtons

VIEW SOURCE

Attaches the button set to an element, rendering it inside.

Parameters

`el`	`(Element\|null)`
	Container.

VIEW SOURCE

Removes all key-value pairs from the map.

Overrides	`goog.ui.Map`
Parameters	None.

VIEW SOURCE

Clones a map and returns a new map.

Defined by

goog.ui.Map

Parameters

None.

Returns

goog.ui.Map

A new map with the same key-value pairs.

VIEW SOURCE

Whether the map contains the given key.

Defined by

goog.ui.Map

Parameters

`key`	`(K\|null)`
	The key to check for.

Returns

boolean

Whether the map contains the key.

VIEW SOURCE

Whether the map contains the given value. This is O(n).

Defined by

goog.ui.Map

Parameters

`val`	`(V\|null)`
	The value to check for.

Returns

boolean

Whether the map contains the value.

VIEW SOURCE

Decorates the given element by adding any button elements found among its descendants to the button set. The first button found is assumed to be the default and will receive focus when the button set is rendered. If a button with a name of goog.ui.Dialog.DefaultButtonKeys.CANCEL is found, it is assumed to have "Cancel" semantics. TODO(attila): ButtonSet should be a goog.ui.Component. Really.

Parameters

`element`	`(Element\|null)`
	The element to decorate; should contain buttons.

VIEW SOURCE

Whether this map is equal to the argument map.

Defined by

goog.ui.Map

Parameters

`otherMap`	`goog.ui.Map`
	The map against which to test equality.
`equalityFn`	`function((V\|null), (V\|null)): boolean=`
	Optional equality function to test equality of values. If not specified, this will test whether the values contained in each map are identical objects.

Returns

boolean

Whether the maps are equal.

VIEW SOURCE

Calls the given function on each entry in the map.

Defined by

goog.ui.Map

Parameters

`callbackFn`	`function((V\|null), (K\|null), (Map\|goog.ui.Map<(K\|null), (V\|null)>\|null)): ?`

`thisArg`	`(T\|null)=`
	The value of "this" inside callbackFn.

VIEW SOURCE

Returns the value for the given key. If the key is not found and the default value is not given this will return undefined.

Defined by

goog.ui.Map

Parameters

`key`	`*`
	The key to get the value for.
`defaultValue`	`(DEFAULT\|null)=`
	The value to return if no item is found for the given key, defaults to undefined.

Returns

The value for the given key.

VIEW SOURCE

Returns all the HTML Button elements in the button set container.

Parameters

None.

Returns

IArrayLike<Element>

A live NodeList of the buttons.

VIEW SOURCE

Returns the HTML Button element.

Parameters

`key`	`string`
	The button to return.

Returns

(Element|null)

The button, if found else null.

VIEW SOURCE

Returns the cancel button.

Parameters

None.

Returns

(string|null)

The cancel button.

VIEW SOURCE

Defined by

goog.ui.Map

Parameters

None.

Returns

number

The number of key-value pairs in the map.

VIEW SOURCE

Returns the default button.

Parameters

None.

Returns

(string|null)

The default button.

VIEW SOURCE

Returns the dom helper that is being used on this component.

Parameters

None.

Returns

goog.dom.DomHelper

The dom helper used on this component. TODO(user): Remove after refactoring to goog.ui.Component.

VIEW SOURCE

Gets the component's element.

Parameters

None.

Returns

(Element|null)

The element for the component. TODO(user): Remove after refactoring to goog.ui.Component.

VIEW SOURCE

Returns the keys of the map.

Defined by

goog.ui.Map

Parameters

None.

Returns

Array<(K|null)>

Array of string values.

VIEW SOURCE

Returns the values of the map.

Defined by

goog.ui.Map

Parameters

None.

Returns

Array<(V|null)>

The values in the map.

VIEW SOURCE

Defined by

goog.ui.Map

Parameters

None.

Returns

boolean

Whether the map is empty.

VIEW SOURCE

Removes a key-value pair based on the key. This is O(logN) amortized due to updating the keys array whenever the count becomes half the size of the keys in the keys array.

Defined by

goog.ui.Map

Parameters

`key`	`(K\|null)`
	The key to remove.

Returns

boolean

Whether object was removed.

VIEW SOURCE

Renders the button set inside its container element.

VIEW SOURCE

Adds a button to the button set. Buttons will be displayed in the order they are added.

Overrides

goog.ui.Map

Parameters

`key`	`*`
	Key used to identify the button in events.
`caption`	`*`
	A string caption or a DOM node that can be appended to a button element.
`opt_isDefault`	`boolean=`
	Whether this button is the default button, Dialog will dispatch for this button if enter is pressed.
`opt_isCancel`	`boolean=`
	Whether this button has the same behaviour as cancel. If escape is pressed this button will fire.

Returns

goog.ui.Dialog.ButtonSet

The button set, to make it easy to chain "set" calls and build new ButtonSets.

VIEW SOURCE

Enables or disables all of the buttons in this set.

Parameters

`enabled`	`boolean`
	True to enable; false to disable.

VIEW SOURCE

Enables or disables a button in this set by key. If the button is not found, does nothing.

Parameters

`key`	`string`
	The button to enable or disable.
`enabled`	`boolean`
	True to enable; false to disable.

VIEW SOURCE

Sets the cancel button.

Parameters

`key`	`(string\|null)`
	The cancel button.

VIEW SOURCE

Sets the default button.

Parameters

`key`	`(string\|null)`
	The default button.

VIEW SOURCE

Defined by

goog.ui.Map

Parameters

None.

Returns

Object

Object representation of the map.

VIEW SOURCE

Instance Properties

No information.

VIEW SOURCE

Static Functions

Creates a new ButtonSet with 'Continue', 'Save', and 'Cancel' (default) buttons.

Parameters

None.

Returns

goog.ui.Dialog.ButtonSet

The created ButtonSet.

VIEW SOURCE

Creates a new ButtonSet with a single 'OK' button, which is also set with cancel button semantics so that pressing escape will close the dialog.

Parameters

None.

Returns

goog.ui.Dialog.ButtonSet

The created ButtonSet.

VIEW SOURCE

Creates a new ButtonSet with 'OK' (default) and 'Cancel' buttons.

Parameters

None.

Returns

goog.ui.Dialog.ButtonSet

The created ButtonSet.

VIEW SOURCE

Creates a new ButtonSet with 'Yes' (default) and 'No' buttons.

Parameters

None.

Returns

goog.ui.Dialog.ButtonSet

The created ButtonSet.

VIEW SOURCE

Creates a new ButtonSet with 'Yes', 'No' (default), and 'Cancel' buttons.

Parameters

None.

Returns

goog.ui.Dialog.ButtonSet

The created ButtonSet.

VIEW SOURCE

Static Properties

Deprecated	Use goog.ui.Dialog.ButtonSet#createContinueSaveCancel.

VIEW SOURCE

Deprecated	Use goog.ui.Dialog.ButtonSet#createOk.

VIEW SOURCE

Deprecated	Use goog.ui.Dialog.ButtonSet#createOkCancel.

VIEW SOURCE

Deprecated	Use goog.ui.Dialog.ButtonSet#createYesNo.

VIEW SOURCE

Deprecated	Use goog.ui.Dialog.ButtonSet#createYesNoCancel.

VIEW SOURCE

Enumerations

ButtonSet.DefaultButtons

goog.ui.Dialog.ButtonSet

new ButtonSet( opt_domHelper )

Instance Methods

this.addAll( map ) → void

this.addButton( button, opt_isDefault, opt_isCancel ) → goog.ui.Dialog.ButtonSet

this.attachToElement( el ) → void

this.clear() → void

this.clone() → goog.ui.Map

this.containsKey( key ) → boolean

this.containsValue( val ) → boolean

this.decorate( element ) → void

this.equals( otherMap, equalityFn ) → boolean

this.forEach<T>( callbackFn, thisArg ) → void

this.get<DEFAULT>( key, defaultValue ) → ?

this.getAllButtons() → IArrayLike<Element>

this.getButton( key ) → (Element|null)

this.getCancel() → (string|null)

this.getCount() → number

this.getDefault() → (string|null)

this.getDomHelper() → goog.dom.DomHelper

this.getElement() → (Element|null)

this.getKeys() → Array<(K|null)>

this.getValues() → Array<(V|null)>

this.isEmpty() → boolean

this.remove( key ) → boolean

this.render() → void

this.set( key, caption, opt_isDefault, opt_isCancel ) → goog.ui.Dialog.ButtonSet

this.setAllButtonsEnabled( enabled ) → void

this.setButtonEnabled( key, enabled ) → void

this.setCancel( key ) → void

this.setDefault( key ) → void

this.toObject() → Object

Instance Properties

this.dom_ → goog.dom.DomHelper

Static Functions

ButtonSet.createContinueSaveCancel() → goog.ui.Dialog.ButtonSet

ButtonSet.createOk() → goog.ui.Dialog.ButtonSet

ButtonSet.createOkCancel() → goog.ui.Dialog.ButtonSet

ButtonSet.createYesNo() → goog.ui.Dialog.ButtonSet

ButtonSet.createYesNoCancel() → goog.ui.Dialog.ButtonSet

Static Properties

ButtonSet.CONTINUE_SAVE_CANCEL → goog.ui.Dialog.ButtonSet

ButtonSet.OK → goog.ui.Dialog.ButtonSet

ButtonSet.OK_CANCEL → goog.ui.Dialog.ButtonSet

ButtonSet.YES_NO → goog.ui.Dialog.ButtonSet

ButtonSet.YES_NO_CANCEL → goog.ui.Dialog.ButtonSet

Enumerations

new ButtonSet( `opt_domHelper` )

`this.`addAll( `map` ) `→` `void`

`this.`addButton( `button`, `opt_isDefault`, `opt_isCancel` ) `→` `goog.ui.Dialog.ButtonSet`

`this.`attachToElement( `el` ) `→` `void`

`this.`clear() `→` `void`

`this.`clone() `→` `goog.ui.Map`

`this.`containsKey( `key` ) `→` `boolean`

`this.`containsValue( `val` ) `→` `boolean`

`this.`decorate( `element` ) `→` `void`

`this.`equals( `otherMap`, `equalityFn` ) `→` `boolean`

`this.`forEach`<T>`( `callbackFn`, `thisArg` ) `→` `void`

`this.`get`<DEFAULT>`( `key`, `defaultValue` ) `→` `?`

`this.`getAllButtons() `→` `IArrayLike<Element>`

`this.`getButton( `key` ) `→` `(Element|null)`

`this.`getCancel() `→` `(string|null)`

`this.`getCount() `→` `number`

`this.`getDefault() `→` `(string|null)`

`this.`getDomHelper() `→` `goog.dom.DomHelper`

`this.`getElement() `→` `(Element|null)`

`this.`getKeys() `→` `Array<(K|null)>`

`this.`getValues() `→` `Array<(V|null)>`

`this.`isEmpty() `→` `boolean`

`this.`remove( `key` ) `→` `boolean`

`this.`render() `→` `void`

`this.`set( `key`, `caption`, `opt_isDefault`, `opt_isCancel` ) `→` `goog.ui.Dialog.ButtonSet`

`this.`setAllButtonsEnabled( `enabled` ) `→` `void`

`this.`setButtonEnabled( `key`, `enabled` ) `→` `void`

`this.`setCancel( `key` ) `→` `void`

`this.`setDefault( `key` ) `→` `void`

`this.`toObject() `→` `Object`

`this.`dom_ `→` `goog.dom.DomHelper`

ButtonSet.createContinueSaveCancel() `→` `goog.ui.Dialog.ButtonSet`

ButtonSet.createOk() `→` `goog.ui.Dialog.ButtonSet`

ButtonSet.createOkCancel() `→` `goog.ui.Dialog.ButtonSet`

ButtonSet.createYesNo() `→` `goog.ui.Dialog.ButtonSet`

ButtonSet.createYesNoCancel() `→` `goog.ui.Dialog.ButtonSet`

ButtonSet.CONTINUE_SAVE_CANCEL `→` `goog.ui.Dialog.ButtonSet`

ButtonSet.OK `→` `goog.ui.Dialog.ButtonSet`

ButtonSet.OK_CANCEL `→` `goog.ui.Dialog.ButtonSet`

ButtonSet.YES_NO `→` `goog.ui.Dialog.ButtonSet`

ButtonSet.YES_NO_CANCEL `→` `goog.ui.Dialog.ButtonSet`