Montage.html

---

layout: api
title: "Montage - MontageJS API"

---

<nav class="sidenav js-api-sidenav">
    <input id="index-search" type="search" placeholder="Search"><details open><summary>Types</summary><ul><li><a href="AbstractButton.html">AbstractButton</a></li><li><a href="AbstractCheckbox.html">AbstractCheckbox</a></li><li><a href="AbstractControl.html">AbstractControl</a></li><li><a href="AbstractImage.html">AbstractImage</a></li><li><a href="AbstractLink.html">AbstractLink</a></li><li><a href="AbstractNumberField.html">AbstractNumberField</a></li><li><a href="AbstractRadioButton.html">AbstractRadioButton</a></li><li><a href="AbstractSelect.html">AbstractSelect</a></li><li><a href="AbstractSlider.html">AbstractSlider</a></li><li><a href="AbstractTextArea.html">AbstractTextArea</a></li><li><a href="AbstractTextField.html">AbstractTextField</a></li><li><a href="AbstractToggleButton.html">AbstractToggleButton</a></li><li><a href="AbstractToggleSwitch.html">AbstractToggleSwitch</a></li><li><a href="AbstractVideo.html">AbstractVideo</a></li><li><a href="ActionEventListener.html">ActionEventListener</a></li><li><a href="Alert.html">Alert</a></li><li><a href="Alias.html">Alias</a></li><li><a href="Application.html">Application</a></li><li><a href="AssociationBlueprint.html">AssociationBlueprint</a></li><li><a href="Binder.html">Binder</a></li><li><a href="BinderManager.html">BinderManager</a></li><li><a href="BitField.html">BitField</a></li><li><a href="Blueprint.html">Blueprint</a></li><li><a href="BytesConverter.html">BytesConverter</a></li><li><a href="Component.html">Component</a></li><li><a href="Composer.html">Composer</a></li><li><a href="Condition.html">Condition</a></li><li><a href="Converter.html">Converter</a></li><li><a href="CubicBezier.html">CubicBezier</a></li><li><a href="CurrencyConverter.html">CurrencyConverter</a></li><li><a href="DateConverter.html">DateConverter</a></li><li><a href="DateValidator.html">DateValidator</a></li><li><a href="DefaultLocalizer.html">DefaultLocalizer</a></li><li><a href="DerivedPropertyBlueprint.html">DerivedPropertyBlueprint</a></li><li><a href="ElementReference.html">ElementReference</a></li><li><a href="Enum.html">Enum</a></li><li><a href="EventBlueprint.html">EventBlueprint</a></li><li><a href="EventManager.html">EventManager</a></li><li><a href="Exception.html">Exception</a></li><li><a href="Flow.html">Flow</a></li><li><a href="FlowTranslateComposer.html">FlowTranslateComposer</a></li><li><a href="Gate.html">Gate</a></li><li><a href="InvertConverter.html">InvertConverter</a></li><li><a href="Iteration.html">Iteration</a></li><li><a href="KeyComposer.html">KeyComposer</a></li><li><a href="KeyManager.html">KeyManager</a></li><li><a href="Loader.html">Loader</a></li><li><a href="Localizer.html">Localizer</a></li><li><a href="Logger.html">Logger</a></li><li><a href="LowerCaseConverter.html">LowerCaseConverter</a></li><li><a href="MediaController.html">MediaController</a></li><li><a href="MessageFormat.html">MessageFormat</a></li><li><a href="MessageLocalizer.html">MessageLocalizer</a></li><li><a href="ModalOverlay.html">ModalOverlay</a></li><li><a href="ModuleBlueprint.html">ModuleBlueprint</a></li><li><a href="ModuleReference.html">ModuleReference</a></li><li><a href="Montage.html">Montage</a></li><li><a href="MontageBuilder.html">MontageBuilder</a></li><li><a href="MontageReviver.html">MontageReviver</a></li><li><a href="MontageWindow.html">MontageWindow</a></li><li><a href="MutableEvent.html">MutableEvent</a></li><li><a href="NewLineToBrConverter.html">NewLineToBrConverter</a></li><li><a href="NumberConverter.html">NumberConverter</a></li><li><a href="NumberValidator.html">NumberValidator</a></li><li><a href="ObjectController.html">ObjectController</a></li><li><a href="ObjectProperty.html">ObjectProperty</a></li><li><a href="Overlay.html">Overlay</a></li><li><a href="Point_.html">Point</a></li><li><a href="PressComposer.html">PressComposer</a></li><li><a href="PressEvent.html">PressEvent</a></li><li><a href="PromiseController.html">PromiseController</a></li><li><a href="PropertyBlueprint.html">PropertyBlueprint</a></li><li><a href="PropertyValidationRule.html">PropertyValidationRule</a></li><li><a href="PropertyValidationSemantics.html">PropertyValidationSemantics</a></li><li><a href="RadioButtonController.html">RadioButtonController</a></li><li><a href="RangeController.html">RangeController</a></li><li><a href="Repetition.html">Repetition</a></li><li><a href="RootComponent.html">RootComponent</a></li><li><a href="Serialization.html">Serialization</a></li><li><a href="SerializationExtractor.html">SerializationExtractor</a></li><li><a href="SerializationInspector.html">SerializationInspector</a></li><li><a href="SerializationMerger.html">SerializationMerger</a></li><li><a href="Slot.html">Slot</a></li><li><a href="State.html">State</a></li><li><a href="StateChart.html">StateChart</a></li><li><a href="Substitution.html">Substitution</a></li><li><a href="SwipeComposer.html">SwipeComposer</a></li><li><a href="Target.html">Target</a></li><li><a href="Template.html">Template</a></li><li><a href="TemplateResources.html">TemplateResources</a></li><li><a href="Text.html">Text</a></li><li><a href="TranslateComposer.html">TranslateComposer</a></li><li><a href="TreeController.html">TreeController</a></li><li><a href="TreeControllerNode.html">TreeControllerNode</a></li><li><a href="TrimConverter.html">TrimConverter</a></li><li><a href="UpperCaseConverter.html">UpperCaseConverter</a></li><li><a href="Uuid_.html">Uuid</a></li><li><a href="Validator.html">Validator</a></li></ul></details><details><summary>Externals</summary><ul><li><a href="external-Array.html">Array</a></li><li><a href="external-Function.html">Function</a></li><li><a href="external-Object.html">Object</a></li><li><a href="external-RegExp.html">RegExp</a></li><li><a href="external-String.html">String</a></li></ul></details><details><summary>Events</summary><ul><li><a href="AbstractButton.html#event:action">action</a></li><li><a href="AbstractButton.html#event:longAction">longAction</a></li><li><a href="AbstractButton.html#event:longpress">longpress</a></li><li><a href="AbstractCheckbox.html#event:action">action</a></li><li><a href="AbstractLink.html#event:action">action</a></li><li><a href="AbstractRadioButton.html#event:action">action</a></li><li><a href="AbstractSelect.html#event:action">action</a></li><li><a href="AbstractTextField.html#event:action">action</a></li><li><a href="AbstractToggleButton.html#event:action">action</a></li><li><a href="AbstractToggleButton.html#event:longAction">longAction</a></li><li><a href="AbstractToggleSwitch.html#event:action">action</a></li><li><a href="Overlay.html#event:dismiss">dismiss</a></li><li><a href="PressComposer.html#event:longPress">longPress</a></li><li><a href="PressComposer.html#event:press">press</a></li><li><a href="PressComposer.html#event:pressCancel">pressCancel</a></li><li><a href="PressComposer.html#event:pressStart">pressStart</a></li><li><a href="UndoManager.html#event:operationRegistered">operationRegistered</a></li><li><a href="UndoManager.html#event:redo">redo</a></li><li><a href="UndoManager.html#event:undo">undo</a></li></ul></details><details><summary>Global</summary><ul><li><a href="global.html#determinate">determinate</a></li><li><a href="global.html#error">error</a></li><li><a href="global.html#fulfilled">fulfilled</a></li><li><a href="global.html#ok">ok</a></li><li><a href="global.html#pending">pending</a></li><li><a href="global.html#progress">progress</a></li><li><a href="global.html#progressState">progressState</a></li><li><a href="global.html#promise">promise</a></li><li><a href="global.html#rejected">rejected</a></li><li><a href="global.html#state">state</a></li><li><a href="global.html#">undefined</a></li><li><a href="global.html#value">value</a></li></ul></details>
