VladPolskiy/edittable
1
0
Fork 0
mirror of https://github.com/cosmocode/edittable.git synced 2026-01-05 06:21:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

style: add valid jsdoc for parameters

Browse Source
This commit is contained in:
Michael Große
2017-09-05 13:44:46 +02:00
parent ad47c8546b
commit 92083d79aa
4 changed files with 105 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
.eslintrc.js
View File

@ -51,5 +51,13 @@ module.exports = {
"no-return-assign": "error",
"no-throw-literal": "error",
"strict": ["error", "function"],
"require-jsdoc": ["error", {
"require": {
"FunctionDeclaration": true,
"MethodDefinition": true,
"ClassDeclaration": false,
"ArrowFunctionExpression": false
}
}]
},
};

29
script/contextmenu.js
View File

@ -7,8 +7,9 @@ window.edittable = window.edittable || {};
/**
* create an iterable array of selected cells from the selection object
*
* @param selection object
* @returns {Array}
* @param {object} selection the selection object
*
* @returns {Array} an array of the rows/columns of the cells in the selection
*/
edittable.cellArray = function (selection) {
var selectionArray = [];
@ -23,9 +24,9 @@ window.edittable = window.edittable || {};
/**
* Defines our own contextMenu with custom callbacks
*
* @param data array
* @param meta array
* @returns object
* @param {array} data the data array
* @param {array} meta the meta array
* @returns {object} the context menu object
*/
edittable.getEditTableContextMenu = function (data, meta) {
return {
@ -106,8 +107,10 @@ window.edittable = window.edittable || {};
/**
* The same as the default action, but with confirmation
*
* @param key
* @param selection
* @param {string} key key of the menu item
* @param {object} selection the selection object
*
* @return {void}
*/
callback: function (key, selection) {
if (window.confirm(LANG.plugins.edittable.confirmdeleterow)) {
@ -117,6 +120,8 @@ window.edittable = window.edittable || {};
},
/**
* do not show when this is the last row
*
* @return {boolean} true if the entry is to be disabled, false otherwise
*/
disabled: function () {
var rowsInTable = this.countRows();
@ -138,8 +143,10 @@ window.edittable = window.edittable || {};
/**
* The same as the default action, but with confirmation
*
* @param key
* @param selection
* @param {string} key key of the menu item
* @param {object} selection the selection object
*
* @return {void}
*/
callback: function (key, selection) {
if (window.confirm(LANG.plugins.edittable.confirmdeletecol)) {
@ -149,6 +156,8 @@ window.edittable = window.edittable || {};
},
/**
* do not show when this is the last row
*
* @return {boolean} true if the entry is to be disabled, false otherwise
*/
disabled: function () {
var colsInTable = this.countCols();
@ -176,7 +185,7 @@ window.edittable = window.edittable || {};
/**
* disable if only one cell is selected
*
* @returns {boolean}
* @return {boolean} true if the entry is to be disabled, false otherwise
*/
disabled: function () {
var selection = this.getSelected();

91
script/editor.js
View File

@ -6,6 +6,15 @@ window.edittable_plugins = window.edittable_plugins || {};
(function (edittable, edittable_plugins) {
'use strict';
/**
*
*
* @param {Array} movingRowIndexes the indices of the rows to be moved
* @param {int} target the row where the rows will be inserted
* @param {Array} dmarray the data or meta array
*
* @return {Array} the new data or meta array
*/
edittable.moveRow = function moveRow(movingRowIndexes, target, dmarray) {
var startIndex = movingRowIndexes[0];
var endIndex = movingRowIndexes[movingRowIndexes.length - 1];
@ -30,12 +39,25 @@ window.edittable_plugins = window.edittable_plugins || {};
};
/**
*
* @param {Array} movingColIndexes the indices of the columns to be moved
* @param {int} target the column where the columns will be inserted
* @param {Array} dmarray the data or meta array
*
* @return {Array} the new data or meta array
*/
edittable.moveCol = function moveCol(movingColIndexes, target, dmarray) {
return dmarray.map(function (row) {
return edittable.moveRow(movingColIndexes, target, row);
});
};
/**
*
* @param {Array} meta the meta array
* @returns {Array} an array of the cells with a rowspan or colspan larger than 1
*/
edittable.getMerges = function (meta) {
var merges = [];
for (var row = 0; row < meta.length; row += 1) {
@ -55,6 +77,14 @@ window.edittable_plugins = window.edittable_plugins || {};
};
/**
*
* @param {Array} merges an array of the cells that are part of a merge
* @param {int} target the target column or row
* @param {string} direction whether we're trying to move a col or row
*
* @return {bool} wether the target col/row is part of a merge
*/
edittable.isTargetInMerge = function isTargetInMerge(merges, target, direction) {
return merges.some(function (merge) {
return (merge[direction] < target && target < merge[direction] + merge[direction + 'span']);
@ -95,6 +125,8 @@ window.edittable_plugins = window.edittable_plugins || {};
/**
* Attach pointers to our raw data structures in the instance
*
* @return {void}
*/
afterLoadData: function () {
var i;
@ -117,9 +149,9 @@ window.edittable_plugins = window.edittable_plugins || {};
*
* properties are stored in extra array
*
* @param row int
* @param col int
* @returns {*}
* @param {int} row the row of the desired column
* @param {int} col the col of the desired column
* @returns {Array} the respective cell from the meta array
*/
cells: function (row, col) {
return meta[row][col];
@ -130,10 +162,12 @@ window.edittable_plugins = window.edittable_plugins || {};
*
* It handles all our custom meta attributes like alignments and rowspans
*
* @param instance
* @param td
* @param row
* @param col
* @param {object} instance the handsontable instance
* @param {HTMLTableCellElement} td the dom node of the cell
* @param {int} row the row of the cell to be rendered
* @param {int} col the column of the cell to be rendered
*
* @return {void}
*/
renderer: function (instance, td, row, col) {
// for some reason, neither cellProperties nor instance.getCellMeta() give the right data
@ -181,6 +215,8 @@ window.edittable_plugins = window.edittable_plugins || {};
/**
* Initialization after the Editor loaded
*
* @return {void}
*/
afterInit: function () {
// select first cell
@ -219,6 +255,7 @@ window.edittable_plugins = window.edittable_plugins || {};
/**
* This recalculates the col and row spans and makes sure all correct cells are hidden
*
* @return {void}
*/
beforeRender: function () {
var row, r, c, col, i;
@ -302,7 +339,9 @@ window.edittable_plugins = window.edittable_plugins || {};
/**
* Disable key handling while the link wizard or any other dialog is visible
*
* @param e
* @param {event} e the keydown event object
*
* @return {void}
*/
beforeKeyDown: function (e) {
if (jQuery('.ui-dialog:visible').length) {
@ -336,8 +375,10 @@ window.edittable_plugins = window.edittable_plugins || {};
/**
* Update meta data array when rows are added
*
* @param index int
* @param amount int
* @param {int} index the index where the new rows are created
* @param {int} amount the number of new rows that are created
*
* @return {void}
*/
afterCreateRow: function (index, amount) {
var i;
@ -359,8 +400,10 @@ window.edittable_plugins = window.edittable_plugins || {};
/**
* Update meta data array when rows are removed
*
* @param index int
* @param amount int
* @param {int} index the index where the rows are removed
* @param {int} amount the number of rows that are removed
*
* @return {void}
*/
afterRemoveRow: function (index, amount) {
meta.splice(index, amount);
@ -369,8 +412,10 @@ window.edittable_plugins = window.edittable_plugins || {};
/**
* Update meta data array when columns are added
*
* @param index int
* @param amount int
* @param {int} index the index where the new columns are created
* @param {int} amount the number of new columns that are created
*
* @return {void}
*/
afterCreateCol: function (index, amount) {
for (var row = 0; row < data.length; row += 1) {
@ -383,8 +428,10 @@ window.edittable_plugins = window.edittable_plugins || {};
/**
* Update meta data array when columns are removed
*
* @param index int
* @param amount int
* @param {int} index the index where the columns are removed
* @param {int} amount the number of columns that are removed
*
* @return {void}
*/
afterRemoveCol: function (index, amount) {
for (var row = 0; row < data.length; row += 1) {
@ -395,8 +442,10 @@ window.edittable_plugins = window.edittable_plugins || {};
/**
* Skip hidden cells for selection
*
* @param r int
* @param c int
* @param {int} r the row of the selected cell
* @param {int} c the column of the selected cell
*
* @return {void}
*/
afterSelection: function (r, c) {
if (meta[r][c].hide) {
@ -457,10 +506,10 @@ window.edittable_plugins = window.edittable_plugins || {};
/**
*
* @param pasteData An array of arrays which contains data to paste.
* @param coords An array of objects with ranges of the visual indexes (startRow, startCol, endRow, endCol)
* @param {Array} pasteData An array of arrays which contains data to paste.
* @param {Array} coords An array of objects with ranges of the visual indexes (startRow, startCol, endRow, endCol)
* that correspond to the previously selected area.
* @return {bool}
* @return {true} always allowing the pasting
*/
beforePaste: function (pasteData, coords) {
var startRow = coords[0].startRow;

8
script/newtable.js
View File

@ -15,6 +15,14 @@ window.addBtnActionNewTable = function addBtnActionNewTable($btn, props, edid) {
var editform = jQuery('#dw__editform')[0];
var ed = jQuery('#' + edid)[0];
/**
* Add new textarea to the form
*
* @param {string} name the name attribute of the new field
* @param {string} val the value attribute of the new field
*
* @return {void}
*/
function addField(name, val) {
var pos_field = document.createElement('textarea');
pos_field.name = 'edittable__new[' + name + ']';