import ModelProperty from 'f.lux/src/collection/ModelProperty.js'

public class | source

ModelProperty

Extends:

Property → ObjectProperty → ModelProperty

Static Method Summary

Static Public Methods
public static	modelDefinitionFor(state: , collection: ): {"id": , "cid": , "data": , "dirty": , "lastReqId": , "waiting": }

Constructor Summary

Public Constructor
public	constructor(stateType: *)

Member Summary

Public Members
public	[_busy]: *
public get	cid: *
public get	collection: *
public get	data: *
public get	id: *

Method Summary

Public Methods
public	changeId(id: *)
public	clearCheckpoint()
public	clearDirty()
public	create$(impl: ):
public	defaults(data: *)
public	destroy(): *
public	isDirty(): *
public	isNew(): *
public	isWaiting(): *
public	merge(data: *)
public	propertyChildInvalidated(childProperty: *)
public	resetDataToCheckpoint()
public	save(): *
public	setBusy(busy: *)
public	setData(data: *)

Inherited Summary

From class Property
public	[_ImplementationClass]: *
public	[_ShadowClass]: *
public	[_autoShadow]: *
public	[_checkpoint]: {"data": *}
public	[_impl]: *
public	[_initialState]: *
public	[_mixins]: *[]
public	[_parent]: *
public	[_pid]: *
public	[_readonly]: *
public	[_shader]: *
public	[_stateType]: *
public	[_store]: *
public	$$(): Property Use this.$$() in shadow methods to get access to the property.
public	autoShadow(): boolean Gets if autoshadowing is enabled for this property.
public	checkpoint() Copies the current actual state for later reset using Property#resetToCheckpoint.
public	clearCheckpoint() Clears an existing checkpoint created using Property#checkpoint.
public	create$(impl: *): Access Creates the object to be assigned to the shadow.$ property.
public	dotPath(): string Gets the path from root property using a dot (`.`) separator.
public	getCheckpoint(): * Gets the checkpoint state previously recorded using Property#checkpoint.
public	getInitialState(state: ): Gets the initial state for a property at the beginning of the property mounting process.
public	hasCheckpoint(): boolean Gets if an existing checkpoint has be created using Property#checkpoint.
public	initialState(): * Gets the result from StateType#computeInitialState.
public	isActive(): boolean Gets if the property is currently shadowing an actual state property.
public	isIsolated(): boolean Gets if property is an actual isolated property managed by the store.
public	isReadonly(): boolean Gets if the property allows for assignment through the shadow state, ie `todo.desc = "go skiing"`.
public	isRoot(): boolean Gets if this is the shadow state root property.
public	name(): string \| number The property name by which this property is referenced by the Property.parent.
public	nextState(): * Gets what the actual state for this property will be after the Store updates all pending actions.
public	owner(): Property Gets the object containing or managing this property.
public	parent(): Property Gets the parent property.
public	parentShadow(): Shadow Gets the parent's shadow property.
public	path(): [] Gets the Property#name components from the root property to this property.
public	pid(): number Gets the unique f.lux ID for this property.
public	propertyChildInvalidated(childProperty: Property, sourceProperty: Property) A child property or one of its descendents wil be changing state.
public	propertyDidShadow() Invoked by the f.lux shadowing process after a property initially shadows a state property.
public	propertyDidUpdate() Invoked by the f.lux shadowing process after a property is reshadowed.
public	propertyWillShadow() Invoked by the f.lux shadowing process just before a property initially shadows a state property.
public	propertyWillUnshadow() Invoked by the f.lux shadowing process just before a property will be removed from the shadow state.
public	resetToCheckpoint() Replaces the current property state with a checkpoint state previously recorded using Property#checkpoint.
public	root(): Property Gets the shadow state root property for the Store managing this property.
public	rootShadow(): Shadow Gets the root shadow state for the Store managing this property.
public	setAutoshadow(auto: boolean): * Sets the auto shadow property flag.
public	setImplementationClass(ImplClass: *)
public	setInitialState(state: *): Property Explicitly sets an initial state that will be used if the state tree does not have a value for this property.
public	setReadonly(readonly: *) Sets the readonly flag which will prevent an assignment from changing the value.
public	setShadowClass(ShadowClass: Shadow) Sets the class to be used for the shadow api
public	shader(state: ): Gets the Shader instance for this property.
public	shadowClass(): * Returns the Shadow subclass used to virtualize the state property.
public	slashPath(): string Gets the path from root property using a slash (`/`) separator.
public	state(): * Gets the actual state being shadowed.
public	stateType(): * Gets the StateType used for creating this property.
public	store(): * Gets the {@Link Store} containing the application state.
public	touch() Triggers a reshadow of the properties shadow state.
public	typeName(): * Gets this property's StateType.typeName value.
public	update(callback: function) Makes changes to the next proeprty state.