</nav>

<div class="main">
    <article class="content">




<header>
    <h2>

        Montage


            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L41">source</a></span>

    </h2>

        <div class="class-description"><p>The basis of all types using the MontageJS framework.</p></div>

</header>

<article>

    <div class="container-overview">




<dt>



</dt>
<dd>


    <div class="description markdown-body">
        <p>The Montage constructor provides conveniences for sub-typing
(<a href="Montage.html#specialize">specialize</a>) and common methods for Montage
prototype chains.</p>
    </div>












<table class="details">





















</table>









</dd>


    </div>












        <h3 class="subsection-title">Methods</h3>

        <dl>

<dt>

    <h4 class="name" id="defineProperties">
        defineProperties<span class="signature">(object, properties)</span><span class="type-signature"></span> <span class="type-signature">&lt;constructor> </span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L558">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>Defines one or more new properties to an object, or modifies existing
properties on the object.</p>
    </div>







        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>





		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>object</code></td>


            <td class="type">


<span class="param-type">Object</span>



            </td>





            <td class="description last"><p>The object to which the properties are added.</p></td>
        </tr>



        <tr>

                <td class="name"><code>properties</code></td>


            <td class="type">


<span class="param-type">Object</span>



            </td>





            <td class="description last"><p>An object that maps names to Montage property
descriptors.</p></td>
        </tr>


	</tbody>
</table>







<table class="details">



















	<tr>
	    <th class="details-header tag-see">See:</th>
	    <td class="details-content tag-see">
	        <ul>
	            <li><a href="Montage.html#defineProperty">Montage.defineProperty</a></li>
	        </ul>
	    </td>
	</tr>



</table>









</dd>



<dt>

    <h4 class="name" id="defineProperty">
        defineProperty<span class="signature">(object, name, descriptor)</span><span class="type-signature"></span> <span class="type-signature">&lt;constructor> </span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L269">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>Defines a property on an object using a Montage property descriptor.
Montage property descriptors extend and slightly vary ECMAScript 5 property
descriptors.</p>
<ul>
<li><code>value</code></li>
<li><code>get</code></li>
<li><code>set</code></li>
<li><code>enumerable</code> is <code>true</code> by default, but <code>false</code> if <code>value</code> is a function</li>
<li><code>writable</code> is <code>true</code> by default, but <code>false</code> if the <code>name</code> begins with
an underscore, <code>_</code>.</li>
<li><code>configurable</code> is <code>true</code> by default</li>
<li><code>distinct</code> is deprecated, but conveys the intention that the <code>value</code>
should be duplicated for each instance, but the means of cloning is
ill-defined and temperamental.</li>
</ul>
    </div>







        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>





		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>object</code></td>


            <td class="type">


<span class="param-type">Object</span>



            </td>





            <td class="description last"><p>The object on which to define the property.</p></td>
        </tr>



        <tr>

                <td class="name"><code>name</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>





            <td class="description last"><p>The name of the property to define, or modify.</p></td>
        </tr>



        <tr>

                <td class="name"><code>descriptor</code></td>


            <td class="type">


<span class="param-type">Object</span>



            </td>





            <td class="description last"><p>A descriptor object that defines the properties
being defined or modified.</p></td>
        </tr>


	</tbody>
</table>







<table class="details">





















