mirror of
https://github.com/NativeScript/NativeScript.git
synced 2025-11-05 13:26:48 +08:00
No more ambient modules for tns-core-modules/* subpackages.
- Use path mappings in tsconfig.json to resolve module typings - Only use ambient mobules for global API's - Move single-file modules to a subdir with the same name so that we can provide a hand-written typing next to it (via package.json) - Delete all mentions of tns-core-modules.d.ts - Delete reference d.ts assembly build steps. Not needed anymore. - HACK! Use a <reference> for global typings in application.d.ts to avoid publishing a separate @types/tns-core-modules package. - Rename declarations.d.ts to tns-core-modules.d.ts to preserve JS project mappings in references.d.ts (the only place we use those)
This commit is contained in:
Hristo Deshev
committed by
Hristo Deshev
Hristo Deshev
parent
1af8c6ca8e
commit
b45cbe929b
291
tns-core-modules/ui/core/dependency-observable/dependency-observable.d.ts
vendored
Normal file
291
tns-core-modules/ui/core/dependency-observable/dependency-observable.d.ts
vendored
Normal file
@@ -0,0 +1,291 @@
|
||||
/**
|
||||
* Contains the DependencyObservable class, which represents an extended Observable object that uses Property instances for value backing mechanism.
|
||||
*/
|
||||
import { Observable, EventData } from "data/observable";
|
||||
|
||||
/**
|
||||
* @deprecated
|
||||
*/
|
||||
export interface NativeValueResult {
|
||||
result: any;
|
||||
cacheable: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* @deprecated use 'ui/core/properties' module instead.
|
||||
*/
|
||||
export class Property {
|
||||
|
||||
/**
|
||||
* Creates a new Property instance.
|
||||
* @param name The name of the property.
|
||||
* @param ownerType The name of class that registers this property.
|
||||
* @param metadata The PropertyMetadata object associated with this property.
|
||||
* @param valueConverter A function that can create an instance of the property type given a string. Used when parsing CSS and XML attribute values which are strings.
|
||||
*/
|
||||
constructor(name: string, ownerType: string, metadata: PropertyMetadata, valueConverter?: (value: string) => any);
|
||||
|
||||
/**
|
||||
* Gets the name of the property. This is a read-only property.
|
||||
*/
|
||||
name: string;
|
||||
|
||||
/**
|
||||
* Gets the id of the property. This is used for fast lookup. This is a read-only property.
|
||||
*/
|
||||
id: number;
|
||||
|
||||
/**
|
||||
* Gets the PropertyMetadata object associated with the property. This is a read-only property.
|
||||
*/
|
||||
metadata: PropertyMetadata;
|
||||
|
||||
/**
|
||||
* Gets the valueConverter function associated with the property. This is a read-only property.
|
||||
*/
|
||||
valueConverter: (value: string) => any
|
||||
|
||||
/**
|
||||
* Gets or sets the defaultValueGetter function used to get the default value for this property.
|
||||
* If default value is 'undefined' and this property is set this function will be used to extract the default value from the native instance.
|
||||
*/
|
||||
defaultValueGetter: (instance: DependencyObservable) => NativeValueResult;
|
||||
|
||||
defaultValue: any;
|
||||
onValueChanged: PropertyChangedCallback;
|
||||
onValidateValue: PropertyValidationCallback;
|
||||
equalityComparer: PropertyEqualityComparer;
|
||||
affectsLayout: boolean;
|
||||
inheritable: boolean;
|
||||
affectsStyle: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* @deprecated use 'ui/core/properties' module instead.
|
||||
*/
|
||||
export class PropertyMetadata {
|
||||
/**
|
||||
* Creates a new PropertyMetadata instance.
|
||||
* @param defaultValue The default value for the property. E.g. 0 for a numeric property.
|
||||
* @param options An optional parameter that specifies how the associated property should be processed by the visual tree. Valid values are one or more bitwise combinations from the PropertyMetadataSettings module.
|
||||
* @param onChanged An optional callback that will be raised whenever the associated property changes for any DependencyObservable instance that uses the property to store a value.
|
||||
* @param onValidateValue An optional callback that will be raised prior to a change of the associated property for any DependencyObservable instance that uses the property.
|
||||
* @param equalityComparer An optional function that used to compare if two property values are equal.
|
||||
*/
|
||||
constructor(
|
||||
defaultValue: any,
|
||||
options?: number,
|
||||
onChanged?: PropertyChangedCallback,
|
||||
onValidateValue?: PropertyValidationCallback,
|
||||
equalityComparer?: PropertyEqualityComparer);
|
||||
|
||||
/**
|
||||
* Gets the options parameter passed to the constructor of this instance. This is a read-only property.
|
||||
*/
|
||||
options: number;
|
||||
/**
|
||||
* Gets the default value parameter passed to the constructor of this instance. This is a read-only property.
|
||||
*/
|
||||
defaultValue: any;
|
||||
/**
|
||||
* Gets or sets the callback to be raised whenever the associated property changes for any DependencyObservable instance that uses the property to store a value.
|
||||
*/
|
||||
onValueChanged: PropertyChangedCallback;
|
||||
/**
|
||||
* Gets or sets the callback to be raised whenever the associated property is about to change for any DependencyObservable instance that uses the property to store a value.
|
||||
*/
|
||||
onValidateValue: PropertyValidationCallback;
|
||||
/**
|
||||
* Gets function that used to compare if two property values are equal.
|
||||
*/
|
||||
equalityComparer: PropertyEqualityComparer;
|
||||
/**
|
||||
* Checks whether the PropertyMetadataSettings.affectsLayout bit is present in the options value.
|
||||
*/
|
||||
affectsLayout: boolean;
|
||||
/**
|
||||
* Checks whether the PropertyMetadataSettings.Inheritable bit is present in the options value.
|
||||
*/
|
||||
inheritable: boolean;
|
||||
/**
|
||||
* Checks whether the PropertyMetadataSettings.AffectsStyle bit is present in the options value.
|
||||
*/
|
||||
affectsStyle: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* @deprecated use 'ui/core/properties' module instead.
|
||||
*/
|
||||
export interface PropertyChangeData extends EventData {
|
||||
/**
|
||||
* The Property associated with the change.
|
||||
*/
|
||||
property: Property;
|
||||
/**
|
||||
* The old property value.
|
||||
*/
|
||||
oldValue: any;
|
||||
/**
|
||||
* The new property value.
|
||||
*/
|
||||
newValue: any;
|
||||
}
|
||||
|
||||
/**
|
||||
* @deprecated use 'ui/core/properties' module instead.
|
||||
*/
|
||||
export interface PropertyChangedCallback {
|
||||
(data: PropertyChangeData): void;
|
||||
}
|
||||
|
||||
/**
|
||||
* @deprecated use 'ui/core/properties' module instead.
|
||||
*/
|
||||
export interface PropertyValidationCallback {
|
||||
(value: any): boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* @deprecated use 'ui/core/properties' module instead.
|
||||
*/
|
||||
export interface PropertyEqualityComparer {
|
||||
(x: any, y: any): boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* @deprecated
|
||||
*/
|
||||
export class PropertyEntry {
|
||||
/**
|
||||
* Resets effective value and all the modifiers available for this entry.
|
||||
*/
|
||||
resetValue(): void;
|
||||
|
||||
/**
|
||||
* Gets the effective value of this entry.
|
||||
* The value is composed depending on the current valueSource value, using the following priority:
|
||||
* 1. VisualState
|
||||
* 2. Local
|
||||
* 3. Css
|
||||
* 4. Inherited
|
||||
* 5. Default
|
||||
*/
|
||||
effectiveValue: any;
|
||||
/**
|
||||
* Gets the source of the current effective value for this entry. The available options for this property are defined in the ValueSource namespace.
|
||||
*/
|
||||
valueSource: number;
|
||||
/**
|
||||
* Gets or sets the local value for this entry. This will trigger re-evaluation of the current effective value.
|
||||
*/
|
||||
localValue: any;
|
||||
/**
|
||||
* Gets or sets the inherited value for this entry. This will trigger re-evaluation of the current effective value.
|
||||
*/
|
||||
inheritedValue: any;
|
||||
/**
|
||||
* Gets or sets the css value for this entry. This will trigger re-evaluation of the current effective value.
|
||||
*/
|
||||
cssValue: any;
|
||||
/**
|
||||
* Gets or sets the visual-state value for this entry. This will trigger re-evaluation of the current effective value.
|
||||
*/
|
||||
visualStateValue: any;
|
||||
}
|
||||
|
||||
/**
|
||||
* @deprecated use 'ui/core/view' as base class.
|
||||
*/
|
||||
export class DependencyObservable extends Observable {
|
||||
// TODO: Do we want to expose the get/setValue methods as public?
|
||||
/**
|
||||
* Gets a value for the property.
|
||||
* @param property - A dependency property to retrieve a value for.
|
||||
*/
|
||||
_getValue(property: Property): any;
|
||||
|
||||
/**
|
||||
* Gets the value source (local, inherited) of a property.
|
||||
* @param property - A dependency property to retrieve a value source for.
|
||||
*/
|
||||
_getValueSource(property: Property): number;
|
||||
|
||||
/**
|
||||
* Sets a value for a property.
|
||||
* @param property - A dependency property to set.
|
||||
* @param value - The new value.
|
||||
* @param source(optional) - The value source (default is local).
|
||||
*/
|
||||
_setValue(property: Property, value: any, source?: number): void;
|
||||
|
||||
/**
|
||||
* Resets a value for a property.
|
||||
* @param - property - A dependency property to reset.
|
||||
* @param source(optional) - The value source (default is local).
|
||||
*/
|
||||
_resetValue(property: Property, source?: number): void;
|
||||
|
||||
/**
|
||||
* Handler for property changed event.
|
||||
* @param property - A dependency property indentifier.
|
||||
* @param oldValue - The old value of the property.
|
||||
* @param newValue - The new value of the property.
|
||||
*/
|
||||
_onPropertyChanged(property: Property, oldValue: any, newValue: any): void;
|
||||
|
||||
/**
|
||||
* Iterates all the properties which have a PropertyEntry registered for this instance.
|
||||
*/
|
||||
_resetValues(valueSource: number): void;
|
||||
_eachSetProperty(callback: (property: Property) => boolean): void;
|
||||
_eachSetPropertyValue(callback: (property: Property, value: any) => void): void;
|
||||
//@endprivate
|
||||
}
|
||||
|
||||
/**
|
||||
* @deprecated use 'ui/core/properties' module instead.
|
||||
*/
|
||||
export module PropertyMetadataSettings {
|
||||
/**
|
||||
* No options are specified. This is the default value.
|
||||
*/
|
||||
export var None: number;
|
||||
/**
|
||||
* A change in the Property associated with the metadata will invalidate the layout.
|
||||
*/
|
||||
export var AffectsLayout;
|
||||
/**
|
||||
* The Property associated with the metadata is inheritable and its value should be propagated down in the visual tree.
|
||||
*/
|
||||
export var Inheritable: number;
|
||||
/**
|
||||
* A change in the Property associated with the metadata will cause all CSS styles to be re-evaluated for for owning element.
|
||||
*/
|
||||
export var AffectsStyle: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* @deprecated
|
||||
*/
|
||||
export module ValueSource {
|
||||
/**
|
||||
* Default value, coming from the PropertyMetadata.defaultValue.
|
||||
*/
|
||||
export var Default: number;
|
||||
/**
|
||||
* Inherited value, coming from the logical parent of the current DependencyObservable instance.
|
||||
*/
|
||||
export var Inherited: number;
|
||||
/**
|
||||
* Css value, coming a css selector and rule that matches the current DependencyObservable instance.
|
||||
*/
|
||||
export var Css: number;
|
||||
/**
|
||||
* Local value, set directly to the current DependencyObservable instance.
|
||||
*/
|
||||
export var Local: number;
|
||||
/**
|
||||
* VisualState value, coming from a visual-state css selector. E.g. { button:pressed }.
|
||||
*/
|
||||
export var VisualState: number;
|
||||
}
|
||||
Reference in New Issue
Block a user