goog.tweak.BooleanSetting
Classgoog.tweak.BooleanSetting
> goog.tweak.BasePrimitiveSetting
> goog.tweak.BaseSetting
> goog.tweak.BaseEntry
goog.tweak.BooleanSetting(id, description)
A registry setting that can be either true of false.
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]Inherited from goog.tweak.BaseSetting
.
Asserts that this tweak has not been initialized yet.
funcName
{string
}
.encodeNewValue()
[protected]Returns the query param encoded representation of the setting's value.
string
}
.ensureInitialized()
[protected]Inherited from goog.tweak.BaseSetting
.
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.
.getDefaultValue
Returns the default value for this setting.
boolean
}
.getId()
Inherited from goog.tweak.BaseEntry
.
string
}
.getNewValue
Returns the value of the setting to use once "Apply Tweaks" is clicked.
boolean
}
.getNewValueEncoded()
Inherited from goog.tweak.BasePrimitiveSetting
.
Returns the value to be used in the query parameter for this tweak.
string
}
.getParamName()
Inherited from goog.tweak.BaseSetting
.
Returns the name of the query parameter used for this setting.
string
}
.getValue
If the setting has the restartRequired option, then returns its inital value. Otherwise, returns its current value.
boolean
}
.initialize()
.isInitializing()
[protected]Inherited from goog.tweak.BaseSetting
.
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
}
.setDefaultValue
Sets the default value for the tweak.
value
{boolean
}
.setInitialQueryParamValue(value)
Inherited from goog.tweak.BaseSetting
.
Sets the initial query parameter value for this setting. May not be called after the setting has been initialized.
value
{string
}
.setParamName(value)
Inherited from goog.tweak.BaseSetting
.
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
}
.setValue
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.
value
{boolean
}