</table>









        <h5>Example</h5>

    <pre class="prettyprint"><code>Montage.defineProperty(Object.prototype, "_eventListenerDescriptors", {
    enumerable: true | false,
    serializable: "reference" | "value" | "auto" | false,
    value: null,
    writable: true | false
});</code></pre>


</dd>



<dt>

    <h4 class="name" id="getInfoForObject">
        getInfoForObject<span class="signature">(object)</span><span class="type-signature"> &rarr; {Object}</span> <span class="type-signature">&lt;constructor> </span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L913">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>Get the metadata Montage has on the given object.</p>
    </div>







        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>





		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>object</code></td>


            <td class="type">


<span class="param-type">Object</span>



            </td>





            <td class="description last"></td>
        </tr>


	</tbody>
</table>







<table class="details">





















</table>








            <h5>
                Returns:

                    <span class="return-type">
<span class="param-type">Object</span>

</span>

            </h5>

                <div class="param-desc">
                    <p>If the object was exported by a module, <code>property</code> is the
name it has on the exports object, <code>aliases</code> is an array of all other names
if there was more than one, <code>require</code> is the package it comes from, <code>module</code>
is the identifier for the module in that package, and <code>isInstance</code> discerns
constructors and prototypes from instances.</p>
                </div>





</dd>



<dt>

    <h4 class="name" id="getPropertyAttribute">
        getPropertyAttribute<span class="signature">(anObject, propertyName, attributeName)</span><span class="type-signature"></span> <span class="type-signature">&lt;constructor> </span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L863">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>Returns the attribute of a property belonging to an object.</p>
    </div>







        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>





		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>anObject</code></td>


            <td class="type">


<span class="param-type">Object</span>



            </td>





            <td class="description last"><p>A object.</p></td>
        </tr>



        <tr>

                <td class="name"><code>propertyName</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>





            <td class="description last"><p>The name of a property belonging to
    <code>anObject</code>.</p></td>
        </tr>



        <tr>

                <td class="name"><code>attributeName</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>





            <td class="description last"><p>The name of a property's attribute.</p></td>
        </tr>


	</tbody>
</table>







<table class="details">





















</table>








            <h5>
                Returns:

            </h5>

                <div class="param-desc">
                    <p>attributes array</p>
                </div>





</dd>



<dt>

    <h4 class="name" id="getPropertyAttributes">
        getPropertyAttributes<span class="signature">(anObject, attributeName)</span><span class="type-signature"> &rarr; {Object}</span> <span class="type-signature">&lt;constructor> </span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L882">source</a></span>

    </h4>



</dt>
<dd>








        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>





		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>anObject</code></td>


            <td class="type">


<span class="param-type">Object</span>



            </td>





            <td class="description last"><p>An object.</p></td>
        </tr>



        <tr>

                <td class="name"><code>attributeName</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>





            <td class="description last"><p>The attribute name.</p></td>
        </tr>


	</tbody>
</table>







<table class="details">





















</table>








            <h5>
                Returns:

                    <span class="return-type">
<span class="param-type">Object</span>

</span>

            </h5>

                <div class="param-desc">
                    <p>TODO getPropertyAttributes returns description</p>
                </div>





</dd>



<dt>

    <h4 class="name" id="getSerializablePropertyNames">
        getSerializablePropertyNames<span class="signature">(anObject)</span><span class="type-signature"> &rarr; {Array}</span> <span class="type-signature">&lt;constructor> </span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L840">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>Returns the names of serializable properties belonging to Montage object.</p>
    </div>







        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>





		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>anObject</code></td>


            <td class="type">


<span class="param-type">Object</span>



            </td>





            <td class="description last"><p>A Montage object.</p></td>
        </tr>


	</tbody>
</table>







<table class="details">





















</table>








            <h5>
                Returns:

                    <span class="return-type">
<span class="param-type">Array</span>

</span>

            </h5>

                <div class="param-desc">
                    <p>An array containing the names of the serializable
properties belonging to <code>anObject</code>.</p>
                </div>





</dd>



<dt>

    <h4 class="name" id="specialize">
        specialize<span class="signature">(prototypeProperties, constructorProperties)</span><span class="type-signature"> &rarr; {function}</span> <span class="type-signature">&lt;constructor> </span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L60">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>Customizes a type with idiomatic JavaScript constructor and prototype
inheritance, using ECMAScript 5 property descriptors with customizations
for common usage in MontageJS.</p>
<p>See <a href="Montage.html#defineProperty">Montage.defineProperty</a></p>
    </div>







        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>


		<th>Argument</th>




		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>prototypeProperties</code></td>


            <td class="type">


<span class="param-type">Object</span>



            </td>


                <td class="attributes">



                </td>




            <td class="description last"><p>a object mapping property names to
customized Montage property descriptors, to be applied to the new
prototype</p></td>
        </tr>



        <tr>

                <td class="name"><code>constructorProperties</code></td>


            <td class="type">


<span class="param-type">Object</span>



            </td>


                <td class="attributes">



                    &lt;nullable&gt;<br>

                </td>




            <td class="description last"><p>a object mapping property names to
customized Montage property descriptors, to be applied to the new
constructor</p></td>
        </tr>


	</tbody>
</table>







<table class="details">





















</table>








            <h5>
                Returns:

                    <span class="return-type">
<span class="param-type">function</span>

</span>

            </h5>

                <div class="param-desc">
                    <p>a constructor function for the new type, which
derrives prototypically from <code>this</code>, with a prototype that inherits
<code>this.prototype</code>, with the given property descriptors applied.</p>
                </div>





</dd>



<dt>

    <h4 class="name" id="super">
        super<span class="signature">()</span><span class="type-signature"> &rarr; {function}</span> <span class="type-signature">&lt;constructor> </span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L778">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>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.</p>
    </div>












<table class="details">





















</table>








            <h5>
                Returns:

                    <span class="return-type">
