h5p-php-library/js/h5p-utils.js

483 lines
12 KiB
JavaScript
Raw Permalink Normal View History

2014-03-26 08:43:29 +01:00
var H5PUtils = H5PUtils || {};
(function ($) {
/**
* Generic function for creating a table including the headers
*
2014-03-26 08:43:29 +01:00
* @param {array} headers List of headers
*/
H5PUtils.createTable = function (headers) {
var $table = $('<table class="h5p-admin-table' + (H5PIntegration.extraTableClasses !== undefined ? ' ' + H5PIntegration.extraTableClasses : '') + '"></table>');
2014-03-26 08:43:29 +01:00
if(headers) {
var $thead = $('<thead></thead>');
var $tr = $('<tr></tr>');
2014-03-26 08:43:29 +01:00
$.each(headers, function (index, value) {
if (!(value instanceof Object)) {
value = {
2014-09-24 16:24:56 +02:00
html: value
};
}
$('<th/>', value).appendTo($tr);
2014-03-26 08:43:29 +01:00
});
$table.append($thead.append($tr));
2014-03-26 08:43:29 +01:00
}
2014-03-26 08:43:29 +01:00
return $table;
};
2014-03-26 08:43:29 +01:00
/**
* Generic function for creating a table row
*
2014-03-26 08:43:29 +01:00
* @param {array} rows Value list. Object name is used as class name in <TD>
*/
H5PUtils.createTableRow = function (rows) {
var $tr = $('<tr></tr>');
2014-03-26 08:43:29 +01:00
$.each(rows, function (index, value) {
2014-09-24 16:24:56 +02:00
if (!(value instanceof Object)) {
value = {
html: value
};
}
2014-09-24 16:24:56 +02:00
$('<td/>', value).appendTo($tr);
2014-03-26 08:43:29 +01:00
});
2014-03-26 08:43:29 +01:00
return $tr;
};
2014-03-26 08:43:29 +01:00
/**
* Generic function for creating a field containing label and value
*
* @param {string} label The label displayed in front of the value
2014-03-26 08:43:29 +01:00
* @param {string} value The value
*/
H5PUtils.createLabeledField = function (label, value) {
var $field = $('<div class="h5p-labeled-field"></div>');
2014-03-26 08:43:29 +01:00
$field.append('<div class="h5p-label">' + label + '</div>');
$field.append('<div class="h5p-value">' + value + '</div>');
2014-03-26 08:43:29 +01:00
return $field;
};
2014-03-26 08:43:29 +01:00
/**
* Replaces placeholder fields in translation strings
*
2014-03-26 08:43:29 +01:00
* @param {string} template The translation template string in the following format: "$name is a $sex"
* @param {array} replacors An js object with key and values. Eg: {'$name': 'Frode', '$sex': 'male'}
*/
H5PUtils.translateReplace = function (template, replacors) {
$.each(replacors, function (key, value) {
template = template.replace(new RegExp('\\'+key, 'g'), value);
2014-03-26 08:43:29 +01:00
});
return template;
};
2014-06-03 16:07:50 +02:00
/**
* Get throbber with given text.
*
2014-06-03 16:07:50 +02:00
* @param {String} text
* @returns {$}
*/
H5PUtils.throbber = function (text) {
return $('<div/>', {
class: 'h5p-throbber',
text: text
});
};
/**
* Makes it possbile to rebuild all content caches from admin UI.
* @param {Object} notCached
* @returns {$}
*/
H5PUtils.getRebuildCache = function (notCached) {
var $container = $('<div class="h5p-admin-rebuild-cache"><p class="message">' + notCached.message + '</p><p class="progress">' + notCached.progress + '</p></div>');
var $button = $('<button>' + notCached.button + '</button>').appendTo($container).click(function () {
var $spinner = $('<div/>', {class: 'h5p-spinner'}).replaceAll($button);
var parts = ['|', '/', '-', '\\'];
var current = 0;
var spinning = setInterval(function () {
$spinner.text(parts[current]);
current++;
if (current === parts.length) current = 0;
}, 100);
var $counter = $container.find('.progress');
var build = function () {
$.post(notCached.url, function (left) {
if (left === '0') {
clearInterval(spinning);
$container.remove();
location.reload();
}
else {
var counter = $counter.text().split(' ');
counter[0] = left;
$counter.text(counter.join(' '));
build();
}
});
};
build();
});
return $container;
};
/**
* Generic table class with useful helpers.
*
2014-10-17 15:01:45 +02:00
* @class
2014-10-17 16:06:47 +02:00
* @param {Object} classes
* Custom html classes to use on elements.
* e.g. {tableClass: 'fixed'}.
*/
2014-10-17 15:01:45 +02:00
H5PUtils.Table = function (classes) {
var numCols;
var sortByCol;
var $sortCol;
var sortCol;
var sortDir;
2014-10-17 16:06:47 +02:00
// Create basic table
var tableOptions = {};
if (classes.table !== undefined) {
tableOptions['class'] = classes.table;
}
var $table = $('<table/>', tableOptions);
var $thead = $('<thead/>').appendTo($table);
var $tfoot = $('<tfoot/>').appendTo($table);
var $tbody = $('<tbody/>').appendTo($table);
2014-10-17 15:01:45 +02:00
/**
* Add columns to given table row.
*
* @private
2014-10-17 16:06:47 +02:00
* @param {jQuery} $tr Table row
* @param {(String|Object)} col Column properties
* @param {Number} id Used to seperate the columns
2014-10-17 15:01:45 +02:00
*/
var addCol = function ($tr, col, id) {
var options = {
on: {}
};
if (!(col instanceof Object)) {
options.text = col;
}
else {
if (col.text !== undefined) {
options.text = col.text;
}
if (col.class !== undefined) {
options.class = col.class;
}
2014-10-17 15:01:45 +02:00
if (sortByCol !== undefined && col.sortable === true) {
// Make sortable
options.role = 'button';
options.tabIndex = 1;
// This is the first sortable column, use as default sort
if (sortCol === undefined) {
sortCol = id;
sortDir = 0;
options['class'] = 'h5p-sort';
}
options.on.click = function () {
sort($th, id);
};
}
}
// Append
var $th = $('<th>', options).appendTo($tr);
if (sortCol === id) {
$sortCol = $th; // Default sort column
}
};
/**
2014-10-17 16:06:47 +02:00
* Updates the UI when a column header has been clicked.
* Triggers sorting callback.
*
2014-10-17 15:01:45 +02:00
* @private
2014-10-17 16:06:47 +02:00
* @param {jQuery} $th Table header
* @param {Number} id Used to seperate the columns
2014-10-17 15:01:45 +02:00
*/
var sort = function ($th, id) {
if (id === sortCol) {
// Change sorting direction
if (sortDir === 0) {
sortDir = 1;
$th.addClass('h5p-reverse');
}
else {
sortDir = 0;
$th.removeClass('h5p-reverse');
}
}
else {
// Change sorting column
$sortCol.removeClass('h5p-sort').removeClass('h5p-reverse');
$sortCol = $th.addClass('h5p-sort');
sortCol = id;
sortDir = 0;
}
sortByCol(sortCol, sortDir);
};
/**
2014-10-17 16:06:47 +02:00
* Set table headers.
2014-10-17 15:01:45 +02:00
*
* @public
* @param {Array} cols
2014-10-17 16:06:47 +02:00
* Table header data. Can be strings or objects with options like
* "text" and "sortable". E.g.
* [{text: 'Col 1', sortable: true}, 'Col 2', 'Col 3']
* @param {Function} sort Callback which is runned when sorting changes
2014-10-17 15:01:45 +02:00
*/
this.setHeaders = function (cols, sort) {
numCols = cols.length;
sortByCol = sort;
// Create new head
var $newThead = $('<thead/>');
var $tr = $('<tr/>').appendTo($newThead);
for (var i = 0; i < cols.length; i++) {
addCol($tr, cols[i], i);
}
// Update DOM
$thead.replaceWith($newThead);
$thead = $newThead;
};
/**
2014-10-17 16:06:47 +02:00
* Set table rows.
*
2014-10-17 16:06:47 +02:00
* @public
* @param {Array} rows Table rows with cols: [[1,'hello',3],[2,'asd',6]]
*/
this.setRows = function (rows) {
var $newTbody = $('<tbody/>');
for (var i = 0; i < rows.length; i++) {
var $tr = $('<tr/>').appendTo($newTbody);
for (var j = 0; j < rows[i].length; j++) {
$('<td>', {
html: rows[i][j]
}).appendTo($tr);
}
}
$tbody.replaceWith($newTbody);
$tbody = $newTbody;
};
/**
2014-10-17 16:06:47 +02:00
* Set custom table body content. This can be a message or a throbber.
* Will cover all table columns.
*
2014-10-17 16:06:47 +02:00
* @public
* @param {jQuery} $content Custom content
*/
this.setBody = function ($content) {
var $newTbody = $('<tbody/>');
var $tr = $('<tr/>').appendTo($newTbody);
$('<td>', {
2014-10-17 15:01:45 +02:00
colspan: numCols
}).append($content).appendTo($tr);
$tbody.replaceWith($newTbody);
$tbody = $newTbody;
};
/**
2014-10-17 16:06:47 +02:00
* Set custom table foot content. This can be a pagination widget.
* Will cover all table columns.
*
2014-10-17 16:06:47 +02:00
* @public
* @param {jQuery} $content Custom content
*/
this.setFoot = function ($content) {
var $newTfoot = $('<tfoot/>');
var $tr = $('<tr/>').appendTo($newTfoot);
$('<td>', {
2014-10-17 15:01:45 +02:00
colspan: numCols
}).append($content).appendTo($tr);
$tfoot.replaceWith($newTfoot);
};
/**
2014-10-17 16:06:47 +02:00
* Appends the table to the given container.
*
2014-10-17 16:06:47 +02:00
* @public
* @param {jQuery} $container
*/
this.appendTo = function ($container) {
$table.appendTo($container);
};
};
/**
2014-10-17 16:06:47 +02:00
* Generic pagination class. Creates a useful pagination widget.
*
2014-10-17 16:06:47 +02:00
* @class
* @param {Number} num Total number of items to pagiate.
* @param {Number} limit Number of items to dispaly per page.
* @param {Function} goneTo
* Callback which is fired when the user wants to go to another page.
* @param {Object} l10n
* Localization / translations. e.g.
* {
* currentPage: 'Page $current of $total',
* nextPage: 'Next page',
* previousPage: 'Previous page'
* }
*/
H5PUtils.Pagination = function (num, limit, goneTo, l10n) {
var current = 0;
var pages = Math.ceil(num / limit);
// Create components
// Previous button
var $left = $('<button/>', {
html: '&lt;',
'class': 'button',
title: l10n.previousPage
}).click(function () {
goTo(current - 1);
});
// Current page text
var $text = $('<span/>').click(function () {
$input.width($text.width()).show().val(current + 1).focus();
$text.hide();
});
// Jump to page input
var $input = $('<input/>', {
type: 'number',
min : 1,
max: pages,
on: {
'blur': function () {
gotInput();
},
'keyup': function (event) {
if (event.keyCode === 13) {
gotInput();
return false;
}
}
}
}).hide();
// Next button
var $right = $('<button/>', {
html: '&gt;',
'class': 'button',
title: l10n.nextPage
}).click(function () {
goTo(current + 1);
});
/**
2014-10-17 16:06:47 +02:00
* Check what page the user has typed in and jump to it.
*
* @private
*/
var gotInput = function () {
var page = parseInt($input.hide().val());
if (!isNaN(page)) {
goTo(page - 1);
}
$text.show();
};
/**
2014-10-17 16:06:47 +02:00
* Update UI elements.
*
* @private
*/
var updateUI = function () {
var next = current + 1;
// Disable or enable buttons
$left.attr('disabled', current === 0);
$right.attr('disabled', next === pages);
// Update counter
$text.html(l10n.currentPage.replace('$current', next).replace('$total', pages));
};
/**
2014-10-17 16:06:47 +02:00
* Try to go to the requested page.
*
2014-10-17 16:06:47 +02:00
* @private
* @param {Number} page
*/
var goTo = function (page) {
if (page === current || page < 0 || page >= pages) {
return; // Invalid page number
}
current = page;
updateUI();
// Fire callback
goneTo(page * limit);
};
/**
2014-10-17 16:06:47 +02:00
* Update number of items and limit.
*
2014-10-17 16:06:47 +02:00
* @public
* @param {Number} newNum Total number of items to pagiate.
* @param {Number} newLimit Number of items to dispaly per page.
*/
this.update = function (newNum, newLimit) {
if (newNum !== num || newLimit !== limit) {
// Update num and limit
num = newNum;
limit = newLimit;
pages = Math.ceil(num / limit);
$input.attr('max', pages);
if (current >= pages) {
// Content is gone, move to last page.
goTo(pages - 1);
return;
}
updateUI();
}
};
/**
2014-10-17 16:06:47 +02:00
* Append the pagination widget to the given container.
*
2014-10-17 16:06:47 +02:00
* @public
* @param {jQuery} $container
*/
this.appendTo = function ($container) {
$left.add($text).add($input).add($right).appendTo($container);
};
// Update UI
updateUI();
};
})(H5P.jQuery);