⁘ ui.core.helpers

FlagEnum

go to → Members

Members

read-onlycurrentFlag :string

TODO

read-onlyonFlagChanged :common.signals.SignalBroadcaster

TODO

Methods

Add(…values)

Adds an element to a flagEnum

Parameters:
Name Type Attributes Description
values HTMLElement <repeatable>

AddEnum(…values)

Adds a set of possible values to this object

Parameters:
Name Type Attributes Description
values string <repeatable>

AddManaged(…values)

Add a set of flagEnum to be managed by the current one. Flag set on the current flagEnum will be set on any managed flagEnums.

Parameters:
Name Type Attributes Description
values FlagEnum <repeatable>

Apply(p_key, p_list)

Goes through a list of object and set a given property name to this flagEnum's current flag.

Parameters:
Name Type Description
p_key string
p_list array

Bump(p_flag)

Bumps the current value to the provided flag if its index is higher than the current one.

Parameters:
Name Type Description
p_flag string

Clear()

TODO

Remove(…values)

Removes an element from the flagEnum

Parameters:
Name Type Attributes Description
values HTMLElement <repeatable>

RemoveEnum(…values)

Removes a set of possible values from this object

Parameters:
Name Type Attributes Description
values string <repeatable>

RemoveManaged(…values)

Removes a set of managed flagEnums

Parameters:
Name Type Attributes Description
values FlagEnum <repeatable>

Set(p_flag)

Set the flagEnum current value. Each element in this flagEnum list will have the previous enum value removed from its classList, and the current one (if not null) will be added instead. Managed flagEnum will be updated accordingly.

Parameters:
Name Type Description
p_flag string