<span class="param-type">function</span>

</span>

            </h5>

                <div class="param-desc">
                    <p>this constructor’s parent constructor.</p>
                </div>





</dd>



<dt>

    <h4 class="name" id="addBeforeOwnPropertyChangeListener">
        addBeforeOwnPropertyChangeListener<span class="signature">(name, handler)</span><span class="type-signature"> &rarr; {function}</span> <span class="type-signature"></span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L1125">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>Adds a listener that will be notified <em>before</em> a property changes.  See
<code>addOwnPropertyChangeListener</code> for details.</p>
    </div>







        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>





		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>name</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>





            <td class="description last"></td>
        </tr>



        <tr>

                <td class="name"><code>handler</code></td>


            <td class="type">


<span class="param-type">object</span>
|

<span class="param-type">function</span>



            </td>





            <td class="description last"></td>
        </tr>


	</tbody>
</table>







<table class="details">



















	<tr>
	    <th class="details-header tag-see">See:</th>
	    <td class="details-content tag-see">
	        <ul>
	            <li><a href="Montage.html#addOwnPropertyChangeListener">Montage#addOwnPropertyChangeListener</a></li>
	        </ul>
	    </td>
	</tr>



</table>








            <h5>
                Returns:

                    <span class="return-type">
<span class="param-type">function</span>

</span>

            </h5>

                <div class="param-desc">
                    <p>cancel</p>
                </div>





</dd>



<dt>

    <h4 class="name" id="addBeforePathChangeListener">
        addBeforePathChangeListener<span class="signature">(path, handlerMethodName)</span><span class="type-signature"></span> <span class="type-signature"></span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L1653">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>Establishes an observer such that the handler will receive a
notification when the value of an FRB expression is about to change.
See <code>addPathChangeListener</code> for details.</p>
    </div>







        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>





		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>path</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>





            <td class="description last"></td>
        </tr>



        <tr>

                <td class="name"><code></code></td>


            <td class="type">


<span class="param-type">object</span>
|

<span class="param-type">function</span>



            </td>





            <td class="description last"></td>
        </tr>



        <tr>

                <td class="name"><code>handlerMethodName</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>





            <td class="description last"></td>
        </tr>


	</tbody>
</table>







<table class="details">



















	<tr>
	    <th class="details-header tag-see">See:</th>
	    <td class="details-content tag-see">
	        <ul>
	            <li><a href="Montage.html#addPathChangeListener">Montage#addPathChangeListener</a></li>
	        </ul>
	    </td>
	</tr>



</table>









</dd>



<dt>

    <h4 class="name" id="addOwnPropertyChangeListener">
        addOwnPropertyChangeListener<span class="signature">(name, handler, beforeChange)</span><span class="type-signature"> &rarr; {function}</span> <span class="type-signature"></span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L1121">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>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 <em>on the stack</em>.</p>
<p>The dispatcher will try to dispatch to <em>only</em> the most specific handler
method available, from <code>handle</code> + PropertyName (bactrian camel case) +
<code>Change</code>, to <code>handlePropertyChange</code>, or if the <code>beforeChange</code> flag is set,
<code>handle</code> + PropertyName + <code>WillChange</code> then <code>handlePropertyWillChange</code>.  The
arguments to the handler are <code>value</code>, <code>name</code>, and this.</p>
    </div>







        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>





		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>name</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>





            <td class="description last"><p>The name of the property to observe.</p></td>
        </tr>



        <tr>

                <td class="name"><code>handler</code></td>


            <td class="type">


<span class="param-type">object</span>
|

<span class="param-type">function</span>



            </td>





            <td class="description last"><p>On which to dispatch change notifications.</p></td>
        </tr>



        <tr>

                <td class="name"><code>beforeChange</code></td>


            <td class="type">


<span class="param-type">boolean</span>



            </td>





            <td class="description last"><p>Whether to observer changes before they occur.
To avoid the boolean trap, try to use <code>addBeforeOwnPropertyChangeListener</code>
instead, unless <code>beforeChange</code> is truly variable.</p></td>
        </tr>


	</tbody>
</table>







<table class="details">



















	<tr>
	    <th class="details-header tag-see">See:</th>
	    <td class="details-content tag-see">
	        <ul>
	            <li><a href="Montage.html#addBeforeOwnPropertyChangeListener">Montage#addBeforeOwnPropertyChangeListener</a></li>
	        </ul>
	    </td>
	</tr>



</table>








            <h5>
                Returns:

                    <span class="return-type">
<span class="param-type">function</span>

</span>

            </h5>

                <div class="param-desc">
                    <p><code>cancel</code>, useful for removing the change listener
without having to retain and reconstruct all of the arguments.</p>
                </div>





</dd>



<dt>

    <h4 class="name" id="addPathChangeListener">
        addPathChangeListener<span class="signature">(path, handler, handlerMethodName, beforeChange)</span><span class="type-signature"></span> <span class="type-signature"></span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L1528">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>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.</p>
<p>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 <code>addRangeAtPathChangeListener</code> if you want discrete
notifications for changes to the content of an expression that evaluates
to an array.</p>
<p>Use <code>removePathChangeListener</code> to cancel all involved change listeners.</p>
    </div>







        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>





		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>path</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>





            <td class="description last"><p>an FRB expression.</p></td>
        </tr>



        <tr>

                <td class="name"><code>handler</code></td>


            <td class="type">


<span class="param-type">object</span>
|

<span class="param-type">function</span>



            </td>





            <td class="description last"><p>an object with a handler method, or a
function. The handler will be called with <code>value</code>, <code>path</code>, and this as
arguments.</p></td>
        </tr>



        <tr>

                <td class="name"><code>handlerMethodName</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>





            <td class="description last"><p>the method name on the handler on
which to dispatch change notifications, if the handler is not a
function.</p></td>
        </tr>



        <tr>

                <td class="name"><code>beforeChange</code></td>


            <td class="type">


