editor › Globals › BooleanState

Class: BooleanState

A BooleanState can have the values true or false

Hierarchy

↳ EnumState

↳ BooleanState

Index

Constructors

• constructor

Properties

• currentValue
• defaultValue
• persistence
• possibleValues

Methods

• _resetValue
• _setValue
• addPossibleValue
• getPersistentChangeEventEmitter
• getStateChangeEventEmitter
• getStateRef
• getValue
• isPersistent
• makeStatePersistent
• performCodeStateChange
• performUserStateChange
• removePersistentState
• reset
• setDefaultValue

Constructors

constructor

+ new BooleanState(stateRef: string): BooleanState

Overrides EnumState.constructor

Defined in src/angular/floatingMenu/data/menuState/BooleanState.ts:6

Parameters:

Name	Type
stateRef	string

Returns: BooleanState

Properties

Protected currentValue

• currentValue: any = null

Inherited from EnumState.currentValue

Defined in src/angular/floatingMenu/data/menuState/EnumState.ts:10

---

Protected defaultValue

• defaultValue: any

Inherited from EnumState.defaultValue

Defined in src/angular/floatingMenu/data/menuState/EnumState.ts:12

---

Protected persistence

• persistence: boolean = false

Inherited from MenuState.persistence

Defined in src/angular/floatingMenu/data/menuState/MenuState.ts:15

---

Protected possibleValues

• possibleValues: any[] = []

Inherited from EnumState.possibleValues

Defined in src/angular/floatingMenu/data/menuState/EnumState.ts:11

Methods

Protected _resetValue

▸ _resetValue(): void

Inherited from EnumState._resetValue

Defined in src/angular/floatingMenu/data/menuState/EnumState.ts:57

Returns: void

---

Protected _setValue

▸ _setValue(newValue: any): void

Inherited from EnumState._setValue

Overrides MenuState._setValue

Defined in src/angular/floatingMenu/data/menuState/EnumState.ts:43

Parameters:

Name	Type
newValue	any

Returns: void

---

addPossibleValue

▸ addPossibleValue(value: boolean): void

Overrides EnumState.addPossibleValue

Defined in src/angular/floatingMenu/data/menuState/BooleanState.ts:14

Parameters:

Name	Type
value	boolean

Returns: void

---

getPersistentChangeEventEmitter

▸ getPersistentChangeEventEmitter(): IPublicEventEmitterInterface‹IMenuStatePersistenceChange›

Inherited from MenuState.getPersistentChangeEventEmitter

Defined in src/angular/floatingMenu/data/menuState/MenuState.ts:65

Returns: IPublicEventEmitterInterface‹IMenuStatePersistenceChange›

---

getStateChangeEventEmitter

▸ getStateChangeEventEmitter(): IPublicEventEmitterInterface‹IMenuStateChange›

Inherited from MenuState.getStateChangeEventEmitter

Defined in src/angular/floatingMenu/data/menuState/MenuState.ts:61

Returns: IPublicEventEmitterInterface‹IMenuStateChange›

---

getStateRef

▸ getStateRef(): string

Inherited from MenuState.getStateRef

Defined in src/angular/floatingMenu/data/menuState/MenuState.ts:57

Returns: string

---

getValue

▸ getValue(): any

Inherited from EnumState.getValue

Overrides MenuState.getValue

Defined in src/angular/floatingMenu/data/menuState/EnumState.ts:39

Returns: any

---

isPersistent

▸ isPersistent(): boolean

Inherited from MenuState.isPersistent

Defined in src/angular/floatingMenu/data/menuState/MenuState.ts:38

Returns: boolean

---

makeStatePersistent

▸ makeStatePersistent(): void

Inherited from MenuState.makeStatePersistent

Defined in src/angular/floatingMenu/data/menuState/MenuState.ts:28

Returns: void

---

performCodeStateChange

▸ performCodeStateChange(newState?: any): void

Overrides MenuState.performCodeStateChange

Defined in src/angular/floatingMenu/data/menuState/BooleanState.ts:28

This method toggles the value, regardless of the parameter passed.

Parameters:

Name	Type
newState?	any

Returns: void

---

performUserStateChange

▸ performUserStateChange(newState?: any): void

Overrides MenuState.performUserStateChange

Defined in src/angular/floatingMenu/data/menuState/BooleanState.ts:21

This method toggles the value, regardless of the parameter passed.

Parameters:

Name	Type
newState?	any

Returns: void

---

removePersistentState

▸ removePersistentState(): void

Inherited from MenuState.removePersistentState

Defined in src/angular/floatingMenu/data/menuState/MenuState.ts:33

Returns: void

---

reset

▸ reset(): void

Inherited from EnumState.reset

Defined in src/angular/floatingMenu/data/menuState/EnumState.ts:32

Returns: void

---

setDefaultValue

▸ setDefaultValue(defaultValue: any): void

Inherited from EnumState.setDefaultValue

Defined in src/angular/floatingMenu/data/menuState/EnumState.ts:24

Parameters:

Name	Type
defaultValue	any

Returns: void