Methods

defineProperties(object, properties) <constructor> source

Defines one or more new properties to an object, or modifies existing properties on the object.

Parameters:

Name	Type	Description
object	Object	The object to which the properties are added.
properties	Object	An object that maps names to Montage property descriptors.

See:	Montage.defineProperty

defineProperty(object, name, descriptor) <constructor> source

Defines a property on an object using a Montage property descriptor. Montage property descriptors extend and slightly vary ECMAScript 5 property descriptors.

• value
• get
• set
• enumerable is true by default, but false if value is a function
• writable is true by default, but false if the name begins with an underscore, _.
• configurable is true by default
• distinct is deprecated, but conveys the intention that the value should be duplicated for each instance, but the means of cloning is ill-defined and temperamental.

Parameters:

Name	Type	Description
object	Object	The object on which to define the property.
name	string	The name of the property to define, or modify.
descriptor	Object	A descriptor object that defines the properties being defined or modified.

Example

Montage.defineProperty(Object.prototype, "_eventListenerDescriptors", {
    enumerable: true | false,
    serializable: "reference" | "value" | "auto" | false,
    value: null,
    writable: true | false
});

getInfoForObject(object) → {Object} <constructor> source

Get the metadata Montage has on the given object.

Parameters:

Name	Type	Description
object	Object

Returns: Object

If the object was exported by a module, property is the name it has on the exports object, aliases is an array of all other names if there was more than one, require is the package it comes from, module is the identifier for the module in that package, and isInstance discerns constructors and prototypes from instances.

getPropertyAttribute(anObject, propertyName, attributeName) <constructor> source

Returns the attribute of a property belonging to an object.

Parameters:

Name	Type	Description
anObject	Object	A object.
propertyName	string	The name of a property belonging to anObject.
attributeName	string	The name of a property's attribute.

Returns:

attributes array

getPropertyAttributes(anObject, attributeName) → {Object} <constructor> source

Parameters:

Name	Type	Description
anObject	Object	An object.
attributeName	string	The attribute name.

Returns: Object

TODO getPropertyAttributes returns description

getSerializablePropertyNames(anObject) → {Array} <constructor> source

Returns the names of serializable properties belonging to Montage object.

Parameters:

Name	Type	Description
anObject	Object	A Montage object.

Returns: Array

An array containing the names of the serializable properties belonging to anObject.

specialize(prototypeProperties, constructorProperties) → {function} <constructor> source

Customizes a type with idiomatic JavaScript constructor and prototype inheritance, using ECMAScript 5 property descriptors with customizations for common usage in MontageJS.

See Montage.defineProperty

Parameters:

Name	Type	Argument	Description
prototypeProperties	Object		a object mapping property names to customized Montage property descriptors, to be applied to the new prototype
constructorProperties	Object	<nullable>	a object mapping property names to customized Montage property descriptors, to be applied to the new constructor

Returns: function

a constructor function for the new type, which derrives prototypically from this, with a prototype that inherits this.prototype, with the given property descriptors applied.

super() → {function} <constructor> source

Calls the method with the same name as the caller from the parent of the constructor that contains the caller, falling back to a no-op if no such method exists.

Returns: function

this constructor’s parent constructor.

addBeforeOwnPropertyChangeListener(name, handler) → {function} source

Adds a listener that will be notified before a property changes. See addOwnPropertyChangeListener for details.

Parameters:

Name	Type	Description
name	string
handler	object | function

See:	Montage#addOwnPropertyChangeListener

Returns: function

cancel

addBeforePathChangeListener(path, handlerMethodName) source

Establishes an observer such that the handler will receive a notification when the value of an FRB expression is about to change. See addPathChangeListener for details.

Parameters:

Name	Type	Description
path	string
	object | function
handlerMethodName	string

See:	Montage#addPathChangeListener

addOwnPropertyChangeListener(name, handler, beforeChange) → {function} source

Adds a change listener for the named property of this instance. The handler may be a function or an object with a handler method. When the property changes on this object, the handler will be notified on the stack.

The dispatcher will try to dispatch to only the most specific handler method available, from handle + PropertyName (bactrian camel case) + Change, to handlePropertyChange, or if the beforeChange flag is set, handle + PropertyName + WillChange then handlePropertyWillChange. The arguments to the handler are value, name, and this.

Parameters:

Name	Type	Description
name	string	The name of the property to observe.
handler	object | function	On which to dispatch change notifications.
beforeChange	boolean	Whether to observer changes before they occur. To avoid the boolean trap, try to use addBeforeOwnPropertyChangeListener instead, unless beforeChange is truly variable.

See:	Montage#addBeforeOwnPropertyChangeListener

Returns: function

cancel, useful for removing the change listener without having to retain and reconstruct all of the arguments.