<span class="param-type">boolean</span>



            </td>





            <td class="description last"><p>instructs the path change listener to
dispatch before the change has occurred. Avoid using this boolean trap
by making use of the named method <code>addBeforePathChangeListener</code>. Using
this flag remains desireable only if <code>beforeChange</code> is indeed variable.</p></td>
        </tr>


	</tbody>
</table>







<table class="details">





















</table>









</dd>



<dt>

    <h4 class="name" id="addRangeAtPathChangeListener">
        addRangeAtPathChangeListener<span class="signature">(path, handler, methodName)</span><span class="type-signature"> &rarr; {function}</span> <span class="type-signature"></span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L1417">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>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.</p>
    </div>







        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>


		<th>Argument</th>




		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>path</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>


                <td class="attributes">



                </td>




            <td class="description last"><p>an FRB expression that produces content changes</p></td>
        </tr>



        <tr>

                <td class="name"><code>handler</code></td>


            <td class="type">

            </td>


                <td class="attributes">



                </td>




            <td class="description last"><p>a function that accepts <code>plus</code>, <code>minus</code>, and <code>index</code>
arguments, or a handler object with a designated method by that
signature.  <code>plus</code> and <code>minus</code> are arrays of values that were added
or removed.  <code>index</code> is the offset at which the <code>minus</code> was removed,
then the <code>plus</code> was added.</p></td>
        </tr>



        <tr>

                <td class="name"><code>methodName</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>


                <td class="attributes">



                    &lt;nullable&gt;<br>

                </td>




            <td class="description last"><p>the name of the method on the handler object
that should receive change messages.</p></td>
        </tr>


	</tbody>
</table>







<table class="details">





















</table>








            <h5>
                Returns:

                    <span class="return-type">
<span class="param-type">function</span>

</span>

            </h5>

                <div class="param-desc">
                    <p>cancel function for removing the range at path
change listener. Until <code>removeRangeAtPathChangeListener</code> is implemented,
this is the only way to disable this kind of observer.</p>
                </div>





</dd>



<dt>

    <h4 class="name" id="callDelegateMethod">
        callDelegateMethod<span class="signature">(name)</span><span class="type-signature"></span> <span class="type-signature"></span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L1088">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>This method calls the method named with the identifier prefix if it exists.
Example: If the name parameter is &quot;shouldDoSomething&quot; and the caller's identifier is &quot;bob&quot;, then
this method will try and call &quot;bobShouldDoSomething&quot;</p>
    </div>







        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>





		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>name</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>





            <td class="description last"></td>
        </tr>


	</tbody>
</table>







<table class="details">





















</table>









</dd>



<dt>

    <h4 class="name" id="cancelBinding">
        cancelBinding<span class="signature">(targetPath)</span><span class="type-signature"></span> <span class="type-signature"></span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L1279">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>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.</p>
    </div>







        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>





		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>targetPath</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>





            <td class="description last"><p>The target path used to establish the
binding.</p></td>
        </tr>


	</tbody>
</table>







<table class="details">





















</table>









</dd>



<dt>

    <h4 class="name" id="cancelBindings">
        cancelBindings<span class="signature">()</span><span class="type-signature"></span> <span class="type-signature"></span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L1295">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>Cancels all registered bindings on this object.</p>
    </div>












<table class="details">





















</table>









</dd>



<dt>

    <h4 class="name" id="defineBinding">
        defineBinding<span class="signature">(targetPath, descriptor)</span><span class="type-signature"></span> <span class="type-signature"></span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L1233">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>Establishes a binding between two FRB expressions.  See the
<a href="http://documentup.com/montagejs/frb/">FRB</a> documentation for
information about FRB paths/expressions. There can only be one binding
per target path on an object.</p>
    </div>







        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>





		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>targetPath</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>





            <td class="description last"></td>
        </tr>



        <tr>

                <td class="name"><code>descriptor</code></td>


            <td class="type">


<span class="param-type">object</span>



            </td>





            <td class="description last"><p>A descriptor has at least an arrow property,
<code>&quot;&lt;-&quot;</code>, <code>&quot;&lt;-&gt;&quot;</code>. The corresponding string is the <code>sourcePath</code> 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
<code>descriptor</code> may contain a <code>converter</code> or <code>reverter</code> object, or directly
provide <code>convert</code> and <code>revert</code> functions. Converters and reverters have
<code>convert</code> and <code>revert</code> methods.  The <code>convert</code> function or method
transforms data from the source to the target. The <code>revert</code> 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 <code>reverter</code> is the same as a
<code>converter</code>, but the polarity is reversed. This is useful for reusing
converters that were designed for data flowing the “wrong” way.  The
<code>descriptor</code> may also provide a <code>trace</code> flag for console debugging.</p></td>
        </tr>


	</tbody>
</table>







<table class="details">





















</table>









</dd>



<dt>

    <h4 class="name" id="defineBindings">
        defineBindings<span class="signature">(descriptors, commonDescriptor)</span><span class="type-signature"></span> <span class="type-signature"></span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L1263">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>Establishes multiple bindings.</p>
    </div>







        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>


		<th>Argument</th>




		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>descriptors</code></td>


            <td class="type">


<span class="param-type">object</span>



            </td>


                <td class="attributes">



                </td>




            <td class="description last"><p>an object for which every property is a
source path and every value is a binding descriptor as described by
<code>defineBinding</code>.</p></td>
        </tr>



        <tr>

                <td class="name"><code>commonDescriptor</code></td>


            <td class="type">


<span class="param-type">object</span>



            </td>


                <td class="attributes">



                    &lt;nullable&gt;<br>

                </td>




            <td class="description last"><p>a partial binding descriptor with
properties intended to be shared by all of the established bindings.</p></td>
        </tr>


	</tbody>
</table>







