From 24b483db367291b72170f969de78efcb1a9b95bd Mon Sep 17 00:00:00 2001
From: Valerio Virgillito
Date: Thu, 3 May 2012 22:53:07 -0700
Subject: integrating the latest montage version

Signed-off-by: Valerio Virgillito <valerio@motorola.com>
---
 .../montage/ui/select-input.reel/select-input.js   | 86 ++++++++++++++++++++--
 1 file changed, 80 insertions(+), 6 deletions(-)

(limited to 'node_modules/montage/ui/select-input.reel/select-input.js')

diff --git a/node_modules/montage/ui/select-input.reel/select-input.js b/node_modules/montage/ui/select-input.reel/select-input.js
index 220c3814..10847569 100644
--- a/node_modules/montage/ui/select-input.reel/select-input.js
+++ b/node_modules/montage/ui/select-input.reel/select-input.js
@@ -4,14 +4,28 @@
  (c) Copyright 2011 Motorola Mobility, Inc.  All Rights Reserved.
  </copyright> */
 
+/**
+    @module "montage/ui/select-input.reel"
+    @requires montage/ui/component
+    @requires montage/ui/controller/array-controller
+    @requires montage/ui/native-control
+    @requires montage/ui/composer/press-composer
+*/
+
 var Montage = require("montage").Montage,
     Component = require("ui/component").Component,
     ArrayController = require("ui/controller/array-controller").ArrayController,
     NativeControl = require("ui/native-control").NativeControl,
     PressComposer = require("ui/composer/press-composer").PressComposer;
 
-
-var SelectInput = exports.SelectInput =  Montage.create(NativeControl, {
+/**
+ * Wraps the a &lt;select> element with binding support for the element's standard attributes. Uses an ArrayController instance to manage the element's contents and selection.
+   @class module:"montage/ui/select-input.reel".SelectInput
+   @extends module:montage/native-control.NativeControl
+   @summary
+   If the &lt;select> markup contains <option> is provided in the markup and <code>contentController</code> is not, the <code>contentController</code> collection is populated with the options from the markup. If <code>contentController</code> is present, any options in the markup are overwritten by the values from the <code>contentController</code> when they are available.
+ */
+var SelectInput = exports.SelectInput =  Montage.create(NativeControl, /** @lends module:"montage/ui/select-input.reel".SelectInput */ {
 
     _fromInput: {value: null},
     _synching: {value: null},
@@ -36,6 +50,9 @@ var SelectInput = exports.SelectInput =  Montage.create(NativeControl, {
     //-----------------------
 
     _content: {value: null, enumerable: false},
+/**
+    An array of items to to assign to the component's <code>contentController</code> property, which is an ArrayController.
+*/
     content: {
         set: function(value) {
             if(!Array.isArray(value)) {
@@ -56,15 +73,26 @@ var SelectInput = exports.SelectInput =  Montage.create(NativeControl, {
         }
     },
 
-    // If contentController is provided, this allows the developer to specify
+    // If a <code>contentController</code> is provided, this allows the developer to specify
     // which property in each element provides the "value" part of <option>
+    /**
+        Specifies the property belonging to the component's <code>contentController</code> to use as the "value" part of the <option>.
+    */
     valuePropertyPath: {value: null},
-    // Property on iterated object from which textContent of the <option>
-    // is received
+
+    /**
+        Specifies the property belonging to the component's <code>contentController</code> to use as the text content of the <option>.
+    */
     textPropertyPath: {value: null},
 
 
     _contentController: {value: null, enumerable: false},
+
+/**
+    An ArrayController instance used to manage the content and selection of the select input control.
+    @type {module:montage/ui/controller/array-controller.ArrayController}
+    @default null
+*/
     contentController: {
         get: function() {
             return this._contentController;
@@ -182,6 +210,12 @@ var SelectInput = exports.SelectInput =  Montage.create(NativeControl, {
         //dependencies: ["_selectedIndexes"]
     },
 
+    // HTMLSelectElement methods
+
+    // add() and remove() deliberately omitted. Use the contentController instead
+    blur: { value: function() { this._element.blur(); } },
+    focus: { value: function() { this._element.focus(); } },
+
     // -------------------
     // Montage Callbacks
     // --------------------
@@ -399,13 +433,53 @@ var SelectInput = exports.SelectInput =  Montage.create(NativeControl, {
 
 //http://www.w3.org/TR/html5/the-button-element.html#the-select-element
 
-SelectInput.addAttributes({
+SelectInput.addAttributes( /** @lends module:"montage/ui/select-input.reel".SelectInput */ {
+/**
+    Specifies whether the element should be focused as soon as the page is loaded.
+    @type {boolean}
+    @default false
+*/
         autofocus: {dataType: 'boolean'},
+
+/**
+    When true, the select control is disabled to user input and "disabled" is added to its CSS class list.
+    @type {boolean}
+    @default false
+*/
         disabled: {dataType: 'boolean'},
+
+/**
+    The value of the <code>id</code> attribute of the form with which to associate the component's element.
+    @type string}
+    @default null
+*/
         form: null,
+/**
+    Specifies if multiple selections are enabled on the select element.
+    @type {boolean}
+    @default false
+*/
         multiple: {dataType: 'boolean'},
+
+/**
+    The name associated with the select input element.
+    @type {string}
+    @default null
+*/
         name: null,
+
+/**
+    When true, the user will be required to select a value from the control before submitting the form.
+    @type {string}
+    @default false
+*/
         required: {dataType: 'boolean'},
+
+/**
+   The number of options from the select element to display to the user.
+   @type {number}
+   @default 1
+*/
         size: {dataType: 'number', value: '1'}
 });
 
-- 
cgit v1.2.3