/* Copyright (c) 2012, Motorola Mobility LLC. All Rights Reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of Motorola Mobility LLC nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ /** @module "montage/ui/toggle-button.reel" @requires montage/ui/component @requires "montage/ui/button.reel" */ var Montage = require("montage").Montage, Component = require("ui/component").Component, Button = require("ui/button.reel").Button; /** The ToggleButton component extends the Button component to include state management (pressed or not pressed), and the ability to specify labels and CSS classes for each state. @class module:"montage/ui/toggle-button.reel".ToggleButton @extends module:"montage/ui/button.reel".Button */ var ToggleButton = exports.ToggleButton = Montage.create(Button, /** @lends module:"montage/ui/toggle-button.reel".ToggleButton# */ { hasTemplate: {value: true}, _pressed: { value: false }, /** Gets and sets the ToggleButton's current state, updates the button's label to its pressedLabel or unpressedLabel, and requests a draw. @type {Boolean} @default false */ pressed: { get: function() { return this._pressed; }, set: function(value) { this._pressed = !!value; this._label = (this._pressed) ? this._pressedLabel : this._unpressedLabel; this.needsDraw = true; }, serializable: true }, _unpressedLabel: { value: null }, /** The label to display when the ToggleButton is in its unpressed state. By default, it is set to the value of the value attribute assigned to the input element. @type {String} @default null */ unpressedLabel: { get: function() { return this._unpressedLabel; }, set: function(value) { this._unpressedLabel = value; if (!this._pressed) { this.label = this._unpressedLabel; this.needsDraw = true; } }, serializable: true }, _pressedLabel: { value: null }, /** The value the button should take when it is in the pressed state. By default, it is set to the value of the value attribute assigned to the input element. @type {Property} @default {String} null */ pressedLabel: { get: function() { return this._pressedLabel; }, set: function(value) { this._pressedLabel = value; if (this._pressed) { this.label = this._pressedLabel; this.needsDraw = true; } }, serializable: true }, _pressedClass: { value: "pressed", }, /** The CSS class that should be added to the element's class list when the button is in the pressed state. It is removed when the button is unpressed. @type {string} @default "pressed" */ pressedClass: { get: function() { return this._pressedClass; }, set: function(value) { this._pressedClass = value; if (this._pressed) { this.needsDraw = true; } }, serializable: true }, /** The current value of the button. It is set to the value of unpressedLabel or pressedLabel depending on the ToggleButton's state. Setting this property equal to unpressedLabel or pressedLabel will change the pressed state of the button to `false` or `true`, respectively. @type {string} @default null */ label: { get: function() { return Object.getPropertyDescriptor(Button,"label").get.call(this); }, set: function(value) { // Call super //Object.getOwnPropertyDescriptor(Object.getPrototypeOf(ToggleButton),"label").set.call(this, value); Object.getPropertyDescriptor(Button, "label").set.call(this, value); if (this._pressed === true && this._label === this._unpressedLabel) { this.pressed = false; } else if (this._pressed === false && this._label === this._pressedLabel) { this.pressed = true; } }, serializable: true }, didSetElement: { value: function() { Object.getPrototypeOf(ToggleButton).didSetElement.call(this); // If we haven't set the (un)pressedLabel of the initial state, // then take it from the label if (this._unpressedLabel === null && this._label !== null) { this._unpressedLabel = this._label; } if (this._pressedLabel === null && this._label !== null) { this._pressedLabel = this._label; } } }, draw: { value: function() { Object.getPrototypeOf(ToggleButton).draw.call(this); if (this._pressed) { this._element.classList.add(this._pressedClass); this._element.setAttribute("aria-pressed", true); } else { this._element.classList.remove(this._pressedClass); this._element.setAttribute("aria-pressed", false); } } }, _dispatchActionEvent: { value: function() { this.pressed = !this._pressed; Object.getPrototypeOf(ToggleButton)._dispatchActionEvent.call(this); } }, /** Toggles the state of the button. @function */ toggle: { value: function() { this.pressed = !this._pressed; } } });