diff --git a/README.md b/README.md index 4c3e3cc..b5b09ea 100644 --- a/README.md +++ b/README.md @@ -1,2 +1 @@ # semi-automatic-ui-process-list - diff --git a/aktionsKonsole.js b/aktionsKonsole.js index 7cb26a4..34a53d2 100644 --- a/aktionsKonsole.js +++ b/aktionsKonsole.js @@ -1,6 +1,6 @@ /** * Der Bereich in dem der aktuell geladene/bearbeitete Eintrag angezeigt wird. - * @returns {Component} + * @returns {Row} */ function valueRow() { return builder.row() @@ -14,11 +14,12 @@ function valueRow() { ) } + /** - * + * Bewegt das übergebene Element (entryElement) in das Zielelement (to) * @param {HTMLElement} entryElement * @param {HTMLElement} to das Elternelement in welches das Eintragselement verschoben werden soll - * @returns {HTMLElement} + * @returns {HTMLElement} das Element welches verschoben wurde (werden sollten) =entryElement */ function moveEntry(entryElement, to) { entryElement.remove(); @@ -36,6 +37,13 @@ function moveEntry(entryElement, to) { return entryElement; } + +/** + * + * @param {boolean} [reverse=false] Bestimmt die Richtung, + * in die der verschiebe Prozess durchgeführt werden soll. + * @returns {HTMLElement} welches verschoben wurde + */ function moveCurrent(reverse = false) { let currentArea = document.querySelector('div.current-entry-area'); if (currentArea.children.length === 0) { @@ -52,6 +60,11 @@ function moveCurrent(reverse = false) { ); } + +/** + * Läd den nächsten Eintrag von der "noch offen" Liste in den Aktionsbereich + * @returns {void} + */ function loadNext() { moveCurrent(); let upcomingArea = document.querySelector('div.plist-upcoming'); @@ -73,6 +86,11 @@ function loadNext() { }); } + +/** + * Lädt den Eintrag aus "erledigt" welcher als letztes hinzugefügt worden ist. + * @returns {void} + */ function loadPrev() { moveCurrent(true); let prevArea = document.querySelector('div.plist-done'); @@ -94,6 +112,12 @@ function loadPrev() { }); } + +/** + * + * @param {Modifier} modifier + * @returns {Column} + */ function aktionsKonsole(modifier = new Modifier()) { return builder.column() .modifier(componentModifiers.majorArea) diff --git a/comutingArea.js b/comutingArea.js index 66dcdbd..2001014 100644 --- a/comutingArea.js +++ b/comutingArea.js @@ -1,7 +1,7 @@ /** * Ein Knopf oder Kippschalter um den Klickselect zu (de-)aktivieren. - * Wenn aktiviert kann werden in einem generiertem feld, + * Wenn aktiviert werden in einem generiertem feld, * die angeklickten Felder referenziert. */ function clickFormulateToggle() { @@ -9,6 +9,10 @@ function clickFormulateToggle() { } +/** + * + * @returns {Column} + */ function infoDisplayField(){ return builder.column() .childContext([ @@ -23,6 +27,11 @@ function infoDisplayField(){ ]) } + +/** + * + * @returns {Row} + */ function computedArea() { return builder.row() .overflow(false, true) @@ -33,4 +42,4 @@ function computedArea() { .childContext([ clickFormulateToggle() ]) -} \ No newline at end of file +} diff --git a/content.js b/content.js index 4f9f687..d5186fa 100644 --- a/content.js +++ b/content.js @@ -8,6 +8,7 @@ const listRow = function (content) { ]) } + function listColumn(colText, bckColor, id) { return builder.column() .setAttribute("id", id) @@ -39,6 +40,7 @@ function listColumn(colText, bckColor, id) { ]) } + const currentElementDisplay = function (fields) { return builder.column() .modifier( @@ -63,6 +65,7 @@ const currentElementDisplay = function (fields) { ]) } + const currentSection = function () { return builder.column() .setAttribute("id", "current") diff --git a/dataImportArea.js b/dataImportArea.js index 5adf7ac..654b0ec 100644 --- a/dataImportArea.js +++ b/dataImportArea.js @@ -27,9 +27,30 @@ function rawTextImportArea(modifier = new Modifier()) { ) } + +/** + * Bestimmt eine "Regel" die auf einen Datensatz im Rahmen seier Bearbeitung ausgeführt werden soll. + */ class ProcessingRule { + /** + * @type {boolean} use Definiert ob diese Regel genutzt werden soll + */ use; + /** + * @type {*} der tatsächliche Wert, mit welcher die Regel definiert wurde. + */ value; + + /** + * + * @param {string} display Der dartgestellte Text + * @param {string} id Die referenz id + * @param {string} type Der Input-Field-Type + * @param {string} placeholder Der Platzhalterwert + * @param {string} desc Die Beschreibung die beim Mouseover angezeigt werden soll (html-title) + * @param {boolean} isFlagged Definiert ob eine ProcessingRule + * über eine Checkbox aktiviert/genutzt werden soll/darf. + */ constructor(display, id, type, placeholder, desc, isFlagged) { this.display = display; this.id = id; @@ -39,16 +60,28 @@ class ProcessingRule { this.isFlagged = isFlagged; } + /** + * + * @returns {HTMLElement|null} + */ _getCorrespondingComponent() { return document.getElementById(this.id) } + /** + * + * @returns {boolean} + */ _getToBeUsedState() { return !this.isFlagged || this._getCorrespondingComponent() .querySelector('input[name="is_to_be_used"]').checked === true; } + /** + * + * @returns {*} + */ _getInputTagValue() { let container = this._getCorrespondingComponent() .querySelector('.value-container'); @@ -69,13 +102,13 @@ class ProcessingRule { } - /** + * PRD := ProcessingRuleDefine * Die Überschrift und unter der Bedingung rule.isFlagged auch eine checkbox die bestimmt * ob die ProcessingRule genutzt werden soll. * * @param {ProcessingRule} rule - * @returns {Component} + * @returns {Row} */ function prdUseboxAndLabel(rule) { return builder.row() @@ -91,13 +124,14 @@ function prdUseboxAndLabel(rule) { ]); } + /** * Componente die eine ProcessingRule definiert. * - Ob sie verwendet werden soll * - welche Standartwert erwartet/verwendet werden soll * * @param {ProcessingRule} rule - * @returns {Component} + * @returns {Column} */ function processingRuleDefineComponent(rule, index, arr, modifier = new Modifier()) { return builder.column() @@ -134,7 +168,7 @@ function processingRuleDefineComponent(rule, index, arr, modifier = new Modifier * Bereich der ProcessingRules * * @param {ProcessingRule} rule - * @returns {Component} + * @returns {Row} */ function processingRulesArea(modifier = new Modifier()) { return builder.row() @@ -152,8 +186,10 @@ function processingRulesArea(modifier = new Modifier()) { ) } + let importedData = []; + /** * Funktion keine Komponente */ @@ -205,7 +241,7 @@ function importEntries() { * Bereich mit ausführbaren Elementen * * @param {ProcessingRule} rule - * @returns {Component} + * @returns {Row} */ function commandRow(modifier = new Modifier()) { return builder.row() @@ -226,7 +262,7 @@ function commandRow(modifier = new Modifier()) { * * * @param {ProcessingRule} rule - * @returns {Component} + * @returns {Column} */ function importArea(modifier = new Modifier()) { return builder.column() diff --git a/fun.js b/fun.js index 07e2c6a..5853f64 100644 --- a/fun.js +++ b/fun.js @@ -13,4 +13,4 @@ function rotateCurrentElement() { next.remove(); currentTarget.append(next); } -} \ No newline at end of file +} diff --git a/processingList.js b/processingList.js index 52235d3..d1ea47d 100644 --- a/processingList.js +++ b/processingList.js @@ -6,6 +6,7 @@ function listEntryRowControls() { ] } + function listEntryRowControlsContextMenu() { const menuOptions = { copy: { @@ -21,12 +22,13 @@ function listEntryRowControlsContextMenu() { } + /** * Stellt den Datensatz eines Prozesses dar * * @param {String[]} entry * @param {number} index - * @returns {Component} + * @returns {Row} */ function listEntryRow(entry, index) { return builder.row() @@ -72,6 +74,7 @@ function listEntryRow(entry, index) { ]); } + /** * * @param {ComponentColor} colorTheme @@ -98,6 +101,11 @@ function processingList(colorTheme, modifier = new Modifier()) { } +/** + * + * @param {Modifier} modifier + * @returns {Row} + */ function listArea(modifier = new Modifier()) { return builder.row() .addStyleClass("area") diff --git a/processingRules.js b/processingRules.js index 99b99c6..9426a2c 100644 --- a/processingRules.js +++ b/processingRules.js @@ -1,3 +1,6 @@ +/** + * @type {Map} + */ const processingRules = { line_splitter: { display: "Line splitter", diff --git a/theming.js b/theming.js index 02405cb..7fc7513 100644 --- a/theming.js +++ b/theming.js @@ -8,7 +8,9 @@ class ComponentColor { } } - +/** + * @type {Map} + */ const colorModifiers = { upcoming: new ComponentColor( MaterialFiveHundredlColors.BLUE, @@ -38,6 +40,10 @@ const colorModifiers = { ) } + +/** + * @type {Map} + */ const componentModifiers={ majorArea: new Modifier().clip(Shapes.RoundedCorner.all(16)), -} \ No newline at end of file +}