Final Class: EventSource

Oracle® JavaScript Extension Toolkit (JET)
16.0.0
F83701-01

Since:
  • 1.1
Module:
  • ojcore-base

Note: This class is deprecated since 5.0.0. Use DataProvider instead.

QuickNav

Methods

Description

Object which supports subscribing to and firing events


Usage

Typescript Import Format
//To import this class, use the format below.
import {EventSource} from "ojs/ojcore-base";

For additional information visit:


Final classes in JET

Classes in JET are generally final and do not support subclassing. At the moment, final is not enforced. However, this will likely change in an upcoming JET release.


Constructor

new EventSource

Methods

handleEvent(eventType, event) : {boolean}

Handle the event
Parameters:
Name Type Description
eventType string event type
event Object event
Returns:

Returns false if event is cancelled

Type
boolean

Init

Initializes the instance.

off(eventType, eventHandler) : {void}

Detach an event handler.

Application can call this if it no longer wants to be notified of an event that it has attached an handler to using the on method.

Parameters:
Name Type Description
eventType string eventType
eventHandler function(Object) event handler function
Returns:
Type
void

on(eventType, eventHandler) : {void}

Attach an event handler.

Application can call this if it wants to be notified of an event. It can call the off method to detach the handler when it no longer wants to be notified.

Parameters:
Name Type Description
eventType string eventType
eventHandler function(Object) event handler function
Returns:
Type
void