Specializes Component

Properties

application :Application source

Convenience to access the application object.

Inherited From:	Component#application

childComponents :Array.<Component> <readonly> source

The child components of the component. This property is readonly and should never be changed.

Inherited From:	Component#childComponents

classList :Set source

The classList of the component's element, the purpose is to mimic the element's API but to also respects the draw cycle.

It can also be bound to by binding each class as a property. example to toggle the complete class:

"classList.has('complete')" : { "<-" : "@owner.isComplete"}

Inherited From:	Component#classList
Default Value:	null

condition :boolean source

The boolean value that specifies if the contents of the condition are visible (true) or hidden (false). null is equivalent to false.

Default Value:	null

delegate :Object source

A delegate is an object that has helper methods specific to particular components. For example, a TextField may consult its deletate's shouldBeginEditing() method, or inform its delegate that it didBeginEditing(). Look for details on the documentation of individual components' delegate properties.

Inherited From:	Component#delegate
Default Value:	null

element :DOMElement source

The element of the component as defined in the template.

{
   "component": {
       "properties": {
           "element": {"#": "dataMontageId"}
       }
   }
}

DOM arguments can be passed to the component as direct children of the element. By default the entire content of the element is considered the single DOM argument of the component. Multiple arguments can be given by assigning a data-arg attribute to each element that represents an argument.

<div data-montage-id="component">
    <h1 data-arg="title"></h1>
    <div data-arg="content">
        <span data-montage-id="text"></span>
    <div>
</div>

If the component has a template then this element is replaced by the element that is referenced in its template just before the component enters the document.

{
   "owner": {
       "properties": {
           "element": {"#": "dataMontageId"}
       }
   }
}

The component element has a component property that points back to the component. This property is specially useful to extrapolate the component tree from the DOM tree. It can also be used for debugging purposes, on the webkit inspector when an element is selected it's possible to find its component by using the $0.component command on the console.

The element of a component can only be assigned once, it's not possible to change it.

Inherited From:	Component#element
Default Value:	null

eventManager :EventManager source

Convenience to access the defaultEventManager object.

Inherited From:	Component#eventManager

getTemplateArgumentElement source

TemplateArgumentProvider implementation

Inherited From:	Component#getTemplateArgumentElement

localizer :Localizer source

The localizer for this component

Inherited From:	Component#localizer
Default Value:	null

needsDraw :boolean source

The purpose of this property is to trigger the adding of the component to the draw list. The draw list consists of all the components that will be drawn on the next draw cycle.

The draw cycle itself is triggered by the requestAnimationFrame API where available, otherwise a shim implemented with setTimeout is used.

When it happens, the draw cycle will call, in succession, and when they exist, the methods: willDraw, draw, and didDraw.

At the end of the draw cycle this property is set back to false.

Inherited From:	Component#needsDraw
Default Value:	false

nextTarget :Target source

The next Target to consider in the event target chain

Currently, components themselves do not allow this chain to be broken; setting a component's nextTarget to a falsy value will cause nextTarget to resolve as the parentComponent.

To interrupt the propagation path a Target that accepts a falsy nextTarget needs to be set at a component's nextTarget.

Inherited From:	Component#nextTarget

ownerComponent :Component source

The owner component is the owner of the template form which this component was instantiated.

Inherited From:	Component#ownerComponent
Default Value:	null

parentComponent :Component source

The parent component is the component that is found by walking up the DOM tree, starting at the component's element. Each component element has a component property that points back to the component object, this way it's possible to know which component an element represents.

This value is null for the RootComponent.

Inherited From:	Component#parentComponent

removalStrategy :string source

The removal strategy specifies how the condition should remove its content when condition is false.

A value of remove will make the condition remove its contents from the DOM.

A value of hide will make the condition hide its contents through CSS using the montage-invisible class while keeping them on the DOM.

Possible values are remove, hide.

Default Value:	"remove"

rootComponent :RootComponent source

Convenience to access the rootComponent object.

Inherited From:	Component#rootComponent

template :Template source

The template object of the component.

Inherited From:	Component#template
Default Value:	null

templateObjects :Object source

This property is populated by the template. It is a map of all the instances present in the template's serialization keyed by their label.

Inherited From:	Component#templateObjects
Default Value:	null

waitForLocalizerMessages :boolean source

Whether to wait for the localizer to load messages before drawing. Make sure to set the localizer before setting to true.

Inherited From:	Component#waitForLocalizerMessages
Default Value:	false

Example

