Skip to main content
Version: Version 5

Class: TextSelectionPlugin

EventEmitter is a class designed for managing and dispatching events.

Extends

Constructors

new TextSelectionPlugin()

new TextSelectionPlugin(documentView, __document): TextSelectionPlugin

Parameters

documentView: DocumentView

__document: Document

Returns

TextSelectionPlugin

Overrides

EventEmitter.constructor

Accessors

active

get active(): boolean

set active(v): void

Parameters

v: boolean

Returns

boolean

Methods

activate()

activate(): void

Returns

void


addEventListener()

addEventListener<K>(type, listener): void

Register a function that will be called whenever the specified event is delivered.

Type Parameters

K extends "textSelectionChanged"

A generic type representing the key of the event type.

Parameters

type: K

String representing the event type to listen for.

listener

The function that will be executed when an event of the specified type occurs.

Returns

void

Inherited from

EventEmitter.addEventListener


deactivate()

deactivate(): void

Returns

void


dispatchEvent()

dispatchEvent<K>(type, args): void

Dispatches an event to all registered listeners.

Type Parameters

K extends "textSelectionChanged"

A generic type representing the key of the event type.

Parameters

type: K

String representing the event type to dispatch.

args: Parameters<TextSelectionPluginEventMap[K]>

The data associated with the event.

Returns

void

Inherited from

EventEmitter.dispatchEvent


removeAllListeners()

removeAllListeners<K>(type): void

Remove all listeners for a given event.

Type Parameters

K extends "textSelectionChanged"

A generic type representing the key of the event type.

Parameters

type: K

String representing the event for which to remove all listeners.

Returns

void

Inherited from

EventEmitter.removeAllListeners


removeEventListener()

removeEventListener<K>(type, listener): void

Removes an event listener previously registered with addEventListener.

Type Parameters

K extends "textSelectionChanged"

A generic type representing the key of the event type.

Parameters

type: K

String representing the event for which to remove an event listener.

listener

The event listener function of the event handler to remove from the event target.

Returns

void

Inherited from

EventEmitter.removeEventListener