addPathChangeListener(path, handler, handlerMethodName, beforeChange) source

Creates an observer for the value of an FRB expression. The observer will immediately dispatch a notification to the handler of the initial value of the expression, before returning.

If the expression's value is an array, this will be the final notification and all subsequent changes will be reflected by the content of the array. Use addRangeAtPathChangeListener if you want discrete notifications for changes to the content of an expression that evaluates to an array.

Use removePathChangeListener to cancel all involved change listeners.

Parameters:

Name	Type	Description
path	string	an FRB expression.
handler	object | function	an object with a handler method, or a function. The handler will be called with value, path, and this as arguments.
handlerMethodName	string	the method name on the handler on which to dispatch change notifications, if the handler is not a function.
beforeChange	boolean	instructs the path change listener to dispatch before the change has occurred. Avoid using this boolean trap by making use of the named method addBeforePathChangeListener. Using this flag remains desireable only if beforeChange is indeed variable.

addRangeAtPathChangeListener(path, handler, methodName) → {function} source

Observes changes to the content of the value for an FRB expression. The handler will receive “ranged content change” messages. When a change listener is added, the handler will be immediately invoked with the initial content added at index 0 for the expression.

Parameters:

Name	Type	Argument	Description
path	string		an FRB expression that produces content changes
handler			a function that accepts plus, minus, and index arguments, or a handler object with a designated method by that signature. plus and minus are arrays of values that were added or removed. index is the offset at which the minus was removed, then the plus was added.
methodName	string	<nullable>	the name of the method on the handler object that should receive change messages.

Returns: function

cancel function for removing the range at path change listener. Until removeRangeAtPathChangeListener is implemented, this is the only way to disable this kind of observer.

callDelegateMethod(name) source

This method calls the method named with the identifier prefix if it exists. Example: If the name parameter is "shouldDoSomething" and the caller's identifier is "bob", then this method will try and call "bobShouldDoSomething"

Parameters:

Name	Type	Description
name	string

cancelBinding(targetPath) source

Cancels a binding and removes its descriptor from the object's binding descriptor index. This will in turn cause any change listeners needed on far reaching objects for the binding to be canceled. A component should call this if the binding reaches into objects it does not itself own to ensure that they are available for garbage collection.

Parameters:

Name	Type	Description
targetPath	string	The target path used to establish the binding.

cancelBindings() source

Cancels all registered bindings on this object.

defineBinding(targetPath, descriptor) source

Establishes a binding between two FRB expressions. See the FRB documentation for information about FRB paths/expressions. There can only be one binding per target path on an object.

Parameters:

Name	Type	Description
targetPath	string
descriptor	object	A descriptor has at least an arrow property, "<-", "<->". The corresponding string is the sourcePath for the binding and the type of arrow determines whether the binding is one way (from source to target) or if data flows both directions. The descriptor may contain a converter or reverter object, or directly provide convert and revert functions. Converters and reverters have convert and revert methods. The convert function or method transforms data from the source to the target. The revert function or method transforms data from the target to the source and is necessary if there is a converter on a two-way binding. A reverter is the same as a converter, but the polarity is reversed. This is useful for reusing converters that were designed for data flowing the “wrong” way. The descriptor may also provide a trace flag for console debugging.

defineBindings(descriptors, commonDescriptor) source

Establishes multiple bindings.

Parameters:

Name	Type	Argument	Description
descriptors	object		an object for which every property is a source path and every value is a binding descriptor as described by defineBinding.
commonDescriptor	object	<nullable>	a partial binding descriptor with properties intended to be shared by all of the established bindings.

See:	Montage#defineBinding

dispatchBeforeOwnPropertyChange(name, value) source

Manually dispatches a notification that a property is about to change. See dispatchOwnPropertyChange.

Parameters:

Name	Type	Description
name	string
value

See:	Montage#dispatchOwnPropertyChange

dispatchOwnPropertyChange(name, value, beforeChange) source

Manually dispatches a property change notification on this object. This can be useful if the property is a getter or setter and its value changes as a side effect of some other operation, like cache invalidation. It is unnecessary to dispatch a change notification in the setter of a property if it modifies its own value, but if changing celicius has a side effect on fahrenheit, they can manually dispatch changes to the other. Be sure to dispatch both the change and before the change.

Parameters:

Name	Type	Description
name	string
value
beforeChange	boolean	Avoid the boolean trap and use dispatchBeforeOwnPropertyChange. You are not likely to encounter a case where beforeChange is a named variable.

equals(anObject) → {boolean} source

Returns true if two objects are equal, otherwise returns false.

Parameters:

Name	Type	Description
anObject	Object	The object to compare for equality.

Returns: boolean