// require localizer
var defaultLocalizer = localizer.defaultLocalizer,
    _ = defaultLocalizer.localizeSync.bind(defaultLocalizer);

exports.Main = Component.specialize( {

    constructor: {
        value: function() {
            this.localizer = defaultLocalizer;
            this.waitForLocalizerMessages = true;
        }
    },

    // ...

    // no draw happens until the localizer's messages have been loaded
    enterDocument: {
        value: function(firstTime) {
            if (firstTime) {
                this._greeting = _("hello", "Hello {name}!");
            }
        }
    },
    draw: {
        value: function() {
            // this is for illustration only. This example is simple enough that
            // you should use a localizations binding
            this._element.textContent = this._greeting({name: this.name});
        }
    }
}

Methods

addComposer(composer) source

Adds the passed in composer to the component's composer list.

Parameters:

Name	Type	Description
composer	Composer

Inherited From:	Component#addComposer

addComposerForElement(composer, element) source

Adds the passed in composer to the component's composer list and sets the element of the composer to the passed in element.

Parameters:

Name	Type	Description
composer	Composer
element	Element

Inherited From:	Component#addComposerForElement

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

Inherited From:	Component#callDelegateMethod

clearAllComposers() source

A convenience method for removing all composers from a component. This method is responsible for calling unload on each composer before removing it.

Inherited From:	Component#clearAllComposers

createActionEvent() source

Convenience to create a custom event named "action"

Inherited From:	Component#createActionEvent

Returns:

and event to dispatch upon interaction

didDraw() source

This method is part of the draw cycle and it provides the component an opportunity to query the DOM for any necessary calculations after drawing. If the execution of this method sets needsDraw to true on other components, those components will be added to the current draw cycle.

Components should not change the DOM during this phase of the draw cycle as it could force an unwanted reflow from the browser.

Inherited From:	Component#didDraw
See:	http://montagejs.org/docs/Component-draw-cycle.html

enterDocument(firstTime) source

This function is called when the component element is added to the document's DOM tree.

Parameters:

Name	Type	Description
firstTime	boolean	true if it's the first time the component enters the document.

Inherited From:	Component#enterDocument

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.

Inherited From:	Component#equals

Returns: boolean

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

exitDocument() source

Lifecycle method called when this component is removed from the document's DOM tree.

Inherited From:	Component#exitDocument

extractDomArgument(name) source

This function extracts a DOM argument that was in the element assigned to the component. The star (*) argument refers to the entire content of the element when no data-arg was given.

When a DOM argument is extracted from a Component it is no longer available

Parameters:

Name	Type	Description
name	string	The name of the argument, or "*" for the entire content.

Inherited From:	Component#extractDomArgument

Returns:

the element

prepareForActivationEvents() source

Called by the EventManager before dispatching a touchstart or mousedown.

The component can implement this method to add event listeners for these events before they are dispatched.

Inherited From:	Component#prepareForActivationEvents

removeComposer(composer) source

Removes the passed in composer from this component's composer list. It takes care of calling the composers unload method before removing it from the list.

Parameters:

Name	Type	Description
composer	Composer

Inherited From:	Component#removeComposer

scheduleComposer(composer) source

Adds the passed in composer to the list of composers which will have their frame method called during the next draw cycle. It causes a draw cycle to be scheduled iff one has not already been scheduled.

Parameters:

Name	Type	Description
composer	Composer

Inherited From:	Component#scheduleComposer

surrenderPointer(pointer, demandingComponent) → {boolean} source

Ask this component to surrender the specified pointer to the demandingComponent.

The component can decide whether or not it should do this given the pointer and demandingComponent involved.

Some components may decide not to surrender control ever, while others may do so in certain situations.

Returns true if the pointer was surrendered, false otherwise.

The demandingComponent is responsible for claiming the surrendered pointer if it desires.

Parameters:

Name	Type	Description
pointer	string	The pointerIdentifier that the demanding component is asking this component to surrender
demandingComponent	Object	The component that is asking this component to surrender the specified pointer

Inherited From:	Component#surrenderPointer

Returns: boolean

true

willDraw() source

This method is part of the draw cycle and it provides the component an opportunity to query the DOM for any necessary calculations before drawing. If the execution of this method sets needsDraw to true on other components, those components will be added to the current draw cycle.

Components should not change the DOM during this phase of the draw cycle as it could force an unwanted reflow from the browser.

Inherited From:	Component#willDraw
See:	http://montagejs.org/docs/Component-draw-cycle.html

Generated from a4679af