From class ObjectProperty
public static	createClass(shadowType: Object \| Shadow, typeCallback: function(type: StateType), initialState: Object): ObjectProperty Factory function for creating an `ObjectProperty` subclass.
public static	defineType(PropClass: ObjectProperty, ShadowType: Object \| Shadow, typeCallback: function(type: StateType), initialState: Object) Factory function for setting up the StateType `type` class variable with an appropriately configured intial state.

Static Public Methods

public static modelDefinitionFor(state: , collection: ): {"id": , "cid": , "data": , "dirty": , "lastReqId": , "waiting": } source

Params:

Name	Type	Attribute	Description
state	*
collection	*

Return:

{"id": *, "cid": *, "data": *, "dirty": *, "lastReqId": *, "waiting": *}

Public Constructors

public constructor(stateType: *) source

If a StateType is not passed to this constructor then one is located using StateType.from thus ensuring the f.lux shadowing process is defined for this property.

Override:

ObjectProperty#constructor

Params:

Name	Type	Attribute	Description
stateType	*	optional

Public Members

public [_busy]: * source

public get cid: * source

public get collection: * source

public get data: * source

public get id: * source

Public Methods

public changeId(id: *) source

Params:

Name	Type	Attribute	Description
id	*

Decorators:

shadow

public clearCheckpoint() source

Clears an existing checkpoint created using Property#checkpoint.

Override:

Property#clearCheckpoint

public clearDirty() source

public create$(impl: ): source

Creates the object to be assigned to the shadow.$ property. Subclasses can override this method to setup a chain of specialized accessors ($()). See Access for details on setting up specialized accessors. This is an advanced feature and rarely required.

Override:

Property#create$

Params:

Name	Type	Attribute	Description
impl	*

Return:

public defaults(data: *) source

Params:

Name	Type	Attribute	Description
data	*

Decorators:

shadowBound

public destroy(): * source

Return:

Decorators:

shadowBound

public isDirty(): * source

Return:

public isNew(): * source

Return:

Decorators:

shadowBound

public isWaiting(): * source

Return:

Decorators:

shadowBound

public merge(data: *) source

Params:

Name	Type	Attribute	Description
data	*

Decorators:

shadowBound

public propertyChildInvalidated(childProperty: *) source

A child property or one of its descendents wil be changing state. Useful hook when a property needs to perform some bookkeepng for child properties. Utilizing this hook provides a chance to make tracking changes in shadow properties before the store updates its state.

Subclasses do not need to invoke the parent implementation.

Override:

Property#propertyChildInvalidated

Params:

Name	Type	Attribute	Description
childProperty	*

public resetDataToCheckpoint() source

public save(): * source

Return:

Decorators:

shadowBound

public setBusy(busy: *) source

Params:

Name	Type	Attribute	Description
busy	*

public setData(data: *) source

Params:

Name	Type	Attribute	Description
data	*

Decorators:

shadowBound

ModelProperty

Extends:

Static Method Summary

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Static Public Methods

public static modelDefinitionFor(state: *, collection: *): {"id": *, "cid": *, "data": *, "dirty": *, "lastReqId": *, "waiting": *} source

Params:

Return:

Public Constructors

public constructor(stateType: *) source

Override:

Params:

Public Members

public [_busy]: * source

public get cid: * source

public get collection: * source

public get data: * source

public get id: * source

Public Methods

public changeId(id: *) source

Params:

Decorators:

public clearCheckpoint() source

Override:

public clearDirty() source

public create$(impl: *): * source

Override:

Params:

Return:

public defaults(data: *) source

Params:

Decorators:

public destroy(): * source

Return:

Decorators:

public isDirty(): * source

Return:

public isNew(): * source

Return:

Decorators:

public isWaiting(): * source

Return:

Decorators:

public merge(data: *) source

Params:

Decorators:

public propertyChildInvalidated(childProperty: *) source

Override:

Params:

public resetDataToCheckpoint() source

public save(): * source

Return:

Decorators:

public setBusy(busy: *) source

Params:

public setData(data: *) source

Params:

Decorators:

public static modelDefinitionFor(state: , collection: ): {"id": , "cid": , "data": , "dirty": , "lastReqId": , "waiting": } source

public create$(impl: ): source