-
Notifications
You must be signed in to change notification settings - Fork 55
/
tool-bar-button-view.js
242 lines (208 loc) · 6.27 KB
/
tool-bar-button-view.js
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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
const {CompositeDisposable} = require('atom');
const { ToolBarItem } = require('./tool-bar-item');
/**
* A button class with many options
*
* @property {HTMLElement} element
* @property {number} priority
* @property {string} group
*
* @property {ButtonOptions} options
* @property {boolean} enabled
* @property {CompositeDisposable} subscriptions
*/
class ToolBarButtonView extends ToolBarItem {
/**
*
* @param {ButtonOptions} options
* @param {string} group
*/
constructor (options, group) {
// first calling the super (ToolBarItem) constructor
super({
element: document.createElement('button'),
priority: options.priority
}, group);
this.subscriptions = new CompositeDisposable();
this.options = options;
this.enabled = true;
// default classes
this.classNames = ['btn', 'btn-default', 'tool-bar-btn'];
if (this.priority < 0) {
this.putAtEnd();
}
this.addIcon();
this.addText();
this.addTooltip();
this.setStyle('color', options.color);
this.setStyle('background', options.background);
this.addClasses();
this.addOnMouseDown();
this.addOnClick();
}
destroy () {
this.subscriptions.dispose();
this.element.removeEventListener('mousedown', this._onMouseDown);
this.element.removeEventListener('click', this._onClick);
super.destroy(); // call super.destroy() in the end
}
/** Put the button at the end of the toolbar using 'tool-bar-item-align-end' class. */
putAtEnd () {
this.classNames.push('tool-bar-item-align-end');
}
/** Add an icon for the button using built-in icons. */
addIcon () {
if (!this.options.icon) {
return;
}
if (this.options.iconset) {
if (this.options.iconset.startsWith('fa')) {
this.classNames.push(this.options.iconset, `fa-${this.options.icon}`);
} else {
this.classNames.push(this.options.iconset, `${this.options.iconset}-${this.options.icon}`);
}
} else {
this.classNames.push(`icon-${this.options.icon}`);
}
}
/** Adds a text/html to the button */
addText () {
if (!this.options.text) {
return;
}
if (this.options.html) {
this.element.innerHTML = this.options.text;
} else {
this.element.textContent = this.options.text;
}
}
/**
* adds a Tooltip for your item.
* @param {ButtonOptions.tooltip} tooltipOptions
* @param {ButtonOptions.callback | null} callback
* @returns {Disposable} a disposable tooltip
*/
addTooltip () {
if (!this.options.tooltip) {
return;
}
let tooltip;
if (typeof this.options.tooltip === 'string') {
tooltip = {
title: this.options.tooltip
};
} else {
tooltip = this.options.tooltip;
}
if (!tooltip.hasOwnProperty('placement')) {
tooltip.placement = getTooltipPlacement();
}
if (!tooltip.hasOwnProperty('keyBindingCommand') &&
typeof this.options.callback === 'string'
) {
tooltip.keyBindingCommand = this.options.callback;
}
this.subscriptions.add(atom.tooltips.add(this.element, tooltip));
}
/** Set a style on the button */
setStyle (style, value) {
if (value) {
this.element.style[style] = value;
}
}
/** Add all the classes (custom and others) to the button */
addClasses () {
// add custom classes to the button
if (this.options.class) {
if (Array.isArray(this.options.class)) {
this.classNames.push(...this.options.class);
} else {
this.element.classList.add(this.options.class);
}
}
// add other classes
this.element.classList.add(...this.classNames);
}
setEnabled (enabled) {
this.element.classList.toggle('disabled', !enabled);
this.enabled = enabled;
}
setSelected (selected) {
this.element.classList.toggle('selected', selected);
}
getSelected () {
return this.element.classList.contains('selected');
}
addOnMouseDown () {
this._onMouseDown = this._onMouseDown.bind(this);
this.element.addEventListener('mousedown', this._onMouseDown);
}
_onMouseDown (e) {
// Avoid taking focus so we can dispatch Atom commands with the correct target.
e.preventDefault();
}
addOnClick () {
this._onClick = this._onClick.bind(this);
this.element.addEventListener('click', this._onClick);
}
_onClick (e) {
if (this.element && !this.element.classList.contains('disabled')) {
this.executeCallback(e);
}
if (e.preventDefault) {
e.preventDefault();
e.stopPropagation();
}
}
executeCallback (e) {
let {callback, data} = this.options;
if (typeof callback === 'object' && !Array.isArray(callback) && callback) {
callback = getCallbackModifier(callback, e);
}
const workspaceView = atom.views.getView(atom.workspace);
// Ensure we don't try to dispatch on any target above `atom-workspace`.
const target = workspaceView.contains(document.activeElement)
? document.activeElement
: workspaceView;
if (!Array.isArray(callback)) {
callback = [callback];
}
for (let i = 0; i < callback.length; i++) {
if (typeof callback[i] === 'string') {
atom.commands.dispatch(target, callback[i]);
} else if (typeof callback[i] === 'function') {
callback[i].call(this, data, target);
}
}
}
}
function getCallbackModifier (callback, {altKey, ctrlKey, shiftKey}) {
if (!(ctrlKey || altKey || shiftKey)) {
return callback[''];
}
const modifier = Object.keys(callback)
.filter(Boolean)
.map(modifiers => modifiers.toLowerCase())
.reverse()
.find(item => {
return checkKeyModifier(item.indexOf('alt'), altKey)
&& checkKeyModifier(item.indexOf('ctrl'), ctrlKey)
&& checkKeyModifier(item.indexOf('shift'), shiftKey);
});
return callback[modifier] || callback[''];
}
function checkKeyModifier (keyIndex, key) {
return !((~keyIndex && !key) || (key && !~keyIndex));
}
/** get the tooltip placement based on the toolbar position */
function getTooltipPlacement () {
const tooltipPlacement = {
Top: 'bottom',
Right: 'left',
Bottom: 'top',
Left: 'right'
};
const toolbarPosition = atom.config.get('tool-bar.position');
return tooltipPlacement[toolbarPosition] || null;
}
module.exports.ToolBarButtonView = ToolBarButtonView;