goog.tweak.BaseSetting Classgoog.tweak.BaseSetting
> goog.tweak.BaseEntry
goog.tweak.BaseSetting(id, description)Base class for all tweak entries that are settings. Settings are entries that are associated with a query parameter.
id {string}
description {string}
.addCallback(callback)Inherited from goog.tweak.BaseEntry .
Adds a callback that should be called when the setting has changed (or when an action has been clicked).
callback {!Function}
.assertNotInitialized(funcName) [protected]Asserts that this tweak has not been initialized yet.
funcName {string}
.ensureInitialized() [protected]Applies the default value or query param value if this is the first time that the function has been called.
.fireCallbacks()Inherited from goog.tweak.BaseEntry .
Calls all registered callbacks.
.getId()Inherited from goog.tweak.BaseEntry .
string}
.getNewValueEncoded()Returns the value to be used in the query parameter for this tweak.
string}
.getParamName()Returns the name of the query parameter used for this setting.
string}
.initialQueryParamValue [protected] {string|undefined}The value of this setting's query parameter.
.initialize(value) [protected]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.
value {?string}
.isInitializing() [protected]Returns whether the setting is currently being initialized.
boolean}
.isRestartRequired()Inherited from goog.tweak.BaseEntry .
Returns whether a restart is required for changes to the setting to take effect.
boolean}
.logger [protected] {!goog.debug.Logger}The logger for this class.
.removeCallback(callback)Inherited from goog.tweak.BaseEntry .
Removes a callback that was added by addCallback.
callback {!Function}
.setInitialQueryParamValue(value)Sets the initial query parameter value for this setting. May not be called after the setting has been initialized.
value {string}
.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.
value {?string}
.setRestartRequired(value)Inherited from goog.tweak.BaseEntry .
Sets whether a restart is required for changes to the setting to take effect.
value {boolean}