mirror of
https://github.com/NativeScript/NativeScript.git
synced 2025-11-05 13:26:48 +08:00
21
tns-core-modules/data/observable/observable.d.ts
vendored
21
tns-core-modules/data/observable/observable.d.ts
vendored
@@ -29,7 +29,7 @@ declare module "data/observable" {
|
||||
*/
|
||||
value: any;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Helper class that is used to fire property change even when real object is the same.
|
||||
* By default property change will not be fired for a same object.
|
||||
@@ -40,26 +40,26 @@ declare module "data/observable" {
|
||||
* Property which holds the real value.
|
||||
*/
|
||||
wrapped: any;
|
||||
|
||||
|
||||
/**
|
||||
* Creates an instance of WrappedValue object.
|
||||
* @param value - the real value which should be wrapped.
|
||||
*/
|
||||
constructor(value: any);
|
||||
|
||||
|
||||
/**
|
||||
* Gets the real value of previously wrappedValue.
|
||||
* @param value - Value that should be unwraped. If there is no wrappedValue property of the value object then value will be returned.
|
||||
*/
|
||||
static unwrap(value: any): any;
|
||||
|
||||
|
||||
/**
|
||||
* Returns an instance of WrappedValue. The actual instance is get from a WrappedValues pool.
|
||||
* @param value - Value that should be wrapped.
|
||||
*/
|
||||
static wrap(value: any): WrappedValue
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Observable is used when you want to be notified when a change occurs. Use on/off methods to add/remove listener.
|
||||
@@ -70,16 +70,6 @@ declare module "data/observable" {
|
||||
*/
|
||||
public static propertyChangeEvent: string;
|
||||
|
||||
/**
|
||||
* [Deprecated please use static functions fromJSON or fromJSONRecursive instead] Creates an Observable instance and sets its properties according to the supplied JSON object.
|
||||
*/
|
||||
constructor(json?: any);
|
||||
|
||||
/**
|
||||
* Gets the name of the constructor function for this instance. E.g. for a Button class this will return "Button".
|
||||
*/
|
||||
typeName: string;
|
||||
|
||||
/**
|
||||
* A basic method signature to hook an event listener (shortcut alias to the addEventListener method).
|
||||
* @param eventNames - String corresponding to events (e.g. "propertyChange"). Optionally could be used more events separated by `,` (e.g. "propertyChange", "change").
|
||||
@@ -145,7 +135,6 @@ declare module "data/observable" {
|
||||
/**
|
||||
* This method is intended to be overriden by inheritors to provide additional implementation.
|
||||
*/
|
||||
_setCore(data: PropertyChangeData);
|
||||
_createPropertyChangeData(name: string, value: any): PropertyChangeData;
|
||||
_emit(eventNames: string);
|
||||
//@endprivate
|
||||
|
||||
@@ -1,43 +1,28 @@
|
||||
import * as types from "utils/types";
|
||||
import * as definition from "data/observable";
|
||||
import { Observable as ObservableDefinition, WrappedValue as WrappedValueDefinition, EventData, PropertyChangeData } from "data/observable";
|
||||
|
||||
interface ListenerEntry {
|
||||
callback: (data: definition.EventData) => void;
|
||||
callback: (data: EventData) => void;
|
||||
thisArg: any;
|
||||
}
|
||||
|
||||
var _wrappedIndex = 0;
|
||||
let _wrappedIndex = 0;
|
||||
|
||||
export class WrappedValue implements definition.WrappedValue {
|
||||
private _wrapped: any;
|
||||
|
||||
public get wrapped(): any {
|
||||
return this._wrapped;
|
||||
export class WrappedValue implements WrappedValueDefinition {
|
||||
constructor(public wrapped: any) {
|
||||
}
|
||||
|
||||
public set wrapped(value) {
|
||||
this._wrapped = value;
|
||||
}
|
||||
|
||||
constructor(value: any) {
|
||||
this._wrapped = value;
|
||||
}
|
||||
|
||||
|
||||
public static unwrap(value: any) {
|
||||
if (value && value.wrapped) {
|
||||
return value.wrapped;
|
||||
}
|
||||
return value;
|
||||
return (value && value.wrapped) ? value.wrapped : value;
|
||||
}
|
||||
|
||||
|
||||
public static wrap(value: any) {
|
||||
var w = _wrappedValues[_wrappedIndex++ % 5];
|
||||
const w = _wrappedValues[_wrappedIndex++ % 5];
|
||||
w.wrapped = value;
|
||||
return w;
|
||||
}
|
||||
}
|
||||
|
||||
var _wrappedValues = [
|
||||
let _wrappedValues = [
|
||||
new WrappedValue(null),
|
||||
new WrappedValue(null),
|
||||
new WrappedValue(null),
|
||||
@@ -45,37 +30,26 @@ var _wrappedValues = [
|
||||
new WrappedValue(null)
|
||||
]
|
||||
|
||||
export class Observable implements definition.Observable {
|
||||
export class Observable implements ObservableDefinition {
|
||||
public static propertyChangeEvent = "propertyChange";
|
||||
_map: Map<string, Object>;
|
||||
|
||||
private _observers = {};
|
||||
|
||||
constructor(source?: any) {
|
||||
if (source) {
|
||||
addPropertiesFromObject(this, source);
|
||||
public get(name: string): any {
|
||||
return this[name];
|
||||
}
|
||||
|
||||
public set(name: string, value: any) {
|
||||
// TODO: Parameter validation
|
||||
if (this[name] === value) {
|
||||
return;
|
||||
}
|
||||
|
||||
const newValue = WrappedValue.unwrap(value);
|
||||
this[name] = newValue;
|
||||
this.notifyPropertyChange(name, newValue);
|
||||
}
|
||||
|
||||
_defineNewProperty(propertyName: string): void {
|
||||
Object.defineProperty(this, propertyName, {
|
||||
get: function () {
|
||||
return this._map.get(propertyName);
|
||||
},
|
||||
set: function (value) {
|
||||
this._map.set(propertyName, value);
|
||||
this.notify(this._createPropertyChangeData(propertyName, value));
|
||||
},
|
||||
enumerable: true,
|
||||
configurable: true
|
||||
});
|
||||
}
|
||||
|
||||
get typeName(): string {
|
||||
return types.getClass(this);
|
||||
}
|
||||
|
||||
public on(eventNames: string, callback: (data: definition.EventData) => void, thisArg?: any) {
|
||||
public on(eventNames: string, callback: (data: EventData) => void, thisArg?: any) {
|
||||
this.addEventListener(eventNames, callback, thisArg);
|
||||
}
|
||||
|
||||
@@ -83,18 +57,19 @@ export class Observable implements definition.Observable {
|
||||
this.removeEventListener(eventNames, callback, thisArg);
|
||||
}
|
||||
|
||||
public addEventListener(eventNames: string, callback: (data: definition.EventData) => void, thisArg?: any) {
|
||||
if (!types.isString(eventNames)) {
|
||||
public addEventListener(eventNames: string, callback: (data: EventData) => void, thisArg?: Object) {
|
||||
if (typeof eventNames !== "string") {
|
||||
throw new TypeError("Events name(s) must be string.");
|
||||
}
|
||||
|
||||
types.verifyCallback(callback);
|
||||
if (typeof callback !== "function") {
|
||||
throw new TypeError("callback must be function.");
|
||||
}
|
||||
|
||||
var events: Array<string> = eventNames.split(",");
|
||||
|
||||
for (var i = 0, l = events.length; i < l; i++) {
|
||||
var event = events[i].trim();
|
||||
var list = this._getEventList(event, true);
|
||||
const events = eventNames.split(",");
|
||||
for (let i = 0, l = events.length; i < l; i++) {
|
||||
const event = events[i].trim();
|
||||
const list = this._getEventList(event, true);
|
||||
// TODO: Performance optimization - if we do not have the thisArg specified, do not wrap the callback in additional object (ObserveEntry)
|
||||
list.push({
|
||||
callback: callback,
|
||||
@@ -103,19 +78,22 @@ export class Observable implements definition.Observable {
|
||||
}
|
||||
}
|
||||
|
||||
public removeEventListener(eventNames: string, callback?: any, thisArg?: any) {
|
||||
if (!types.isString(eventNames)) {
|
||||
public removeEventListener(eventNames: string, callback?: any, thisArg?: Object) {
|
||||
if (typeof eventNames !== "string") {
|
||||
throw new TypeError("Events name(s) must be string.");
|
||||
}
|
||||
|
||||
var events: Array<string> = eventNames.split(",");
|
||||
if (callback && typeof callback !== "function") {
|
||||
throw new TypeError("callback must be function.");
|
||||
}
|
||||
|
||||
for (var i = 0, l = events.length; i < l; i++) {
|
||||
var event = events[i].trim();
|
||||
const events = eventNames.split(",");
|
||||
for (let i = 0, l = events.length; i < l; i++) {
|
||||
const event = events[i].trim();
|
||||
if (callback) {
|
||||
var list = this._getEventList(event, false);
|
||||
const list = this._getEventList(event, false);
|
||||
if (list) {
|
||||
var index = this._indexOfListener(list, callback, thisArg);
|
||||
const index = this._indexOfListener(list, callback, thisArg);
|
||||
if (index >= 0) {
|
||||
list.splice(index, 1);
|
||||
}
|
||||
@@ -131,54 +109,14 @@ export class Observable implements definition.Observable {
|
||||
}
|
||||
}
|
||||
|
||||
public notifyPropertyChange(propertyName: string, newValue: any) {
|
||||
this.notify(this._createPropertyChangeData(propertyName, newValue));
|
||||
}
|
||||
|
||||
public set(name: string, value: any) {
|
||||
// TODO: Parameter validation
|
||||
if (this[name] === value) {
|
||||
return;
|
||||
}
|
||||
|
||||
// create data for the change
|
||||
var data = this._createPropertyChangeData(name, value);
|
||||
|
||||
this._setCore(data);
|
||||
this.notify(data);
|
||||
|
||||
// TODO: Maybe we need to update source object used in the constructor as well?
|
||||
}
|
||||
|
||||
public get(name: string): any {
|
||||
return this[name];
|
||||
}
|
||||
|
||||
//private disableNotifications = false;
|
||||
private disableNotifications = {};
|
||||
|
||||
public _setCore(data: definition.PropertyChangeData) {
|
||||
this.disableNotifications[data.propertyName] = true;
|
||||
let newValue = WrappedValue.unwrap(data.value);
|
||||
this[data.propertyName] = newValue;
|
||||
delete this.disableNotifications[data.propertyName];
|
||||
}
|
||||
|
||||
public notify<T extends definition.EventData>(data: T) {
|
||||
if (this.disableNotifications[(<any>data).propertyName]) {
|
||||
return;
|
||||
}
|
||||
|
||||
var observers = this._getEventList(data.eventName);
|
||||
public notify<T extends EventData>(data: T) {
|
||||
const observers = this._getEventList(data.eventName);
|
||||
if (!observers) {
|
||||
return;
|
||||
}
|
||||
|
||||
var i;
|
||||
var entry: ListenerEntry;
|
||||
var observersLength = observers.length;
|
||||
for (i = observersLength - 1; i >= 0; i--) {
|
||||
entry = observers[i];
|
||||
for (let i = observers.length - 1; i >= 0; i--) {
|
||||
let entry = observers[i];
|
||||
if (entry.thisArg) {
|
||||
entry.callback.apply(entry.thisArg, [data]);
|
||||
} else {
|
||||
@@ -187,11 +125,15 @@ export class Observable implements definition.Observable {
|
||||
}
|
||||
}
|
||||
|
||||
public notifyPropertyChange(name: string, newValue: any) {
|
||||
this.notify(this._createPropertyChangeData(name, newValue));
|
||||
}
|
||||
|
||||
public hasListeners(eventName: string) {
|
||||
return eventName in this._observers;
|
||||
}
|
||||
|
||||
public _createPropertyChangeData(name: string, value: any): definition.PropertyChangeData {
|
||||
public _createPropertyChangeData(name: string, value: any): PropertyChangeData {
|
||||
return {
|
||||
eventName: Observable.propertyChangeEvent,
|
||||
propertyName: name,
|
||||
@@ -201,10 +143,10 @@ export class Observable implements definition.Observable {
|
||||
}
|
||||
|
||||
public _emit(eventNames: string) {
|
||||
var events: Array<string> = eventNames.split(",");
|
||||
const events = eventNames.split(",");
|
||||
|
||||
for (var i = 0, l = events.length; i < l; i++) {
|
||||
var event = events[i].trim();
|
||||
for (let i = 0, l = events.length; i < l; i++) {
|
||||
const event = events[i].trim();
|
||||
this.notify({ eventName: event, object: this });
|
||||
}
|
||||
}
|
||||
@@ -214,7 +156,7 @@ export class Observable implements definition.Observable {
|
||||
throw new TypeError("EventName must be valid string.");
|
||||
}
|
||||
|
||||
var list = <Array<ListenerEntry>>this._observers[eventName];
|
||||
let list = <Array<ListenerEntry>>this._observers[eventName];
|
||||
if (!list && createIfNeeded) {
|
||||
list = [];
|
||||
this._observers[eventName] = list;
|
||||
@@ -223,12 +165,9 @@ export class Observable implements definition.Observable {
|
||||
return list;
|
||||
}
|
||||
|
||||
private _indexOfListener(list: Array<ListenerEntry>, callback: (data: definition.EventData) => void, thisArg?: any): number {
|
||||
var i;
|
||||
var entry: ListenerEntry;
|
||||
|
||||
for (i = 0; i < list.length; i++) {
|
||||
entry = list[i];
|
||||
private _indexOfListener(list: Array<ListenerEntry>, callback: (data: EventData) => void, thisArg?: any): number {
|
||||
for (let i = 0; i < list.length; i++) {
|
||||
const entry = list[i];
|
||||
if (thisArg) {
|
||||
if (entry.callback === callback && entry.thisArg === thisArg) {
|
||||
return i;
|
||||
@@ -243,36 +182,59 @@ export class Observable implements definition.Observable {
|
||||
|
||||
return -1;
|
||||
}
|
||||
}
|
||||
|
||||
public toString(): string {
|
||||
return this.typeName;
|
||||
class ObservableFromObject extends Observable {
|
||||
public _map: Map<string, Object> = new Map<string, Object>();
|
||||
|
||||
public set(name: string, value: any) {
|
||||
const currentValue = this._map.get(name);
|
||||
if (currentValue === value) {
|
||||
return;
|
||||
}
|
||||
|
||||
const newValue = WrappedValue.unwrap(value);
|
||||
this._map.set(name, newValue);
|
||||
this.notifyPropertyChange(name, newValue);
|
||||
}
|
||||
}
|
||||
|
||||
function addPropertiesFromObject(observable: Observable, source: any, recursive?: boolean) {
|
||||
let isRecursive = recursive || false;
|
||||
observable._map = new Map<string, Object>();
|
||||
function defineNewProperty(target: ObservableFromObject, propertyName: string): void {
|
||||
Object.defineProperty(target, propertyName, {
|
||||
get: function () {
|
||||
return target._map.get(propertyName);
|
||||
},
|
||||
set: function (value) {
|
||||
target.set(propertyName, value);
|
||||
},
|
||||
enumerable: true,
|
||||
configurable: true
|
||||
});
|
||||
}
|
||||
|
||||
function addPropertiesFromObject(observable: ObservableFromObject, source: any, recursive: boolean = false) {
|
||||
let isRecursive = recursive;
|
||||
for (let prop in source) {
|
||||
if (source.hasOwnProperty(prop)) {
|
||||
if (isRecursive) {
|
||||
if (!Array.isArray(source[prop]) && source[prop] && typeof source[prop] === 'object' && types.getClass(source[prop]) !== 'ObservableArray') {
|
||||
if (!Array.isArray(source[prop]) && source[prop] && typeof source[prop] === 'object' && !(source[prop] instanceof Observable)) {
|
||||
source[prop] = fromObjectRecursive(source[prop]);
|
||||
}
|
||||
}
|
||||
observable._defineNewProperty(prop);
|
||||
defineNewProperty(observable, prop);
|
||||
observable.set(prop, source[prop]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export function fromObject(source: any): Observable {
|
||||
let observable = new Observable();
|
||||
let observable = new ObservableFromObject();
|
||||
addPropertiesFromObject(observable, source, false);
|
||||
return observable;
|
||||
}
|
||||
|
||||
export function fromObjectRecursive(source: any): Observable {
|
||||
let observable = new Observable();
|
||||
let observable = new ObservableFromObject();
|
||||
addPropertiesFromObject(observable, source, true);
|
||||
return observable;
|
||||
}
|
||||
Reference in New Issue
Block a user