-
Notifications
You must be signed in to change notification settings - Fork 24
/
collage-editor.js
365 lines (323 loc) · 10.1 KB
/
collage-editor.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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
H5PEditor.Collage = (function ($, contentId, Collage) {
/**
* Collage Editor widget.
*
* @class H5P.CollageEditor
* @param {Object} parent
* @param {Object} field
* @param {Object} params
* @param {function} setValue
*/
function CollageEditor(parent, field, params, setValue) {
var self = this;
// In case the editor is loaded before the Collage.
Collage = H5P.Collage;
// Get field options from semantics
var layoutField = findField('template', field.fields);
var optionsField = findField('options', field.fields);
var heightField = findField('heightRatio', optionsField.fields);
var spacingField = findField('spacing', optionsField.fields);
var frameField = findField('frame', optionsField.fields);
// Set params if none is given
if (params === undefined) {
params = {};
setValue(field, params);
}
// Pass ready callbacks if the editor isn't ready yet
var readyCallbacks = [];
var passreadyCallbacks = true;
parent.ready(function () {
passreadyCallbacks = false;
});
// Editor wrapper
var $wrapper = $('<div/>', {
'class': 'h5p-collage-editor-wrapper'
});
// Create the collage for live preview
var collage = new Collage({collage: params}, contentId);
var layoutSelector;
// Handle clips being added to the collage.
collage.on('clipAdded', function (event) {
var clip = event.data;
// Extend clip
CollageEditor.Clip.call(clip, layoutSelector);
// attach the settings dialog
clip.on('show-dialog', function (event) {
var $dialog = event.data;
if ($dialog.parent().length === 0) {
$wrapper.find('.h5p-collage-wrapper').append($dialog);
}
});
// attach metadata dialog
clip.on('show-metadata-dialog', (event) => {
const $metadataDialog = event.data;
if ($metadataDialog.parent().length === 0) {
$wrapper.find('.h5p-collage-wrapper').append($metadataDialog);
}
});
});
H5P.$window.on('resize', function () {
collage.trigger('resize');
});
/**
* Converts em value to a more human value.
*
* @private
* @param {number} value
* @returns {number}
*/
var humanInt = function (value) {
return parseInt(value * 10);
};
/**
* Make sure number appears with two decimals.
*
* @private
* @param {number} value
* @returns {string}
*/
var humanFloat = function (value) {
value = value.toString();
var dot = value.indexOf('.');
if (dot === -1) {
value += '.00';
}
else if (value[dot + 2] === undefined) {
value += '0';
}
return value;
};
/**
* Inserts a number range selector.
*
* @private
* @param {object} field Appearence
* @param {string} field.name
* @param {string} field.label
* @param {number} field.min
* @param {number} field.max
* @param {function} change Callback when new value is selected
* @param {number} step
* @param {function} humanize Post processing of value
* @returns {H5P.jQuery} Wrapper of the element
*/
var rangeSelector = function (field, change, step, humanize) {
const rangeId = H5PEditor.getNextFieldId(field);
var $itemWrapper = getItemWrapper(field.name, field.label, rangeId);
var $inner = $('<div/>', {
'class': 'h5p-collage-inner-wrapper',
appendTo: $itemWrapper
});
var last = humanize(params.options[field.name]);
$('<input/>', {
'class': 'h5p-collage-range-input',
id: rangeId,
type: 'range',
min: field.min,
max: field.max,
step: (field.max - field.min) / step,
value: params.options[field.name],
on: {
change: function () {
params.options[field.name] = this.value;
last = humanize(this.value);
$value.html(last);
change(this.value);
},
input: function () {
$value.html(humanize(this.value));
}
},
appendTo: $inner
});
var $value = $('<div/>', {
'class': 'h5p-collage-selector-preview',
html: last,
appendTo: $inner
});
return $itemWrapper;
};
/**
* Will align all the fields by setting the same height.
*
* @private
* @param {Array} fields List of H5P.jQuery objects
*/
var sameHeight = function (fields) {
var targetHeight = 0;
var i;
for (i = 0; i < fields.length; i++) {
var fieldHeight = parseFloat(window.getComputedStyle(fields[i][0]).height);
if (fieldHeight > targetHeight) {
targetHeight = fieldHeight;
}
}
if (!targetHeight) {
return; // Skip giving all the fields no height
}
targetHeight += 'px';
for (i = 0; i < fields.length; i++) {
fields[i].css('height', targetHeight);
}
};
/**
* Make sure all the clips cover their containers.
*
* @private
*/
var fitClips = function () {
for (var i = 0; i < collage.clips.length; i++) {
if (!collage.clips[i].empty()) {
collage.clips[i].fit();
}
}
};
/**
* Appends the collage editor widget
*
* @param {H5P.jQuery} $container
*/
this.appendTo = function ($container) {
// Add tiling layout selector
var $layoutSelectorWrapper = getItemWrapper(layoutField.name, layoutField.label);
layoutSelector = new CollageEditor.LayoutSelector($layoutSelectorWrapper, layoutField.options, params.template);
layoutSelector.on('layoutChanged', function (event) {
params.template = event.data;
params.clips = [];
collage.setLayout(params.template);
});
// Attach Collage preview
var $collageWrapper = getItemWrapper(field.name, field.label);
var $preview = $('<div/>', {
'class': 'h5p-collage-preview',
appendTo: $collageWrapper
});
collage.attach($preview);
$('<div/>', {
'class': 'h5peditor-field-description',
text: field.description,
insertBefore: $preview
});
// Keep track of all adjustments options so that they may be aligned
var adjustmentOptions = [];
// Add spacing selector
adjustmentOptions.push(rangeSelector(spacingField, function (newSpacing) {
collage.setSpacing(newSpacing);
if (params.options.frame) {
collage.setFrame(newSpacing);
}
fitClips();
}, 20, humanInt));
// Add frame options
var $frameOptionWrapper = getItemWrapper(frameField.name, frameField.label);
adjustmentOptions.push($frameOptionWrapper);
$('<div class="h5p-collage-frame-selector"><label><input type="radio" name="h5p-collage-frame" value="1"' + (params.options.frame ? ' checked="checked"' : '') + '>' + CollageEditor.t('sameAsSpacing') + '</label><br/><label><input type="radio" name="h5p-collage-frame" value="0"' + (params.options.frame ? '' : ' checked="checked"') + '>' + CollageEditor.t('noFrame') + '</label></div>')
.appendTo($frameOptionWrapper)
.find('input').change(function () {
params.options.frame = (this.value === '1');
collage.setFrame(params.options.frame ? params.options.spacing : 0);
fitClips();
});
// Add height adjustment
adjustmentOptions.push(rangeSelector(heightField, function (newHeight) {
collage.setHeight(newHeight);
fitClips();
}, 38, humanFloat));
// Make sure all adjustment options have the same height
self.ready(function () {
sameHeight(adjustmentOptions);
});
// Attach wrapper to container
$wrapper.appendTo($container);
// Resize the collage
collage.trigger('resize');
};
/**
* Collect callbacks to run when the editor is done assembling.
*
* @param {function} ready callback
*/
this.ready = function (ready) {
if (passreadyCallbacks) {
parent.ready(ready);
}
else {
readyCallbacks.push(ready);
}
};
/**
* Checks if this field and all child fields are valid.
*
* @returns {boolean}
*/
this.validate = function () {
return true;
};
/**
* Remove this field and all child fields from the editor.
*/
this.remove = function () {
$wrapper.remove();
};
/**
* @param {string} name
* @param {string} [label]
* @param {string} [labelFor]
* @returns {H5P.jQuery}
*/
var getItemWrapper = function (name, label, labelFor) {
var $itemWrapper = $('<div/>', {
'class': 'h5p-collage-' + name + '-item',
appendTo: $wrapper
});
if (label) {
$('<label/>', {
'class': 'h5peditor-label',
'for': labelFor,
text: label,
appendTo: $itemWrapper
});
}
return $itemWrapper;
};
}
/**
* Get translations from the CollageEditor namespace.
*
* @param {string} key
* @param {Object} placeholders
* @returns {string} UI text
*/
CollageEditor.t = function (key, placeholders) {
return H5PEditor.t('H5PEditor.Collage', key, placeholders);
};
/**
* Add confirmation dialog
* @param {object} dialogOptions Dialog options.
* @returns {HTMLElement} confirmationDialog
*/
CollageEditor.showConfirmationDialog = function ($wrapper, dialogOptions) {
const confirmationDialog = new H5P.ConfirmationDialog(dialogOptions)
.appendTo(document.body);
confirmationDialog.show($wrapper.offset().top);
return confirmationDialog;
};
/**
* Look for field with given name in given collection.
*
* @private
* @param {string} name of field
* @param {Array} fields collection to look in
* @returns {Object} field object
*/
var findField = function (name, fields) {
for (var i = 0; i < fields.length; i++) {
if (fields[i].name === name) {
return fields[i];
}
}
};
return CollageEditor;
})(H5P.jQuery, H5PEditor.contentId);
// Register widget
H5PEditor.widgets.collage = H5PEditor.Collage;