editor › Globals › ParametricEnumState

Class: ParametricEnumState

Extends the enum state to have an additional 'parameters' object and consider state value + parameters as "the state"

Hierarchy

↳ EnumState

↳ ParametricEnumState

Index

Constructors

• constructor

Properties

• currentStateParameters
• currentValue
• defaultParameters
• defaultValue
• persistence
• possibleValues

Methods

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

Constructors

constructor

+ new ParametricEnumState(stateRef: string): ParametricEnumState

Inherited from EnumState.constructor

Overrides MenuState.constructor

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

Parameters:

Name	Type
stateRef	string

Returns: ParametricEnumState

Properties

Private currentStateParameters

• currentStateParameters: any = null

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

The parameters that belong to the current state

---

Protected currentValue

• currentValue: any = null

Inherited from EnumState.currentValue

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

---

Private defaultParameters

• defaultParameters: any = null

Defined in src/angular/floatingMenu/data/menuState/ParametricEnumState.ts:13

The parameters of the default tool

---

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

Overrides EnumState._resetValue

Defined in src/angular/floatingMenu/data/menuState/ParametricEnumState.ts:40

Returns: void

---

Protected _setValue

▸ _setValue(newValue: any): void

Overrides EnumState._setValue

Defined in src/angular/floatingMenu/data/menuState/ParametricEnumState.ts:30

Parameters:

Name	Type
newValue	any

Returns: void

---

addPossibleValue

▸ addPossibleValue(possibleValue: any): void

Inherited from EnumState.addPossibleValue

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

Parameters:

Name	Type
possibleValue	any

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(): object

Overrides EnumState.getValue

Defined in src/angular/floatingMenu/data/menuState/ParametricEnumState.ts:20

Returns: object

• parameters: any = this.currentStateParameters

• value: any = super.getValue()

---

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(newValue: any): void

Inherited from MenuState.performCodeStateChange

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

Parameters:

Name	Type
newValue	any

Returns: void

---

performUserStateChange

▸ performUserStateChange(newValue: any): void

Inherited from MenuState.performUserStateChange

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

Parameters:

Name	Type
newValue	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

Overrides EnumState.reset

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

Returns: void

---

setDefaultValue

▸ setDefaultValue(newValue: any): void

Overrides EnumState.setDefaultValue

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

Parameters:

Name	Type
newValue	any

Returns: void