<table class="details">



















	<tr>
	    <th class="details-header tag-see">See:</th>
	    <td class="details-content tag-see">
	        <ul>
	            <li><a href="Montage.html#defineBinding">Montage#defineBinding</a></li>
	        </ul>
	    </td>
	</tr>



</table>









</dd>



<dt>

    <h4 class="name" id="dispatchBeforeOwnPropertyChange">
        dispatchBeforeOwnPropertyChange<span class="signature">(name, value)</span><span class="type-signature"></span> <span class="type-signature"></span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L1133">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>Manually dispatches a notification that a property is about to change.
See <code>dispatchOwnPropertyChange</code>.</p>
    </div>







        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>





		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>name</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>





            <td class="description last"></td>
        </tr>



        <tr>

                <td class="name"><code>value</code></td>


            <td class="type">

            </td>





            <td class="description last"></td>
        </tr>


	</tbody>
</table>







<table class="details">



















	<tr>
	    <th class="details-header tag-see">See:</th>
	    <td class="details-content tag-see">
	        <ul>
	            <li><a href="Montage.html#dispatchOwnPropertyChange">Montage#dispatchOwnPropertyChange</a></li>
	        </ul>
	    </td>
	</tr>



</table>









</dd>



<dt>

    <h4 class="name" id="dispatchOwnPropertyChange">
        dispatchOwnPropertyChange<span class="signature">(name, value, beforeChange)</span><span class="type-signature"></span> <span class="type-signature"></span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L1131">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>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 <code>celicius</code> has a side effect on
<code>fahrenheit</code>, they can manually dispatch changes to the other. Be sure
to dispatch both the change and before the change.</p>
    </div>







        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>





		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>name</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>





            <td class="description last"></td>
        </tr>



        <tr>

                <td class="name"><code>value</code></td>


            <td class="type">

            </td>





            <td class="description last"></td>
        </tr>



        <tr>

                <td class="name"><code>beforeChange</code></td>


            <td class="type">


<span class="param-type">boolean</span>



            </td>





            <td class="description last"><p>Avoid the boolean trap and use
<code>dispatchBeforeOwnPropertyChange</code>. You are not likely to encounter a case
where <code>beforeChange</code> is a named variable.</p></td>
        </tr>


	</tbody>
</table>







<table class="details">





















</table>









</dd>



<dt>

    <h4 class="name" id="equals">
        equals<span class="signature">(anObject)</span><span class="type-signature"> &rarr; {boolean}</span> <span class="type-signature"></span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L1069">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>Returns true if two objects are equal, otherwise returns false.</p>
    </div>







        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>





		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>anObject</code></td>


            <td class="type">


<span class="param-type">Object</span>



            </td>





            <td class="description last"><p>The object to compare for equality.</p></td>
        </tr>


	</tbody>
</table>







<table class="details">





















</table>








            <h5>
                Returns:

                    <span class="return-type">
<span class="param-type">boolean</span>

</span>

            </h5>

                <div class="param-desc">
                    <p>Returns <code>true</code> if the calling object and
<code>anObject</code> are identical and their <code>uuid</code> properties
are also equal. Otherwise, returns <code>false</code>.</p>
                </div>





</dd>



<dt>

    <h4 class="name" id="getBinding">
        getBinding<span class="signature">(targetPath)</span><span class="type-signature"> &rarr; {object}</span> <span class="type-signature"></span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L1305">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>Gets the binding descriptor for a target path.</p>
    </div>







        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>





		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>targetPath</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>





            <td class="description last"></td>
        </tr>


	</tbody>
</table>







<table class="details">



















	<tr>
	    <th class="details-header tag-see">See:</th>
	    <td class="details-content tag-see">
	        <ul>
	            <li><a href="Montage.html#defineBinding">Montage#defineBinding</a></li>
	        </ul>
	    </td>
	</tr>



</table>








            <h5>
                Returns:

                    <span class="return-type">
<span class="param-type">object</span>

</span>

            </h5>

                <div class="param-desc">
                    <p>the descriptor for the binding. See <code>defineBinding</code>
for information on the descriptor type.</p>
                </div>





</dd>



<dt>

    <h4 class="name" id="getBindings">
        getBindings<span class="signature">()</span><span class="type-signature"> &rarr; {object}</span> <span class="type-signature"></span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L1319">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>Gets the binding descriptors for all target paths.</p>
    </div>












<table class="details">



















	<tr>
	    <th class="details-header tag-see">See:</th>
	    <td class="details-content tag-see">
	        <ul>
	            <li><a href="Montage.html#defineBinding">Montage#defineBinding</a></li>
	        </ul>
	    </td>
	</tr>



</table>








            <h5>
                Returns:

                    <span class="return-type">
<span class="param-type">object</span>

</span>

            </h5>

                <div class="param-desc">
                    <p>an object that maps traget paths to binding
descriptors.
See <code>defineBinding</code> for information on the descriptor type.</p>
                </div>





</dd>



<dt>

    <h4 class="name" id="getOwnPropertyChangeDescriptor">
        getOwnPropertyChangeDescriptor<span class="signature">(name)</span><span class="type-signature"></span> <span class="type-signature"></span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L1129">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>Produces the descriptor for a property change listener. The descriptor is an
object that will contain two arrays, <code>willChangeListeners</code> and
<code>changeListeners</code>. Each listener will be the <code>handler</code> given to establish
the change listener on <code>addOwnPropertyChangeListener</code> or
<code>addBeforeOwnPropertyChangeListener</code>.</p>
    </div>







        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>





		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>name</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>





            <td class="description last"></td>
        </tr>


	</tbody>
</table>







<table class="details">



















	<tr>
	    <th class="details-header tag-see">See:</th>
	    <td class="details-content tag-see">
	        <ul>
	            <li><a href="Montage.html#addOwnPropertyChangeListener">Montage#addOwnPropertyChangeListener</a></li>

	            <li><a href="Montage.html#addBeforeOwnPropertyChangeListener">Montage#addBeforeOwnPropertyChangeListener</a></li>
	        </ul>
	    </td>
	</tr>



