Home Reference Source 
import PropEvents from 'observabubble/props/classes/PropEvents.js'
public class | source

PropEvents

Direct Subclass:

ARRAY, OBJECT, Prop

Indirect Subclass:

BOOLEAN, DATE, DECIMAL, INTEGER, REFERENCE, STRING, TEXT, User, UserRef

The Prop Event Class

Constructor Summary

Public Constructor
public

constructor(value: any, parent: OBJECT)

Member Summary

Public Members
public
public
public

parent: *

Private Members
private

_event: {}

Method Summary

Public Methods
public

off(eventName: Event, callback: Function)

Unbinds an event listener
public

on(eventName: Event, callback: Function)

Bind an event listener
Private Methods
private

_bubble(eventName: Event, target: Prop)

Calls event bubbling on the parent Observable
private

async _processEvent(eventName: Event, target: Prop, additional: Object)

Calls the listeners for the Event triggered

Public Constructors

public constructor(value: any, parent: OBJECT) source

Params:

NameTypeAttributeDescription
value any

The initial value of the property
parent OBJECT

The Parent Object to which this Property is a member of (Object)

Public Members

public eventCallbacks: * source

public isObservable: * source

public parent: * source

Private Members

private _event: {} source

Public Methods

public off(eventName: Event, callback: Function) source

Unbinds an event listener

Params:

NameTypeAttributeDescription
eventName Event

The event being listening to, enumerated in the events file
callback Function

The method called when the event is fired

public on(eventName: Event, callback: Function) source

Bind an event listener

Params:

NameTypeAttributeDescription
eventName Event

The event being listening to, enumerated in the events file
callback Function

The method called when the event is fired

Private Methods

private _bubble(eventName: Event, target: Prop) source

Calls event bubbling on the parent Observable

Params:

NameTypeAttributeDescription
eventName Event

The event being listening to, enumerated in the events file
target Prop

The Prop that was the source of the Event

private async _processEvent(eventName: Event, target: Prop, additional: Object) source

Calls the listeners for the Event triggered

Params:

NameTypeAttributeDescription
eventName Event

The event being listening to, enumerated in the events file
target Prop

The Prop that was the source of the Event
additional Object
  • optional
additional.bubble Boolean
  • optional
  • default: false

A boolean that indicates that the event firing is bubbled from a child Prop