Class BaseClickHelper`Abstract`

The base class for CompoundClickHelper and GenericClickHelper. All click state properties must be at least gettable, and optionally settable.

Hierarchy (view full)

Notifier<ClickHelperEventType>
- BaseClickHelper
  - CompoundClickHelper
  - GenericClickHelper

Index

Constructors

Properties

Accessors

Methods

addEventListener dispatchEvent dispatchToListener removeEventListener reset

Constructors

constructor

new BaseClickHelper(): BaseClickHelper
Returns BaseClickHelper
Inherited from Notifier.constructor

Properties

`Protected` `Readonly`listeners

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

Accessors

`Abstract`clickState

get clickState(): ClickState
The current click state

Returns ClickState
- Defined in src/helpers/BaseClickHelper.ts:14

Methods

addEventListener

addEventListener(listener): void
Listen to events from this helper. Duplicate listeners allowed.
Parameters
- listener: Listener<ClickHelperEventType>
Returns void
Inherited from Notifier.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 Notifier.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 Notifier.dispatchToListener
- Defined in src/helpers/Notifier.ts:37

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 Notifier.removeEventListener
- Defined in src/helpers/Notifier.ts:29

`Abstract`reset

reset(): void
Reset the click helper to its default state. Only call this if absolutely necessary, such as when the owner Widget is re-activated (this way, hover states don't linger when a Widget is disabled).

Returns void
- Defined in src/helpers/BaseClickHelper.ts:20