</table>








            <h5>
                Returns:

            </h5>

                <div class="param-desc">
                    <p>the property change descriptor for this name, created if necessary.</p>
                </div>





</dd>



<dt>

    <h4 class="name" id="getPath">
        getPath<span class="signature">(path)</span><span class="type-signature"></span> <span class="type-signature"></span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L1357">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>Evaluates an FRB expression from this object and returns the value.
The evaluator does not establish any change listeners.</p>
    </div>







        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>





		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>path</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>





            <td class="description last"><p>an FRB expression</p></td>
        </tr>


	</tbody>
</table>







<table class="details">





















</table>








            <h5>
                Returns:

            </h5>

                <div class="param-desc">
                    <p>the current value of the expression</p>
                </div>





</dd>



<dt>

    <h4 class="name" id="getPathChangeDescriptor">
        getPathChangeDescriptor<span class="signature">(path, handler, beforeChange)</span><span class="type-signature"></span> <span class="type-signature"></span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L1485">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>Gets the path change descriptor object for an observer established
previously by <code>addPathChangeListener</code> or <code>addBeforePathChangeListener</code>.</p>
    </div>







        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>





		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>path</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>





            <td class="description last"><p>an FRB expression</p></td>
        </tr>



        <tr>

                <td class="name"><code>handler</code></td>


            <td class="type">

            </td>





            <td class="description last"><p>a function that will receive a value change notification,
or an object with a method that will receive the change notifications</p></td>
        </tr>



        <tr>

                <td class="name"><code>beforeChange</code></td>


            <td class="type">


<span class="param-type">boolean</span>



            </td>





            <td class="description last"></td>
        </tr>


	</tbody>
</table>







<table class="details">





















</table>








            <h5>
                Returns:

            </h5>

                <div class="param-desc">
                    <p>a path change descriptor. Such objects have <code>path</code>, <code>handler</code>,
<code>beforeChange</code>, and <code>cancel</code> properties. The <code>cancel</code> method is for
internal use only. It cancels the observer, but does not perform any
book keeping on the index of path change descriptors.</p>
                </div>





</dd>



<dt>

    <h4 class="name" id="getPathChangeDescriptors">
        getPathChangeDescriptors<span class="signature">()</span><span class="type-signature"></span> <span class="type-signature"></span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L1466">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>Returns an internal index of all of the path change descriptors
associated with this instance.</p>
    </div>












<table class="details">



















	<tr>
	    <th class="details-header tag-see">See:</th>
	    <td class="details-content tag-see">
	        <ul>
	            <li><a href="Montage.html#getPathChangeDescriptor">Montage#getPathChangeDescriptor</a></li>
	        </ul>
	    </td>
	</tr>



</table>








            <h5>
                Returns:

            </h5>

                <div class="param-desc">
                    <p>an object that maps property names to an object with two
Maps, <code>changeListeners</code> and <code>willChangeListeners</code>. Each of these
maps handler objects to path change descriptors. See
<code>getPathChangeDescriptor</code> for a description of that type.</p>
                </div>





</dd>



<dt>

    <h4 class="name" id="hasOwnPropertyChangeDescriptor">
        hasOwnPropertyChangeDescriptor<span class="signature">(name)</span><span class="type-signature"></span> <span class="type-signature"></span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L1137">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>Determines whether a property has ever been observed. Removing all property
change listeners does not destroy this record.</p>
    </div>







        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>





		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>name</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>





            <td class="description last"></td>
        </tr>


	</tbody>
</table>







<table class="details">





















</table>









</dd>



<dt>

    <h4 class="name" id="makePropertyObservable">
        makePropertyObservable<span class="signature">(name)</span><span class="type-signature"></span> <span class="type-signature"></span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L1135">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>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.</p>
    </div>







        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>





		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>name</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>





            <td class="description last"></td>
        </tr>


	</tbody>
</table>







<table class="details">





















</table>









</dd>



<dt>

    <h4 class="name" id="observePath">
        observePath<span class="signature">(path, emit)</span><span class="type-signature"> &rarr; {function}</span> <span class="type-signature"></span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L1397">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>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.</p>
    </div>







        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>





		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>path</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>





            <td class="description last"><p>an FRB expression</p></td>
        </tr>



        <tr>

                <td class="name"><code>emit</code></td>


            <td class="type">


<span class="param-type">function</span>



            </td>





            <td class="description last"><p>a function that receives new values in response
to changes.  The emitter may return a <code>cancel</code> function if it manages
event listeners that must be collected when the value changes.</p></td>
        </tr>


	</tbody>
</table>







<table class="details">





















</table>








            <h5>
                Returns:

                    <span class="return-type">
<span class="param-type">function</span>

</span>

            </h5>

                <div class="param-desc">
                    <p>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.</p>
                </div>





</dd>



<dt>

    <h4 class="name" id="removeBeforeOwnPropertyChangeListener">
        removeBeforeOwnPropertyChangeListener<span class="signature">(name, handler)</span><span class="type-signature"></span> <span class="type-signature"></span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L1127">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>Removes a change listener established by <code>addBeforeOwnPropertyChangeListener</code>
or <code>addOwnPropertyChangeListener</code> with the <code>beforeChange</code> flag.
Call with the same arguments used to set up the observer.</p>
    </div>







        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>





		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>name</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>





            <td class="description last"></td>
        </tr>



        <tr>

                <td class="name"><code>handler</code></td>


            <td class="type">


<span class="param-type">object</span>
|

<span class="param-type">function</span>



            </td>





            <td class="description last"></td>
        </tr>


	</tbody>
</table>







