From 355a48866d1a43df9443a3b559c8ec8642343f3a Mon Sep 17 00:00:00 2001 From: Jo-Philipp Wich Date: Tue, 5 Nov 2019 10:18:51 +0100 Subject: documentation: change JS docs template Use another template for the JS api documentation which provides a better overview over the classes and methods. Signed-off-by: Jo-Philipp Wich --- documentation/jsapi/LuCI.view.html | 2288 +++++++++++++++++++++++++----------- 1 file changed, 1623 insertions(+), 665 deletions(-) (limited to 'documentation/jsapi/LuCI.view.html') diff --git a/documentation/jsapi/LuCI.view.html b/documentation/jsapi/LuCI.view.html index 4a7209ceb..59b34cfd8 100644 --- a/documentation/jsapi/LuCI.view.html +++ b/documentation/jsapi/LuCI.view.html @@ -1,155 +1,1199 @@ - + - JSDoc: Class: view - - - + Class: view + + + + + - - + + + + + + + + +
+ +
+

-
- -

Class: view

- +
+ +
+ +
+
+

Class: view

+
- +
+

+ LuCI. -

- LuCI.view

- -

The view class forms the basis of views and provides a standard + view + + +

The view class forms the basis of views and provides a standard set of methods to inherit from.

- -
+
+ + +
+
+

+ + new LuCI.view() +

+ + +
+ luci.js, line 2687 +
+ +
+ +
+
+ + - - - - - - - - - - - - - + + + + + + +
- - + - - - - - - - - - - -
Source:
-
- - - + +
+ + + - - - - - - - - - - - - - - - - + + + + + + + +
- - - - - - - - + + + + + +

Methods

- +
- +
+
+

+ + addFooter(){DocumentFragment} +

+ +
+ luci.js, line 2905 +
+ +
-

addFooter() → {DocumentFragment}

+
+
- - - - -
-

Renders a standard page action footer if any of the +

+

Renders a standard page action footer if any of the handleSave(), handleSaveApply() or handleReset() functions are defined.

The default implementation should be sufficient for most @@ -160,119 +1204,109 @@ triggering the handleSave(), handleSaveApply() and

When any of these handle*() functions is overwritten with null by a view extending this class, the corresponding button will not be rendered.

-
- - - - - - - - - - - - +
+ + + + + + + +
- - + - - - - - - - - - - -
Source:
-
- - - + +
+ + + + + + + + +
Returns:
+ - - - - - - - - - - -
Returns:
- + + + -
-

Returns a DocumentFragment containing the footer bar +

+ + + + + + + + + + + +
TypeDescription
+ + DocumentFragment + + + Returns a DocumentFragment containing the footer bar with buttons for each corresponding handle*() action or an empty DocumentFragment if all three handle*() -methods are overwritten with null.

- - - - -
-
- Type -
-
- -DocumentFragment - - -
-
- +methods are overwritten with null.
- - - + + + +
- +
+
+

+ + handleReset(ev){*|Promise.<*>} +

+ +
+ luci.js, line 2871 +
+ +
-

handleReset(ev) → {*|Promise.<*>}

+
+
- - - - -
-

The handleReset function is invoked when the user clicks +

+

The handleReset function is invoked when the user clicks the Reset button in the page action footer.

The default implementation should be sufficient for most views using form.Map() based forms - it @@ -286,44 +1320,39 @@ this base class should overwrite the handleReset function with null.

The invocation of this function is wrapped by Promise.resolve() so it may return Promises if needed.

-
- - - - - - - - +
+ -
Parameters:
+ + + + + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + - + - - - - + + - - - + + +
NameTypeDescription
NameTypeDescription
ev @@ -332,125 +1361,116 @@ with null.

The DOM event that triggered the function.

 + +

The DOM event that triggered the function.
- - - - - - + + +
- - + - - - - - - - - - - -
Source:
-
- - - + +
+ + + + + + + + +
Returns:
+ - - - - - - - - - - -
Returns:
- + + + -
-

Any return values of this function are discarded, but +

+ + + + + + + + + + + +
TypeDescription
+ + * + | + + Promise.<*> + + + Any return values of this function are discarded, but passed through Promise.resolve() to ensure that any returned promise runs to completion before the button -is reenabled.

- - - - -
-
- Type -
-
- -* -| - -Promise.<*> - - -
-
- +is reenabled.
- - - + + + +
- +
+
+

+ + handleSave(ev){*|Promise.<*>} +

+ +
+ luci.js, line 2790 +
+ +
-

handleSave(ev) → {*|Promise.<*>}

+
+
- - - - -
-

The handleSave function is invoked when the user clicks +

+

The handleSave function is invoked when the user clicks the Save button in the page action footer.

The default implementation should be sufficient for most views using form.Map() based forms - it @@ -464,44 +1484,39 @@ this base class should overwrite the handleSave function with null.

The invocation of this function is wrapped by Promise.resolve() so it may return Promises if needed.

-
- - - - - - - - +
+ -
Parameters:
+ + + + + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + - + - - - - + + - - - + + +
NameTypeDescription
NameTypeDescription
ev @@ -510,125 +1525,116 @@ with null.

