BooleanSetting
Deprecated
Extends
Extended by
Constructors
Constructor
new BooleanSetting(options): BooleanSetting;
Parameters
| Parameter | Type |
|---|---|
options | BooleanControlOptions |
Returns
BooleanSetting
Overrides
AbstractUserSetting.constructor
Properties
| Property | Type | Inherited from |
|---|---|---|
deserialized | boolean | AbstractUserSetting.deserialized |
logger | Logger | AbstractUserSetting.logger |
options | BooleanControlOptions | AbstractUserSetting.options |
Accessors
checked
initialized
Inherited from
AbstractUserSetting.initialized
themeStore
Methods
canBeChanged()
canBeChanged(): boolean;
Returns
boolean
Inherited from
AbstractUserSetting.canBeChanged
deserialize()
deserialize(data): void;
Parameters
| Parameter | Type |
|---|---|
data | any |
Returns
void
Overrides
AbstractUserSetting.deserialize
doDeserialize()
doDeserialize(data): void;
FYI: This is called after init()
Parameters
| Parameter | Type |
|---|---|
data | any |
Returns
void
Inherited from
AbstractUserSetting.doDeserialize
doSerialize()
doSerialize(): any;
Returns
any
Inherited from
AbstractUserSetting.doSerialize
generateControl()
generateControl(): Element;
Returns
Element
Overrides
AbstractUserSetting.generateControl
init()
init(): Promise<void>;
Returns
Promise<void>
Inherited from
renderAsCheckbox()
renderAsCheckbox(label?): Element;
Parameters
| Parameter | Type |
|---|---|
label? | string |
Returns
Element
renderAsToggle()
renderAsToggle(): Element;
Returns
Element
reset()
reset(): void;
Returns
void
Inherited from
save()
save(): void;
Returns
void
Inherited from
serialize()
serialize(): {
checked: boolean;
};
Returns
{
checked: boolean;
}
| Name | Type |
|---|---|
checked | boolean |
Overrides
AbstractUserSetting.serialize
setChecked()
setChecked(checked): void;
Parameters
| Parameter | Type |
|---|---|
checked | boolean |
Returns
void
setDefault()
setDefault(value): void;
Parameters
| Parameter | Type |
|---|---|
value | boolean |
Returns
void
Inherited from
AbstractUserSetting.setDefault
toggle()
toggle(): void;
Returns
void
updateOptions()
updateOptions(options): void;
Parameters
| Parameter | Type |
|---|---|
options | Partial<T> |
Returns
void
Inherited from
AbstractUserSetting.updateOptions
waitForReady()
waitForReady(): Promise<BooleanSetting>;
Returns
Promise<BooleanSetting>