<table class="details">



















	<tr>
	    <th class="details-header tag-see">See:</th>
	    <td class="details-content tag-see">
	        <ul>
	            <li><a href="Montage.html#addOwnPropertyChangeListener">Montage#addOwnPropertyChangeListener</a></li>

	            <li><a href="Montage.html#addBeforeOwnPropertyChangeListener">Montage#addBeforeOwnPropertyChangeListener</a></li>
	        </ul>
	    </td>
	</tr>



</table>









</dd>



<dt>

    <h4 class="name" id="removeBeforePathChangeListener">
        removeBeforePathChangeListener<span class="signature">(path, handlerMethodName, beforeChange)</span><span class="type-signature"></span> <span class="type-signature"></span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L1669">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>Removes a path change listener previously established by a call to
<code>addBeforePathChangeListener</code>. The given arguments must match the
original. See <code>addPathChangeListener</code> for descriptions of their meaning.</p>
    </div>







        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>





		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>path</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>





            <td class="description last"></td>
        </tr>



        <tr>

                <td class="name"><code></code></td>


            <td class="type">


<span class="param-type">object</span>
|

<span class="param-type">function</span>



            </td>





            <td class="description last"></td>
        </tr>



        <tr>

                <td class="name"><code>handlerMethodName</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>





            <td class="description last"></td>
        </tr>



        <tr>

                <td class="name"><code>beforeChange</code></td>


            <td class="type">


<span class="param-type">boolean</span>



            </td>





            <td class="description last"></td>
        </tr>


	</tbody>
</table>







<table class="details">



















	<tr>
	    <th class="details-header tag-see">See:</th>
	    <td class="details-content tag-see">
	        <ul>
	            <li><a href="Montage.html#addBeforePathChangeListener">Montage#addBeforePathChangeListener</a></li>

	            <li><a href="Montage.html#addPathChangeListener">Montage#addPathChangeListener</a></li>
	        </ul>
	    </td>
	</tr>



</table>









</dd>



<dt>

    <h4 class="name" id="removeOwnPropertyChangeListener">
        removeOwnPropertyChangeListener<span class="signature">(name, handler, beforeChange)</span><span class="type-signature"></span> <span class="type-signature"></span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L1123">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>Cancels a change listener established with the same given parameters.  For
the meanings of the parameters, see <code>addOwnPropertyChangeListener</code>.</p>
    </div>







        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>





		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>name</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>





            <td class="description last"></td>
        </tr>



        <tr>

                <td class="name"><code>handler</code></td>


            <td class="type">


<span class="param-type">object</span>
|

<span class="param-type">function</span>



            </td>





            <td class="description last"></td>
        </tr>



        <tr>

                <td class="name"><code>beforeChange</code></td>


            <td class="type">


<span class="param-type">boolean</span>



            </td>





            <td class="description last"></td>
        </tr>


	</tbody>
</table>







<table class="details">



















	<tr>
	    <th class="details-header tag-see">See:</th>
	    <td class="details-content tag-see">
	        <ul>
	            <li><a href="Montage.html#addOwnPropertyChangeListener">Montage#addOwnPropertyChangeListener</a></li>
	        </ul>
	    </td>
	</tr>



</table>









</dd>



<dt>

    <h4 class="name" id="removePathChangeListener">
        removePathChangeListener<span class="signature">(path, handlerMethodName, beforeChange)</span><span class="type-signature"></span> <span class="type-signature"></span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L1611">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>Removes a path change listener previously established by a call to
<code>addPathChangeListener</code>. The given arguments must match the original.
See <code>addPathChangeListener</code> for descriptions of their meaning.</p>
    </div>







        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>





		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>path</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>





            <td class="description last"></td>
        </tr>



        <tr>

                <td class="name"><code></code></td>


            <td class="type">


<span class="param-type">object</span>
|

<span class="param-type">function</span>



            </td>





            <td class="description last"></td>
        </tr>



        <tr>

                <td class="name"><code>handlerMethodName</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>





            <td class="description last"></td>
        </tr>



        <tr>

                <td class="name"><code>beforeChange</code></td>


            <td class="type">


<span class="param-type">boolean</span>



            </td>





            <td class="description last"></td>
        </tr>


	</tbody>
</table>







<table class="details">



















	<tr>
	    <th class="details-header tag-see">See:</th>
	    <td class="details-content tag-see">
	        <ul>
	            <li><a href="Montage.html#addPathChangeListener">Montage#addPathChangeListener</a></li>
	        </ul>
	    </td>
	</tr>



</table>









</dd>



<dt>

    <h4 class="name" id="setPath">
        setPath<span class="signature">(path, value)</span><span class="type-signature"></span> <span class="type-signature"></span>

            <span class="source"><a href="https://github.com/montagejs/montage/blob/v0.14.14/core/core.js#L1376">source</a></span>

    </h4>



</dt>
<dd>


    <div class="description markdown-body">
        <p>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.</p>
    </div>







        <h5>Parameters:</h5>


<table class="params">
    <thead>
	<tr>

		<th>Name</th>


		<th>Type</th>





		<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


        <tr>

                <td class="name"><code>path</code></td>


            <td class="type">


<span class="param-type">string</span>



            </td>





            <td class="description last"><p>an FRB expression designating the value to replace</p></td>
        </tr>



        <tr>

                <td class="name"><code>value</code></td>


            <td class="type">

            </td>





            <td class="description last"><p>the new value</p></td>
        </tr>


	</tbody>
</table>







<table class="details">





















</table>









</dd>

        </dl>






    <p class="generated-from">Generated from <a href="https://github.com/montagejs/montage/tree/v0.14.14">v0.14.14</a></p>
</article>





    </article>

</div>

<script>
(function() {
    var codeBlocks = document.querySelectorAll("code[class|='lang']");

    // Add "prettyprint" class name to each code block that defines a lang
    // because it is needed for prettify to find the block.
    for (var i = 0, block; block = codeBlocks[i]; i++) {
        block.className += " prettyprint";
    }

    window.prettyPrint();
})();
</script>