The DOM event that triggered the function.

 + +

The DOM event that triggered the function.
- - - - - - + + +
- - + - - - - - - - - - - -
Source:
-
- - - + +
+ + + + + + + + +
Returns:
+ - - - - - - - - - - -
Returns:
- + + + -
-

Any return values of this function are discarded, but +

+ + + + + + + + + + + +
TypeDescription
+ + * + | + + Promise.<*> + + + Any return values of this function are discarded, but passed through Promise.resolve() to ensure that any returned promise runs to completion before the button -is reenabled.

- - - - -
-
- Type -
-
- -* -| - -Promise.<*> - - -
-
- +is reenabled.
- - - + + + +
- +
+
+

+ + handleSaveApply(ev){*|Promise.<*>} +

+ +
+ luci.js, line 2834 +
+ +
-

handleSaveApply(ev) → {*|Promise.<*>}

+
+
- - - - -
-

The handleSaveApply function is invoked when the user clicks +

+

The handleSaveApply function is invoked when the user clicks the Save & Apply button in the page action footer.

The default implementation should be sufficient for most views using form.Map() based forms - it @@ -644,44 +1650,39 @@ extending this base class should overwrite the handleSaveApply function with null.

The invocation of this function is wrapped by Promise.resolve() so it may return Promises if needed.

-
- - - - - - - - +
+ -
Parameters:
+ + + + + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + - + - - - - + + - - - + + +
NameTypeDescription
NameTypeDescription
ev @@ -690,125 +1691,116 @@ extending this base class should overwrite the

The DOM event that triggered the function.

 + +

The DOM event that triggered the function.
- - - - - - + + +
- - + - - - - - - - - - - -
Source:
-
- - - + +
+ + + + + + + + +
Returns:
+ - - - - - - - - - - -
Returns:
- + + + -
-

Any return values of this function are discarded, but +

+ + + + + + + + + + + +
TypeDescription
+ + * + | + + Promise.<*> + + + Any return values of this function are discarded, but passed through Promise.resolve() to ensure that any returned promise runs to completion before the button -is reenabled.

- - - - -
-
- Type -
-
- -* -| - -Promise.<*> - - -
-
- +is reenabled.
- - - + + + +
- +
+
+

+ + abstractload(){*|Promise.<*>} +

+ +
+ luci.js, line 2725 +
+ +
-

(abstract) load() → {*|Promise.<*>}

+
+
- - - - -
-

The load function is invoked before the view is rendered.

+
+

The load function is invoked before the view is rendered.

The invocation of this function is wrapped by Promise.resolve() so it may return Promises if needed.

The return value of the function (or the resolved values @@ -816,119 +1808,109 @@ of the promise returned by it) will be passed as first argument to render().

This function is supposed to be overwritten by subclasses, the default implementation does nothing.

-
- - - - - - - - - - - - +
+ + + + + + + +
- - + - - - - - - - - - - -
Source:
-
- - - + +
+ + + + + + + + +
Returns:
+ - - - - - - - - - - -
Returns:
- - -
-

May return any value or a Promise resolving to any value.

-
- - - -
-
- Type -
-
+ + + -* -| - -Promise.<*> - - - - - + + + + + + + + + + + + +
TypeDescription
+ + * + | + + Promise.<*> + + + May return any value or a Promise resolving to any value.
- - - + + + +
- +
+
+

+ + abstractrender(load_results){Node|Promise.<Node>} +

+ +
+ luci.js, line 2757 +
+ +
-

(abstract) render(load_results) → {Node|Promise.<Node>}

+
+
- - - - -
-

The render function is invoked after the +

+

The render function is invoked after the load() function and responsible for setting up the view contents. It must return a DOM Node or DocumentFragment holding the contents to @@ -941,44 +1923,39 @@ main content area using dom.append().

This function is supposed to be overwritten by subclasses, the default implementation does nothing.

-
- - - - - - - - +
+ -
Parameters:
+ + + + + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + - + - - - - - - - + + +
NameTypeDescription
NameTypeDescription
load_results @@ -990,136 +1967,117 @@ the default implementation does nothing.

This function will receive the return value of the + +

+ +

This function will receive the return value of the view.load() function as first argument.
- - - - - - + + +
- - + - - - - - - - - - - -
Source:
-
- - - + +
+ + + + + + + + +
Returns:
+ - - - - - - - - - - -
Returns:
- - -
-

Should return a DOM Node value or a Promise resolving -to a Node value.

-
- - - -
-
- Type -
-
+ + + -Node -| - -Promise.<Node> - - - - - + + + + + + + + + + + + +
TypeDescription
+ + Node + | + + Promise.<Node> + + + Should return a DOM Node value or a Promise resolving +to a Node value.
- - - - - + + +
+
+ + + +
-
- - + -
- -
-
- Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 09:33:05 GMT+0100 (Central European Standard Time) -
+ - - +
+ Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 10:17:12 GMT+0100 (Central European Standard Time) +
+
+
+ + \ No newline at end of file -- cgit v1.2.3