Enumeration UIElementState

Type of UI element states.

Constructors

`Protected`constructor

new UIElementState(do_not_, construct_, this_, type_): UIElementState
Parameters
- do_not_: undefined
- construct_: undefined
- this_: undefined
- type_: undefined
Returns UIElementState

Values

`Static` `Readonly`Active

Active = 1024

State when element is being clicked.

`Static` `Readonly`Focused

Focused = 2

State when the element has input focus and pointer is not hovering over the element.

`Static` `Readonly`FocusedActive

FocusedActive = 1026

State when the element has input focus and the element is being clicked.

`Static` `Readonly`FocusedActiveHover

FocusedActiveHover = 1538

State when the element has input focus and the element is being clicked.

`Static` `Readonly`FocusedActiveHoverOn

FocusedActiveHoverOn = 1794

Same as FocusedActive, if the element is also in the "on" state.

`Static` `Readonly`FocusedActiveOn

FocusedActiveOn = 1282

Same as FocusedActive, if the element is also in the "on" state.

`Static` `Readonly`FocusedHover

FocusedHover = 514

State when the element has input focus and pointer is hovering over the element.

`Static` `Readonly`FocusedHoverOn

FocusedHoverOn = 770

Same as FocusedHover, if the element is also in the "on" state.

`Static` `Readonly`FocusedOn

FocusedOn = 258

Same as Focused, if the element is also in the "on" state.

`Static` `Readonly`Hover

Hover = 512

State when pointer is hovering over the element.

`Static` `Readonly`Normal

Normal = 1

Normal state when element is not being interacted with.

`Static` `Readonly`NormalActive

NormalActive = 1025

Same as Normal, if the element is also in the "on" state.

`Static` `Readonly`NormalActiveHover

NormalActiveHover = 1537

Same as Normal, if the element is also in the "on" state.

`Static` `Readonly`NormalActiveHoverOn

NormalActiveHoverOn = 1793

Same as Normal, if the element is also in the "on" and "active" state.

`Static` `Readonly`NormalActiveOn

NormalActiveOn = 1281

Same as Normal, if the element is also in the "on" and "active" state.

`Static` `Readonly`NormalHover

NormalHover = 513

Same as Normal, if the element is also in the "hover" state.

`Static` `Readonly`NormalHoverOn

NormalHoverOn = 769

Same as Normal, if the element is also in the "on" and "hover" state.

`Static` `Readonly`NormalOn

NormalOn = 257

Same as Normal, if the element is also in the "on" state.

`Static` `Readonly`On

On = 256

State when element is in the "on" state.

Methods

`Static`addFlag

addFlag<T, K>(value, bits): K
Adds the flag bits to the enum value.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- value: K
- bits: EnumValueTyped<T, number>
Returns K

`Static`combineFlags

combineFlags<T>(values): EnumValueTyped<T, number>
Takes an array of enum values and combines them as a single enum flag value. This assumes that the target enum is a flag enum that can have their values combined using bitwise operators.
Type Parameters
- T extends Enum
Parameters
- values: EnumValue<T, number>[] | EnumValueTyped<T, number>[]
  The array of values to be combined using bitwise-or operator.
Returns EnumValueTyped<T, number>
The combined enum value.

`Static`getEnumName

getEnumName<T>(index): string
Type Parameters
- T
Parameters
- index: EnumValue<T, number>
Returns string
Obsolete
Compatibility

`Static`getEnumNames

getEnumNames(): string[]
Returns string[]
Obsolete
Compatibility

`Static`getEnumValue

getEnumValue(index): number
Parameters
- index: number
Returns number
Obsolete
Compatibility

`Static`getEnumValues

getEnumValues(): number[]
Returns number[]
Obsolete
Compatibility

`Static`getNameForValue

getNameForValue<T>(enumValue): string
Gets the name for the enumeration value that matches the specified enumValue.
Type Parameters
- T
Parameters
- enumValue: number | BrandedType<number, "enum"> | BrandedType<T, "enum">
  The enumeration value.
Returns string
The enumeration value or undefined if not found.

`Static`getNames

getNames(): string[]
Gets the enumeration names

Returns string[]
The enumeration names.

`Static`getValueAtIndex

getValueAtIndex<T>(index): EnumValueTyped<T, number>
Gets the enumeration value at the specified index.
Type Parameters
- T = number
Parameters
- index: number
  The index.
Returns EnumValueTyped<T, number>
The enumeration value or undefined if not found.

`Static`getValues

getValues<T>(): EnumValueTyped<T, number>[]
Gets the enumeration values
Type Parameters
- T = any
Returns EnumValueTyped<T, number>[]
The enumeration values.

`Static`hasFlag

