1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
/* <copyright>
This file contains proprietary software owned by Motorola Mobility, Inc.<br/>
No rights, expressed or implied, whatsoever to this software are provided by Motorola Mobility, Inc. hereunder.<br/>
(c) Copyright 2011 Motorola Mobility, Inc. All Rights Reserved.
</copyright> */
/**
@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").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: {
enumerable: false,
value: false
},
/**
Gets and sets the ToggleButton's current state, updates the button's label to its <code>pressedLabel</code> or <code>unpressedLabel</code>, 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;
}
},
_unpressedLabel: {
enumerable: false,
value: null,
serializable: true
},
/**
The label to display when the ToggleButton is in its unpressed state. By default, it is set to the value of the <code>value</code> 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;
}
}
},
_pressedLabel: {
enumerable: false,
value: null,
serializable: true
},
/**
The value the button should take when it is in the pressed state. By default, it is set to the value of the <code>value</code> 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;
}
}
},
_pressedClass: {
enumerable: false,
value: "pressed",
serializable: true
},
/**
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;
}
}
},
/**
The current value of the button. It is set to the value of <code>unpressedLabel</code> or
<code>pressedLabel</code> depending on the ToggleButton's state.
Setting this property equal to <code>unpressedLabel</code> or <code>pressedLabel</code> will change the <code>pressed</code> 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;
}
}
},
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;
}
}
});
|