goog.tweak.BaseSetting

Provided By	`goog.tweak.BaseSetting`
Extends	`goog.tweak.BaseEntry`
All Known Direct Subclasses	`goog.tweak.BasePrimitiveSetting` `goog.tweak.BooleanGroup`

Base class for all tweak entries that are settings. Settings are entries that are associated with a query parameter.

new BaseSetting( `id`, `description` )

Parameters

`id`	`string`
	The ID for the setting.
`description`	`string`
	A description of what the setting does.

VIEW SOURCE

Instance Methods

Adds a callback that should be called when the setting has changed (or when an action has been clicked).

Defined by

goog.tweak.BaseEntry

Parameters

`callback`	`Function`
	The callback to add.

VIEW SOURCE

Asserts that this tweak has not been initialized yet.

Parameters

`funcName`	`string`
	Function name to use in the assertion message.

VIEW SOURCE

Applies the default value or query param value if this is the first time that the function has been called.

VIEW SOURCE

Calls all registered callbacks.

VIEW SOURCE

Defined by

goog.tweak.BaseEntry

Parameters

None.

Returns

string

Returns the entry's ID.

VIEW SOURCE

Returns the value to be used in the query parameter for this tweak.

Parameters

None.

Returns

(string|null)

The encoded value. Null if the value is set to its default.

VIEW SOURCE

Returns the name of the query parameter used for this setting.

Parameters

None.

Returns

(string|null)

The param name. Null if no query parameter is directly associated with the setting.

VIEW SOURCE

Sets the value of the entry based on the value of the query parameter. Once this is called, configuration settings (associated query parameter, token, etc) may not be changed.

Parameters

`value`	`(string\|null)`
	The part of the query param for this setting after the '='. Null if it is not present.

VIEW SOURCE

Returns whether the setting is currently being initialized.

Parameters

None.

Returns

boolean

Whether the setting is currently being initialized.

VIEW SOURCE

Returns whether a restart is required for changes to the setting to take effect.

Defined by

goog.tweak.BaseEntry

Parameters

None.

Returns

boolean

The value.

VIEW SOURCE

Removes a callback that was added by addCallback.

Defined by

goog.tweak.BaseEntry

Parameters

`callback`	`Function`
	The callback to add.

VIEW SOURCE

Sets the initial query parameter value for this setting. May not be called after the setting has been initialized.

Parameters

`value`	`string`
	The initial query parameter value for this setting.

VIEW SOURCE

Sets the name of the query parameter used for this setting. If null is passed the setting will not appear in the top-level query string.

Parameters

`value`	`(string\|null)`
	The new value.

VIEW SOURCE

Sets whether a restart is required for changes to the setting to take effect.

Defined by

goog.tweak.BaseEntry

Parameters

`value`	`boolean`
	The new value.

VIEW SOURCE

Instance Properties

A description of what this entry does.

VIEW SOURCE

The value of this setting's query parameter.

VIEW SOURCE

A descriptive label for the entry.

VIEW SOURCE

The logger for this class.

Overrides	`goog.tweak.BaseEntry`

VIEW SOURCE

Enumerations

BaseSetting.InitializeState_

goog.tweak.BaseSetting

new BaseSetting( `id`, `description` )

Instance Methods

`this.`addCallback( `callback` ) `→` `void`

`this.`assertNotInitialized( `funcName` ) `→` `void`

`this.`ensureInitialized() `→` `void`

`this.`fireCallbacks() `→` `void`

`this.`getId() `→` `string`

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

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

`this.`initialize( `value` ) `→` `void`

`this.`isInitializing() `→` `boolean`

`this.`isRestartRequired() `→` `boolean`

`this.`removeCallback( `callback` ) `→` `void`

`this.`setInitialQueryParamValue( `value` ) `→` `void`

`this.`setParamName( `value` ) `→` `void`

`this.`setRestartRequired( `value` ) `→` `void`

Instance Properties

`this.`description `→` `string`

`this.`initialQueryParamValue `→` `(string|undefined)`

`this.`label `→` `string`

`this.`logger `→` `(goog.log.Logger|null)`

Enumerations

goog.tweak.BaseSetting

new BaseSetting( id, description )

Instance Methods

this.addCallback( callback ) → void

this.assertNotInitialized( funcName ) → void

this.ensureInitialized() → void

this.fireCallbacks() → void

this.getId() → string

this.getNewValueEncoded() → (string|null)

this.getParamName() → (string|null)

this.initialize( value ) → void

this.isInitializing() → boolean

this.isRestartRequired() → boolean

this.removeCallback( callback ) → void

this.setInitialQueryParamValue( value ) → void

this.setParamName( value ) → void

this.setRestartRequired( value ) → void

Instance Properties

this.description → string

this.initialQueryParamValue → (string|undefined)

this.label → string

this.logger → (goog.log.Logger|null)

Enumerations

new BaseSetting( `id`, `description` )

`this.`addCallback( `callback` ) `→` `void`

`this.`assertNotInitialized( `funcName` ) `→` `void`

`this.`ensureInitialized() `→` `void`

`this.`fireCallbacks() `→` `void`

`this.`getId() `→` `string`

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

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

`this.`initialize( `value` ) `→` `void`

`this.`isInitializing() `→` `boolean`

`this.`isRestartRequired() `→` `boolean`

`this.`removeCallback( `callback` ) `→` `void`

`this.`setInitialQueryParamValue( `value` ) `→` `void`

`this.`setParamName( `value` ) `→` `void`

`this.`setRestartRequired( `value` ) `→` `void`

`this.`description `→` `string`

`this.`initialQueryParamValue `→` `(string|undefined)`

`this.`label `→` `string`

`this.`logger `→` `(goog.log.Logger|null)`