Returns true if the calling object and anObject are identical and their uuid properties are also equal. Otherwise, returns false.

getBinding(targetPath) → {object} source

Gets the binding descriptor for a target path.

Parameters:

Name	Type	Description
targetPath	string

See:	Montage#defineBinding

Returns: object

the descriptor for the binding. See defineBinding for information on the descriptor type.

getBindings() → {object} source

Gets the binding descriptors for all target paths.

See:	Montage#defineBinding

Returns: object

an object that maps traget paths to binding descriptors. See defineBinding for information on the descriptor type.

getOwnPropertyChangeDescriptor(name) source

Produces the descriptor for a property change listener. The descriptor is an object that will contain two arrays, willChangeListeners and changeListeners. Each listener will be the handler given to establish the change listener on addOwnPropertyChangeListener or addBeforeOwnPropertyChangeListener.

Parameters:

Name	Type	Description
name	string

See:	Montage#addOwnPropertyChangeListener Montage#addBeforeOwnPropertyChangeListener

Returns:

the property change descriptor for this name, created if necessary.

getPath(path) source

Evaluates an FRB expression from this object and returns the value. The evaluator does not establish any change listeners.

Parameters:

Name	Type	Description
path	string	an FRB expression

Returns:

the current value of the expression

getPathChangeDescriptor(path, handler, beforeChange) source

Gets the path change descriptor object for an observer established previously by addPathChangeListener or addBeforePathChangeListener.

Parameters:

Name	Type	Description
path	string	an FRB expression
handler		a function that will receive a value change notification, or an object with a method that will receive the change notifications
beforeChange	boolean

Returns:

a path change descriptor. Such objects have path, handler, beforeChange, and cancel properties. The cancel method is for internal use only. It cancels the observer, but does not perform any book keeping on the index of path change descriptors.

getPathChangeDescriptors() source

Returns an internal index of all of the path change descriptors associated with this instance.

See:	Montage#getPathChangeDescriptor

Returns:

an object that maps property names to an object with two Maps, changeListeners and willChangeListeners. Each of these maps handler objects to path change descriptors. See getPathChangeDescriptor for a description of that type.

hasOwnPropertyChangeDescriptor(name) source

Determines whether a property has ever been observed. Removing all property change listeners does not destroy this record.

Parameters:

Name	Type	Description
name	string

makePropertyObservable(name) source

An overridable method for ensuring that changes to the named property dispatch notifications. The default behavior is to wrap the property with a getter and setter.

Parameters:

Name	Type	Description
name	string

observePath(path, emit) → {function} source

Observes changes to the value of an FRB expression. The content of the emitted value may react to changes, particularly if it is an array.

Parameters:

Name	Type	Description
path	string	an FRB expression
emit	function	a function that receives new values in response to changes. The emitter may return a cancel function if it manages event listeners that must be collected when the value changes.

Returns: function

a canceler function that will remove all involved change listeners, prevent new values from being observed, and prevent previously emitted values from reacting to any further changes.

removeBeforeOwnPropertyChangeListener(name, handler) source

Removes a change listener established by addBeforeOwnPropertyChangeListener or addOwnPropertyChangeListener with the beforeChange flag. Call with the same arguments used to set up the observer.

Parameters:

Name	Type	Description
name	string
handler	object | function

See:	Montage#addOwnPropertyChangeListener Montage#addBeforeOwnPropertyChangeListener

removeBeforePathChangeListener(path, handlerMethodName, beforeChange) source

Removes a path change listener previously established by a call to addBeforePathChangeListener. The given arguments must match the original. See addPathChangeListener for descriptions of their meaning.

Parameters:

Name	Type	Description
path	string
	object | function
handlerMethodName	string
beforeChange	boolean

See:	Montage#addBeforePathChangeListener Montage#addPathChangeListener

removeOwnPropertyChangeListener(name, handler, beforeChange) source

Cancels a change listener established with the same given parameters. For the meanings of the parameters, see addOwnPropertyChangeListener.

Parameters:

Name	Type	Description
name	string
handler	object | function
beforeChange	boolean

See:	Montage#addOwnPropertyChangeListener

removePathChangeListener(path, handlerMethodName, beforeChange) source

Removes a path change listener previously established by a call to addPathChangeListener. The given arguments must match the original. See addPathChangeListener for descriptions of their meaning.

Parameters:

Name	Type	Description
path	string
	object | function
handlerMethodName	string
beforeChange	boolean

See:	Montage#addPathChangeListener

setPath(path, value) source

Assigns a value to the FRB expression from this object. Not all expressions can be assigned to. Property chains will work, but will silently fail if the target object does not exist.

Parameters:

Name	Type	Description
path	string	an FRB expression designating the value to replace
value		the new value

Generated from v0.14.14