Skip to content
Snippets Groups Projects
Verified Commit 94059f24 authored by Volker Schukai's avatar Volker Schukai :alien:
Browse files

doc: clean the fire definitions

parent fcf796dd
Branches
Tags
No related merge requests found
...@@ -139,9 +139,9 @@ const columnBarElementSymbol = Symbol("columnBarElement"); ...@@ -139,9 +139,9 @@ const columnBarElementSymbol = Symbol("columnBarElement");
* @copyright schukai GmbH * @copyright schukai GmbH
* @memberOf Monster.Components.Datatable * @memberOf Monster.Components.Datatable
* @summary A data table * @summary A data table
* @fire Monster.Components.Datatable.event:monster-datatable-row-copied * @fires monster-datatable-row-copied
* @fire Monster.Components.Datatable.event:monster-datatable-row-removed * @fires monster-datatable-row-removed
* @fire Monster.Components.Datatable.event:monster-datatable-row-added * @fires monster-datatable-row-added
*/ */
class DataTable extends CustomElement { class DataTable extends CustomElement {
/** /**
...@@ -359,7 +359,7 @@ class DataTable extends CustomElement { ...@@ -359,7 +359,7 @@ class DataTable extends CustomElement {
* @param {number} fromIndex * @param {number} fromIndex
* @param {number} toIndex * @param {number} toIndex
* @returns {Monster.Components.Datatable.DataTable} * @returns {Monster.Components.Datatable.DataTable}
* @fire Monster.Components.Datatable.event:monster-datatable-row-copied * @fires monster-datatable-row-copied
*/ */
copyRow(fromIndex, toIndex) { copyRow(fromIndex, toIndex) {
const datasource = this[datasourceLinkedElementSymbol]; const datasource = this[datasourceLinkedElementSymbol];
...@@ -413,7 +413,7 @@ class DataTable extends CustomElement { ...@@ -413,7 +413,7 @@ class DataTable extends CustomElement {
* Remove a row from the datatable * Remove a row from the datatable
* @param index * @param index
* @returns {Monster.Components.Datatable.DataTable} * @returns {Monster.Components.Datatable.DataTable}
* @fire Monster.Components.Datatable.event:monster-datatable-row-removed * @fires monster-datatable-row-removed
*/ */
removeRow(index) { removeRow(index) {
const datasource = this[datasourceLinkedElementSymbol]; const datasource = this[datasourceLinkedElementSymbol];
...@@ -459,7 +459,7 @@ class DataTable extends CustomElement { ...@@ -459,7 +459,7 @@ class DataTable extends CustomElement {
* Add a row to the datatable * Add a row to the datatable
* @param {Object} data * @param {Object} data
* @returns {Monster.Components.Datatable.DataTable} * @returns {Monster.Components.Datatable.DataTable}
* @fire Monster.Components.Datatable.event:monster-datatable-row-added * @fires monster-datatable-row-added
**/ **/
addRow(data) { addRow(data) {
const datasource = this[datasourceLinkedElementSymbol]; const datasource = this[datasourceLinkedElementSymbol];
......
...@@ -130,7 +130,7 @@ class ActionButton extends PopperButton { ...@@ -130,7 +130,7 @@ class ActionButton extends PopperButton {
/** /**
* *
* @return {Monster.Components.Form.Popper} * @return {Monster.Components.Form.Popper}
* @event monster-action-button-show-dialog * @fires monster-action-button-show-dialog
*/ */
showDialog() { showDialog() {
if (this.getOption("buttons").length === 0) { if (this.getOption("buttons").length === 0) {
......
...@@ -155,7 +155,7 @@ const ATTRIBUTE_POPPER_POSITION = "data-monster-popper-position"; ...@@ -155,7 +155,7 @@ const ATTRIBUTE_POPPER_POSITION = "data-monster-popper-position";
* @copyright schukai GmbH * @copyright schukai GmbH
* @memberOf Monster.Components.Form * @memberOf Monster.Components.Form
* @summary A configurable tab control * @summary A configurable tab control
* @fires Monster.Components.event:monster-fetched * @fires monster-fetched
*/ */
/** /**
......
...@@ -275,7 +275,7 @@ function updateColumns() { ...@@ -275,7 +275,7 @@ function updateColumns() {
/** /**
* @private * @private
* @return {initEventHandler} * @return {initEventHandler}
* @fires event:monster-field-set-clicked * @fires monster-field-set-clicked
*/ */
function initEventHandler() { function initEventHandler() {
this[toggleSwitchElementSymbol].setOption( this[toggleSwitchElementSymbol].setOption(
......
...@@ -91,23 +91,6 @@ const intersectionObserverWasInitialized = Symbol("wasInitialized"); ...@@ -91,23 +91,6 @@ const intersectionObserverWasInitialized = Symbol("wasInitialized");
* </monster-reload> * </monster-reload>
* ``` * ```
* *
* @startuml reload.png
* skinparam monochrome true
* skinparam shadowing false
* HTMLElement <|-- CustomElement
* CustomElement <|-- CustomControl
* CustomControl <|-- Reload
* @enduml
*
* @copyright schukai GmbH
* @memberOf Monster.Components.Form
* @summary A reload control
* @fires Monster.Components.event:m
*/
/**
* A reload control.
*
* @fragments /fragments/components/form/reload/ * @fragments /fragments/components/form/reload/
* *
* @example /examples/components/form/reload-simple * @example /examples/components/form/reload-simple
...@@ -115,7 +98,7 @@ const intersectionObserverWasInitialized = Symbol("wasInitialized"); ...@@ -115,7 +98,7 @@ const intersectionObserverWasInitialized = Symbol("wasInitialized");
* @since 1.13.0 * @since 1.13.0
* @copyright schukai GmbH * @copyright schukai GmbH
* @summary A beautiful reload control * @summary A beautiful reload control
* @fires onster-fetched * @fires monster-fetched
*/ */
class Reload extends CustomElement { class Reload extends CustomElement {
/** /**
...@@ -208,7 +191,7 @@ class Reload extends CustomElement { ...@@ -208,7 +191,7 @@ class Reload extends CustomElement {
* @throws {Error} request failed * @throws {Error} request failed
* @throws {Error} not found * @throws {Error} not found
* @throws {Error} undefined status or type * @throws {Error} undefined status or type
* @fires Monster.Components.event:monster-fetched * @fires monster-fetched
* @return {Monster.Components.Form.Form} * @return {Monster.Components.Form.Form}
*/ */
[assembleMethodSymbol]() { [assembleMethodSymbol]() {
...@@ -277,7 +260,7 @@ function initOptionsFromArguments() { ...@@ -277,7 +260,7 @@ function initOptionsFromArguments() {
* @throws {Error} request failed * @throws {Error} request failed
* @throws {Error} not found * @throws {Error} not found
* @throws {Error} undefined status or type * @throws {Error} undefined status or type
* @fires Monster.Components.event:monster-fetched * @fires monster-fetched
*/ */
function initIntersectionObserver() { function initIntersectionObserver() {
if (this[intersectionObserverWasInitialized] === true) { if (this[intersectionObserverWasInitialized] === true) {
...@@ -326,7 +309,7 @@ function initIntersectionObserver() { ...@@ -326,7 +309,7 @@ function initIntersectionObserver() {
* @throws {Error} undefined status or type * @throws {Error} undefined status or type
* @throws {TypeError} value is not an instance of * @throws {TypeError} value is not an instance of
* @throws {TypeError} value is not a string * @throws {TypeError} value is not a string
* @fires Monster.Components.event:monster-fetched * @fires monster-fetched
* @return {Promise} * @return {Promise}
*/ */
function loadContent() { function loadContent() {
......
...@@ -138,7 +138,7 @@ class Template extends CustomElement { ...@@ -138,7 +138,7 @@ class Template extends CustomElement {
* @throws {Error} request failed * @throws {Error} request failed
* @throws {Error} not found * @throws {Error} not found
* @throws {Error} undefined status or type * @throws {Error} undefined status or type
* @fires Monster.Components.event:monster-fetched * @fires monster-fetched
* @return {Monster.Components.Form.Form} * @return {Monster.Components.Form.Form}
*/ */
[assembleMethodSymbol]() { [assembleMethodSymbol]() {
...@@ -224,7 +224,7 @@ function initOptionsFromArguments() { ...@@ -224,7 +224,7 @@ function initOptionsFromArguments() {
* @throws {Error} request failed * @throws {Error} request failed
* @throws {Error} not found * @throws {Error} not found
* @throws {Error} undefined status or type * @throws {Error} undefined status or type
* @fires Monster.Components.event:monster-fetched * @fires monster-fetched
*/ */
function initIntersectionObserver() { function initIntersectionObserver() {
if (this[intersectionObserverWasInitialized] === true) { if (this[intersectionObserverWasInitialized] === true) {
...@@ -270,7 +270,7 @@ function initIntersectionObserver() { ...@@ -270,7 +270,7 @@ function initIntersectionObserver() {
* @throws {Error} undefined status or type * @throws {Error} undefined status or type
* @throws {TypeError} value is not an instance of * @throws {TypeError} value is not an instance of
* @throws {TypeError} value is not a string * @throws {TypeError} value is not a string
* @fires Monster.Components.event:monster-fetched * @fires monster-fetched
*/ */
function loadContent() { function loadContent() {
if (!this.shadowRoot) { if (!this.shadowRoot) {
......
...@@ -104,10 +104,10 @@ const ATTRIBUTE_VALUE_OVERLAY_OPEN = "overlay-open"; ...@@ -104,10 +104,10 @@ const ATTRIBUTE_VALUE_OVERLAY_OPEN = "overlay-open";
* @copyright schukai GmbH * @copyright schukai GmbH
* @memberOf Monster.Components.Host * @memberOf Monster.Components.Host
* @summary A simple overlay component * @summary A simple overlay component
* @fires Monster.Components.Host.Overlay.event:monster-overlay-before-open * @fires monster-overlay-before-open
* @fires Monster.Components.Host.Overlay.event:monster-overlay-open * @fires monster-overlay-open
* @fires Monster.Components.Host.Overlay.event:monster-overlay-before-close * @fires monster-overlay-before-close
* @fires Monster.Components.Host.Overlay.event:monster-overlay-closed * @fires monster-overlay-closed
*/ */
class Overlay extends CustomElement { class Overlay extends CustomElement {
/** /**
...@@ -206,10 +206,10 @@ class Overlay extends CustomElement { ...@@ -206,10 +206,10 @@ class Overlay extends CustomElement {
/** /**
* @returns {Monster.Components.Host.Overlay} * @returns {Monster.Components.Host.Overlay}
* @fires Monster.Components.Host.Overlay.event:monster-overlay-before-open * @fires monster-overlay-before-open
* @fires Monster.Components.Host.Overlay.event:monster-overlay-open * @fires monster-overlay-open
* @fires Monster.Components.Host.Overlay.event:monster-overlay-before-close * @fires monster-overlay-before-close
* @fires Monster.Components.Host.Overlay.event:monster-overlay-closed * @fires monster-overlay-closed
*/ */
open() { open() {
fireCustomEvent(this, "monster-overlay-before-open", {}); fireCustomEvent(this, "monster-overlay-before-open", {});
......
...@@ -201,8 +201,8 @@ class Collapse extends CustomElement { ...@@ -201,8 +201,8 @@ class Collapse extends CustomElement {
/** /**
* Open the collapse * Open the collapse
* @returns {Collapse} * @returns {Collapse}
* @fires monster-collapse-before-open * @fires monster-collapse-before-open This event is fired before the collapse is opened.
* @fires monster-collapse-open * @fires monster-collapse-open This event is fired after the collapse is opened.
*/ */
open() { open() {
let node; let node;
...@@ -245,8 +245,8 @@ class Collapse extends CustomElement { ...@@ -245,8 +245,8 @@ class Collapse extends CustomElement {
/** /**
* Close the collapse * Close the collapse
* @returns {Collapse} * @returns {Collapse}
* @fires monster-collapse-before-close * @fires monster-collapse-before-close This event is fired before the collapse is closed.
* @fires monster-collapse-closed * @fires monster-collapse-closed This event is fired after the collapse is closed.
*/ */
close() { close() {
if (!this[detailsElementSymbol].classList.contains("active")) { if (!this[detailsElementSymbol].classList.contains("active")) {
...@@ -284,7 +284,7 @@ class Collapse extends CustomElement { ...@@ -284,7 +284,7 @@ class Collapse extends CustomElement {
/** /**
* This method is called when the element is inserted into a document, including into a shadow tree. * This method is called when the element is inserted into a document, including into a shadow tree.
* @return {Collapse} * @return {Collapse}
* @fires event:monster-collapse-adjust-height * @fires monster-collapse-adjust-height This event is fired when the height is adjusted. As a detail, the height is passed.
*/ */
adjustHeight() { adjustHeight() {
adjustHeight.call(this); adjustHeight.call(this);
...@@ -295,7 +295,6 @@ class Collapse extends CustomElement { ...@@ -295,7 +295,6 @@ class Collapse extends CustomElement {
/** /**
* @private * @private
* @returns {void} * @returns {void}
* @fires event:monster-collapse-adjust-height
*/ */
function adjustHeight() { function adjustHeight() {
let height = 0; let height = 0;
...@@ -336,7 +335,9 @@ function adjustHeight() { ...@@ -336,7 +335,9 @@ function adjustHeight() {
"important", "important",
); );
fireCustomEvent(this, "monster-" + this[nameSymbol] + "-adjust-height", {}); fireCustomEvent(this, "monster-" + this[nameSymbol] + "-adjust-height", {
height,
});
} }
function updateResizeObserverObservation() { function updateResizeObserverObservation() {
......
...@@ -200,7 +200,7 @@ class SplitPanel extends CustomElement { ...@@ -200,7 +200,7 @@ class SplitPanel extends CustomElement {
/** /**
* Set the dimensions of the panel based on the split type. * Set the dimensions of the panel based on the split type.
* @fires Monster.Components.Layout.event:monster-dimension-changed * @fires monster-dimension-changed
*/ */
function applyPanelDimensions() { function applyPanelDimensions() {
const splitType = this.getOption("splitType"); const splitType = this.getOption("splitType");
......
...@@ -664,14 +664,9 @@ function initEventHandler() { ...@@ -664,14 +664,9 @@ function initEventHandler() {
} }
}; };
/**
* event:monster-tab-remove
* @event Monster.Components.Layout.event:monster-tab-remove
*/
/** /**
* @param {Event} event * @param {Event} event
* @fires Monster.Components.Layout.event:monster-tab-remove * @fires monster-tab-remove
*/ */
this[removeTabEventHandler] = (event) => { this[removeTabEventHandler] = (event) => {
const element = findTargetElementFromEvent( const element = findTargetElementFromEvent(
......
...@@ -96,7 +96,6 @@ const removeEventHandlerSymbol = Symbol("removeEventHandler"); ...@@ -96,7 +96,6 @@ const removeEventHandlerSymbol = Symbol("removeEventHandler");
* @copyright schukai GmbH * @copyright schukai GmbH
* @memberOf Monster.Components.Notify * @memberOf Monster.Components.Notify
* @summary A highly configurable select control * @summary A highly configurable select control
* @fires Monster.Components.Notify.event:monster-xxxx
*/ */
class Message extends CustomElement { class Message extends CustomElement {
/** /**
......
...@@ -128,7 +128,7 @@ ...@@ -128,7 +128,7 @@
// * @copyright schukai GmbH // * @copyright schukai GmbH
// * @memberOf Monster.Components.TreeMenu // * @memberOf Monster.Components.TreeMenu
// * @summary A TreeMenu control // * @summary A TreeMenu control
// * @fires Monster.Components.TreeMenu.event:monster-fetched // * @fires monster-fetched
// */ // */
// class TreeMenu extends CustomElement { // class TreeMenu extends CustomElement {
// /** // /**
...@@ -613,7 +613,7 @@ ...@@ -613,7 +613,7 @@
// // * @throws {Error} request failed // // * @throws {Error} request failed
// // * @throws {Error} not found // // * @throws {Error} not found
// // * @throws {Error} undefined status or type // // * @throws {Error} undefined status or type
// // * @fires Monster.Components.TreeMenu.event:monster-fetched // // * @fires monster-fetched
// // */ // // */
// // function initIntersectionObserver() { // // function initIntersectionObserver() {
// // const self = this; // // const self = this;
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment