Home Reference Source
public class | source

DisplayList

Extends:

react~React.ComponentEventDispatcher → DisplayList

This class keeps track of all display list objects that are in need of validation. This class supports deferred rendering, to prevent the UI from having to refresh on each property change. Instead, once all property changes are committed, the UI can refresh. This class is supposed to be used as a singleton. Do NOT instantiate new DisplayList objects instead, use DisplayList.instance().

Static Method Summary

Static Public Methods
public static

instance(): *

Singleton DisplayList Instance.

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public

A pointer to the document object.

public

A list of UIComponents that are pending validation.

public

The ID of the timer object associated with this display list.

Method Summary

Public Methods
public

Queues the provided object for a validate call.

public
public

kill()

Removes all event listeners

public

If you wish to remove the object from a validation queue prior to it being rendered.

public

validateNow(obj: *)

An object to validate now, rather than waiting for the invalidation timer

public

Instantly validates all objects, rather than waiting for them to validate.

Inherited Summary

From class EventDispatcher
public

[prop]: *

public
public

A list of event listeners for this event dispatcher object.

public

typeCache: {}

public

addEventListener(context: *, type: *, listener: *)

Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.

public
public

dispatchEvent(event: *): boolean

Dispatches an event into the event flow.

public
public

getStyle(prop: *): *

Gets the value of the prop property on this object

public

Returns true if an event listener exists

public

Returns true if the class name to check is in the list of class names defined for this class.

public

kill()

Removes all event listeners

public

killArray(arr: *)

Given an array of event dispatchers, calls the kill method on each of them.

public

removeEventListener(type: *, listener: *)

Removes a listener from the EventDispatcher object.

public

setStyle(prop: *, val: *)

Sets the value of the prop property on this object

Static Public Methods

public static instance(): * source

Singleton DisplayList Instance.

Return:

*

Public Constructors

public constructor() source

Override:

EventDispatcher#constructor

Public Members

public documentComponent: UIComponent source

A pointer to the document object.

public invalidObjects: Array source

A list of UIComponents that are pending validation.

public updatePending: int source

The ID of the timer object associated with this display list.

Public Methods

public addInvalidObject(obj: *) source

Queues the provided object for a validate call. Once the validateObjects method is called, all the queued objects get their render method called on them.

Params:

NameTypeAttributeDescription
obj *

Object to invalidate

public getClassNames(): string[] source

Override:

EventDispatcher#getClassNames

Return:

string[]

public kill() source

Removes all event listeners

Override:

EventDispatcher#kill

public removeInvalidObject(obj: *) source

If you wish to remove the object from a validation queue prior to it being rendered.

Params:

NameTypeAttributeDescription
obj *

Object that was previously invalidated.

public validateNow(obj: *) source

An object to validate now, rather than waiting for the invalidation timer

Params:

NameTypeAttributeDescription
obj *

An object to validate now

public validateObjects() source

Instantly validates all objects, rather than waiting for them to validate.