/*
This file contains proprietary software owned by Motorola Mobility, Inc.
No rights, expressed or implied, whatsoever to this software are provided by Motorola Mobility, Inc. hereunder.
(c) Copyright 2011 Motorola Mobility, Inc. All Rights Reserved.
*/
/**
@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/button.reel".Button
*/
var ToggleButton = exports.ToggleButton = Montage.create(Button, /** @lends module:"montage/ui/toggle-button.reel".ToggleButton# */ {
_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.getOwnPropertyDescriptor(Object.getPrototypeOf(ToggleButton),"label").get.call(this);
},
set: function(value) {
// Call super
Object.getOwnPropertyDescriptor(Object.getPrototypeOf(ToggleButton),"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;
}
}
});