tweak.BooleanInGroupSetting Extends goog.tweak.BooleanSetting
An entry in a BooleanGroup.

Inheritance

Constructor

goog.tweak.BooleanInGroupSetting(iddescriptiongroup)

Parameters

id : string
The ID for the setting.
description : string
A description of what the setting does.
group : !goog.tweak.BooleanGroup
The group that this entry belongs to.

Instance Methods

Public Protected Private
getGroup() !goog.tweak.BooleanGroup
Returns the BooleanGroup that this setting belongs to.
Returns: !goog.tweak.BooleanGroup  The BooleanGroup that this setting belongs to.
code »
getToken() string
Returns the token to use in the query parameter.
Returns: string  The value.
code »
setParamName()
No description.
code »
setToken(value)
Sets the token to use in the query parameter.
Arguments:
value : string
The value.
code »
encodeNewValue()
No description.
code »
getDefaultValue() boolean
No description.
Returns: boolean  The default value.
code »
getNewValue() boolean
No description.
Returns: boolean  The tweaks's new value.
code »
getValue() boolean
No description.
Returns: boolean  The tweaks's value.
code »
initialize()
No description.
code »
setDefaultValue(value)
No description.
Arguments:
value : boolean
The default value.
code »
setValue(value)
No description.
Arguments:
value : boolean
The tweaks's value.
code »
encodeNewValue() string
Returns the query param encoded representation of the setting's value.
Returns: string  The encoded value.
code »
getDefaultValue() *
Returns the default value for this setting.
Returns: *  The default value.
code »
getNewValue() *
Returns the value of the setting to use once "Apply Tweaks" is clicked.
Returns: *  The value.
code »
getNewValueEncoded()
No description.
code »
getValue() *
If the setting has the restartRequired option, then returns its inital value. Otherwise, returns its current value.
Returns: *  The value.
code »
setDefaultValue(value)
Sets the default value for the tweak.
Arguments:
value : *
The new value.
code »
setValue(value)
Sets the value of the setting. If the setting has the restartRequired option, then the value will not be changed until the "Apply Tweaks" button is clicked. If it does not have the option, the value will be update immediately and all registered callbacks will be called.
Arguments:
value : *
The value.
code »
assertNotInitialized(funcName)
Asserts that this tweak has not been initialized yet.
Arguments:
funcName : string
Function name to use in the assertion message.
code »
ensureInitialized()
Applies the default value or query param value if this is the first time that the function has been called.
code »
getNewValueEncoded() ?string
Returns the value to be used in the query parameter for this tweak.
Returns: ?string  The encoded value. Null if the value is set to its default.
code »
getParamName() ?string
Returns the name of the query parameter used for this setting.
Returns: ?string  The param name. Null if no query parameter is directly associated with the setting.
code »
initialize(value)
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.
Arguments:
value : ?string
The part of the query param for this setting after the '='. Null if it is not present.
code »
isInitializing() boolean
Returns whether the setting is currently being initialized.
Returns: boolean  Whether the setting is currently being initialized.
code »
setInitialQueryParamValue(value)
Sets the initial query parameter value for this setting. May not be called after the setting has been initialized.
Arguments:
value : string
The inital query parameter value for this setting.
code »
setParamName(value)
Sets the name of the query parameter used for this setting. If null is passed the the setting will not appear in the top-level query string.
Arguments:
value : ?string
The new value.
code »
addCallback(callback)
Adds a callback that should be called when the setting has changed (or when an action has been clicked).
Arguments:
callback : !Function
The callback to add.
code »
fireCallbacks()
Calls all registered callbacks.
code »
getId() string
No description.
Returns: string  Returns the entry's ID.
code »
isRestartRequired() boolean
Returns whether a restart is required for changes to the setting to take effect.
Returns: boolean  The value.
code »
removeCallback(callback)
Removes a callback that was added by addCallback.
Arguments:
callback : !Function
The callback to add.
code »
setRestartRequired(value)
Sets whether a restart is required for changes to the setting to take effect.
Arguments:
value : boolean
The new value.
code »

Instance Properties

constructor :
No description.
Code »
The BooleanGroup that this setting belongs to.
Code »
The logger for this class.
Code »
token_ :
The token to use in the query parameter.
Code »
constructor :
No description.
Code »
The logger for this class.
Code »
constructor :
No description.
Code »
defaultValue_ :
The default value of the setting.
Code »
The logger for this class.
Code »
newValue_ :
The value of the tweak once "Apply Tweaks" is pressed.
Code »
value_ :
The value of the tweak.
Code »
constructor :
No description.
Code »
initialQueryParamValue :
The value of this setting's query parameter.
Code »
initializeState_ :
Whether initialize() has been called (or is in the middle of being called).
Code »
The logger for this class.
Code »
paramName_ :
The query parameter that controls this setting.
Code »
callbacks_ :
Functions to be called whenever a setting is changed or a button is clicked.
Code »
description :
A description of what this entry does.
Code »
id_ :
An ID to uniquely identify the entry.
Code »
label :
A descriptive label for the entry.
Code »
The logger for this class.
Code »
restartRequired_ :
Whether a restart is required for changes to the setting to take effect.
Code »

Static Properties

goog.tweak.BooleanInGroupSetting.superClass_ :
No description.
Code »

Package tweak

Package Reference