hasFlag<T, K>(value, bits): boolean
Determines if the enum value has the flags set.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- value: K
- bits: EnumValueTyped<T, number>
Returns boolean

`Static`hasFlagChanged

hasFlagChanged<T, K>(previousValue, newValue, bits): boolean
Determines if the enum bits were changed from previousValue to currentValue.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- previousValue: K
- newValue: K
- bits: EnumValueTyped<T, number>
Returns boolean

`Static`iterateNames

iterateNames(): Generator<string, any, any>
Iterates the enumeration names

Returns Generator<string, any, any>
The enumeration names.

`Static`iterateValues

iterateValues<T>(): Generator<EnumValueTyped<T, number>, any, any>
Iterates the enumeration values
Type Parameters
- T = any
Returns Generator<EnumValueTyped<T, number>, any, any>
The enumeration values.

`Static`removeFlag

removeFlag<T, K>(value, bits): K
Removes the flag bits from the enum value.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- value: K
- bits: EnumValueTyped<T, number>
Returns K

`Static`splitFlags

splitFlags<T>(value): EnumValueTyped<T, number>[]
Takes a single enum value and splits it into separated flag values set on the value. This assumes that the target enum is a flag enum that can have their values combined using bitwise operators.
Type Parameters
- T extends Enum
Parameters
- value: number | BrandedType<number, "enum"> | BrandedType<T, "enum">
  The enum value to have it's value split using bitwise-and operator.
Returns EnumValueTyped<T, number>[]
An array of each "bit flag" set in the enum.

Enumeration UIElementState

Index

Constructors

Values

Methods

Constructors

Protectedconstructor

Parameters

Returns UIElementState

Values

Static ReadonlyActive

Static ReadonlyFocused

Static ReadonlyFocusedActive

Static ReadonlyFocusedActiveHover

Static ReadonlyFocusedActiveHoverOn

Static ReadonlyFocusedActiveOn

Static ReadonlyFocusedHover

Static ReadonlyFocusedHoverOn

Static ReadonlyFocusedOn

Static ReadonlyHover

Static ReadonlyNormal

Static ReadonlyNormalActive

Static ReadonlyNormalActiveHover

Static ReadonlyNormalActiveHoverOn

Static ReadonlyNormalActiveOn

Static ReadonlyNormalHover

Static ReadonlyNormalHoverOn

Static ReadonlyNormalOn

Static ReadonlyOn

Methods

StaticaddFlag

Type Parameters

Parameters

Returns K

StaticcombineFlags

Type Parameters

Parameters

Returns EnumValueTyped<T, number>

StaticgetEnumName

Type Parameters

Parameters

Returns string

Obsolete

StaticgetEnumNames

Returns string[]

Obsolete

StaticgetEnumValue

Parameters

Returns number

Obsolete

StaticgetEnumValues

Returns number[]

Obsolete

StaticgetNameForValue

Type Parameters

Parameters

Returns string

StaticgetNames

Returns string[]

StaticgetValueAtIndex

Type Parameters

Parameters

Returns EnumValueTyped<T, number>

StaticgetValues

Type Parameters

Returns EnumValueTyped<T, number>[]

StatichasFlag

Type Parameters

Parameters

Returns boolean

StatichasFlagChanged

Type Parameters

Parameters

Returns boolean

StaticiterateNames

Returns Generator<string, any, any>

StaticiterateValues

Type Parameters

Returns Generator<EnumValueTyped<T, number>, any, any>

StaticremoveFlag

`Protected`constructor

`Static` `Readonly`Active

`Static` `Readonly`Focused

`Static` `Readonly`FocusedActive

`Static` `Readonly`FocusedActiveHover

`Static` `Readonly`FocusedActiveHoverOn

`Static` `Readonly`FocusedActiveOn

`Static` `Readonly`FocusedHover

`Static` `Readonly`FocusedHoverOn

`Static` `Readonly`FocusedOn

`Static` `Readonly`Hover

`Static` `Readonly`Normal

`Static` `Readonly`NormalActive

`Static` `Readonly`NormalActiveHover

`Static` `Readonly`NormalActiveHoverOn

`Static` `Readonly`NormalActiveOn

`Static` `Readonly`NormalHover

`Static` `Readonly`NormalHoverOn

`Static` `Readonly`NormalOn

`Static` `Readonly`On

`Static`addFlag

`Static`combineFlags

`Static`getEnumName

`Static`getEnumNames

`Static`getEnumValue

`Static`getEnumValues

`Static`getNameForValue

`Static`getNames

`Static`getValueAtIndex

`Static`getValues

`Static`hasFlag

`Static`hasFlagChanged

`Static`iterateNames

`Static`iterateValues

`Static`removeFlag

`Static`splitFlags