Class CompoundClickHelper

A class that mixes multiple BaseClickHelper instances into one. Useful if you want a widget to be both clickable by a pointer and by the enter key

Hierarchy (view full)

BaseClickHelper
- CompoundClickHelper
  - ButtonClickHelper
  - ComplementaryClickHelper

Index

Constructors

Properties

_clickState clickHelpers listeners refs

Accessors

Methods

addEventListener dispatchEvent dispatchToListener handleDependentEvent ref removeEventListener reset unref updateClickState

Constructors

constructor

new CompoundClickHelper(clickHelpers): CompoundClickHelper
Parameters
- clickHelpers: BaseClickHelper[]
Returns CompoundClickHelper
Overrides BaseClickHelper.constructor
- Defined in src/helpers/CompoundClickHelper.ts:18

Properties

`Private`_clickState

_clickState: ClickState = ClickState.Released

`Protected`clickHelpers

clickHelpers: BaseClickHelper[]

The BaseClickHelper instances being mixed

`Protected` `Readonly`listeners

listeners: ConcurrentCollection<Listener<ClickHelperEventType>> = ...

`Protected`refs

refs: number = 0

Accessors

clickState

get clickState(): ClickState
The current click state

Returns ClickState
Overrides BaseClickHelper.clickState
- Defined in src/helpers/CompoundClickHelper.ts:84

Methods

addEventListener

addEventListener(listener): void
Listen to events from this helper. Duplicate listeners allowed.
Parameters
- listener: Listener<ClickHelperEventType>
Returns void
Inherited from BaseClickHelper.addEventListener
- Defined in src/helpers/Notifier.ts:19

`Protected`dispatchEvent

dispatchEvent(event): void
Dispatch an event to all listeners.
Parameters
- event: ClickHelperEventType
Returns void
Inherited from BaseClickHelper.dispatchEvent
- Defined in src/helpers/Notifier.ts:46

`Protected`dispatchToListener

dispatchToListener(event, listener): void
Dispatch an event to a specific listener. Listener does not have to be added
Parameters
- event: ClickHelperEventType
- listener: Listener<ClickHelperEventType>
Returns void
Inherited from BaseClickHelper.dispatchToListener
- Defined in src/helpers/Notifier.ts:37

`Protected` `Readonly`handleDependentEvent

handleDependentEvent(eventType): void
Parameters
- eventType: ClickHelperEventType
Returns void
- Defined in src/helpers/CompoundClickHelper.ts:69

ref

ref(): void
Start listening to all ClickHelpers events. Must be called when a widget that uses this CompoundClickHelper is attached to the UI tree (handleAttachment).

Returns void
- Defined in src/helpers/CompoundClickHelper.ts:28

removeEventListener

removeEventListener(listener): boolean
Stop listening to events from this helper. If a duplicate listener is removed, only one is removed.
Parameters
- listener: Listener<ClickHelperEventType>
Returns boolean
True if a listener was removed, false otherwise.
Inherited from BaseClickHelper.removeEventListener
- Defined in src/helpers/Notifier.ts:29

reset

reset(): void
Resets each click helper instance being mixed.

Returns void
Overrides BaseClickHelper.reset
- Defined in src/helpers/CompoundClickHelper.ts:89

unref

unref(): void
Stop listening to all ClickHelpers events. Must be called when a widget that uses this CompoundClickHelper is detached from the UI tree (handleDetachment).

Returns void
- Defined in src/helpers/CompoundClickHelper.ts:45

`Private`updateClickState

updateClickState(): void
Returns void
- Defined in src/helpers/CompoundClickHelper.ts:58