new javadoc

BBj-Plugins · Sep 25, 2017 · 3817093 · 3817093
1 parent 13b57a8
commit 3817093
Show file tree

Hide file tree

Showing 12 changed files with 310 additions and 112 deletions.
diff --git a/docs/javadoc/BBjGridExWidget.html b/docs/javadoc/BBjGridExWidget.html
diff --git a/docs/javadoc/allclasses-frame.html b/docs/javadoc/allclasses-frame.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (1.8.0_144) on Mon Sep 25 18:13:30 CEST 2017 -->
+<!-- Generated by javadoc (1.8.0_144) on Mon Sep 25 19:08:16 CEST 2017 -->
 <title>All Classes</title>
 <meta name="date" content="2017-09-25">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

diff --git a/docs/javadoc/allclasses-noframe.html b/docs/javadoc/allclasses-noframe.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (1.8.0_144) on Mon Sep 25 18:13:30 CEST 2017 -->
+<!-- Generated by javadoc (1.8.0_144) on Mon Sep 25 19:08:16 CEST 2017 -->
 <title>All Classes</title>
 <meta name="date" content="2017-09-25">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

diff --git a/docs/javadoc/constant-values.html b/docs/javadoc/constant-values.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (1.8.0_144) on Mon Sep 25 18:13:30 CEST 2017 -->
+<!-- Generated by javadoc (1.8.0_144) on Mon Sep 25 19:08:16 CEST 2017 -->
 <title>Constant Field Values</title>
 <meta name="date" content="2017-09-25">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

diff --git a/docs/javadoc/deprecated-list.html b/docs/javadoc/deprecated-list.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (1.8.0_144) on Mon Sep 25 18:13:30 CEST 2017 -->
+<!-- Generated by javadoc (1.8.0_144) on Mon Sep 25 19:08:16 CEST 2017 -->
 <title>Deprecated List</title>
 <meta name="date" content="2017-09-25">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

diff --git a/docs/javadoc/help-doc.html b/docs/javadoc/help-doc.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (1.8.0_144) on Mon Sep 25 18:13:30 CEST 2017 -->
+<!-- Generated by javadoc (1.8.0_144) on Mon Sep 25 19:08:16 CEST 2017 -->
 <title>API Help</title>
 <meta name="date" content="2017-09-25">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

diff --git a/docs/javadoc/index-all.html b/docs/javadoc/index-all.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (1.8.0_144) on Mon Sep 25 18:13:30 CEST 2017 -->
+<!-- Generated by javadoc (1.8.0_144) on Mon Sep 25 19:08:16 CEST 2017 -->
 <title>Index</title>
 <meta name="date" content="2017-09-25">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -67,19 +67,27 @@
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
-<div class="contentContainer"><a href="#I:A">A</a>&nbsp;<a href="#I:B">B</a>&nbsp;<a href="#I:C">C</a>&nbsp;<a href="#I:E">E</a>&nbsp;<a href="#I:G">G</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:P">P</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a href="#I:S">S</a>&nbsp;<a name="I:A">
+<div class="contentContainer"><a href="#I:A">A</a>&nbsp;<a href="#I:B">B</a>&nbsp;<a href="#I:C">C</a>&nbsp;<a href="#I:G">G</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:P">P</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a href="#I:S">S</a>&nbsp;<a name="I:A">
 <!--   -->
 </a>
 <h2 class="title">A</h2>
 <dl>
 <dt><span class="memberNameLink"><a href="BBjGridExWidget.html#addColumn-BBjString-">addColumn(BBjString)</a></span> - Method in class <a href="BBjGridExWidget.html" title="class in &lt;Unnamed&gt;">BBjGridExWidget</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">add a column to the grid</div>
+</dd>
 <dt><span class="memberNameLink"><a href="BBjGridExWidget.html#addColumn-BBjString-BBjString-">addColumn(BBjString, BBjString)</a></span> - Method in class <a href="BBjGridExWidget.html" title="class in &lt;Unnamed&gt;">BBjGridExWidget</a></dt>
-<dd>&nbsp;</dd>
-<dt><span class="memberNameLink"><a href="BBjGridExWidget.html#addColumn-BBjString-BBjString-BBjInt-">addColumn(BBjString, BBjString, BBjInt)</a></span> - Method in class <a href="BBjGridExWidget.html" title="class in &lt;Unnamed&gt;">BBjGridExWidget</a></dt>
-<dd>&nbsp;</dd>
-<dt><span class="memberNameLink"><a href="BBjGridExWidget.html#addColumn-BBjString-BBjString-BBjInt-BBjInt-">addColumn(BBjString, BBjString, BBjInt, BBjInt)</a></span> - Method in class <a href="BBjGridExWidget.html" title="class in &lt;Unnamed&gt;">BBjGridExWidget</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">add a column to the grid</div>
+</dd>
+<dt><span class="memberNameLink"><a href="BBjGridExWidget.html#addColumn-BBjString-BBjString-BBjNumber-">addColumn(BBjString, BBjString, BBjNumber)</a></span> - Method in class <a href="BBjGridExWidget.html" title="class in &lt;Unnamed&gt;">BBjGridExWidget</a></dt>
+<dd>
+<div class="block">add a column to the grid</div>
+</dd>
+<dt><span class="memberNameLink"><a href="BBjGridExWidget.html#addColumn-BBjString-BBjString-BBjNumber-BBjNumber-">addColumn(BBjString, BBjString, BBjNumber, BBjNumber)</a></span> - Method in class <a href="BBjGridExWidget.html" title="class in &lt;Unnamed&gt;">BBjGridExWidget</a></dt>
+<dd>
+<div class="block">add a column to the grid</div>
+</dd>
 </dl>
 <a name="I:B">
 <!--   -->
@@ -101,15 +109,9 @@ <h2 class="title">B</h2>
 <h2 class="title">C</h2>
 <dl>
 <dt><span class="memberNameLink"><a href="BBjGridExWidget.html#clearColumnDefinitions--">clearColumnDefinitions()</a></span> - Method in class <a href="BBjGridExWidget.html" title="class in &lt;Unnamed&gt;">BBjGridExWidget</a></dt>
-<dd>&nbsp;</dd>
-</dl>
-<a name="I:E">
-<!--   -->
-</a>
-<h2 class="title">E</h2>
-<dl>
-<dt><span class="memberNameLink"><a href="BBjGridExWidget.html#executeScript-BBjString-">executeScript(BBjString)</a></span> - Method in class <a href="BBjGridExWidget.html" title="class in &lt;Unnamed&gt;">BBjGridExWidget</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">clear all columns</div>
+</dd>
 </dl>
 <a name="I:G">
 <!--   -->
@@ -122,6 +124,8 @@ <h2 class="title">G</h2>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="BBjGridExWidget.html#GRID_ALIGN_RIGHT--">GRID_ALIGN_RIGHT()</a></span> - Static method in class <a href="BBjGridExWidget.html" title="class in &lt;Unnamed&gt;">BBjGridExWidget</a></dt>
 <dd>&nbsp;</dd>
+<dt><span class="memberNameLink"><a href="BBjGridExWidget.html#GRID_SELECT_CELL--">GRID_SELECT_CELL()</a></span> - Static method in class <a href="BBjGridExWidget.html" title="class in &lt;Unnamed&gt;">BBjGridExWidget</a></dt>
+<dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="BBjGridExWidget.html#GRID_SELECT_ROW--">GRID_SELECT_ROW()</a></span> - Static method in class <a href="BBjGridExWidget.html" title="class in &lt;Unnamed&gt;">BBjGridExWidget</a></dt>
 <dd>&nbsp;</dd>
 </dl>
@@ -133,19 +137,25 @@ <h2 class="title">O</h2>
 <dt><span class="memberNameLink"><a href="BBjGridExWidget.html#ON_GRID_SELECT_ROW--">ON_GRID_SELECT_ROW()</a></span> - Static method in class <a href="BBjGridExWidget.html" title="class in &lt;Unnamed&gt;">BBjGridExWidget</a></dt>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="BBjGridExWidget.html#onLoad-BBjEvent-">onLoad(BBjEvent)</a></span> - Method in class <a href="BBjGridExWidget.html" title="class in &lt;Unnamed&gt;">BBjGridExWidget</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">callback method after initial load
+does last initialization work</div>
+</dd>
 <dt><span class="memberNameLink"><a href="BBjGridExWidget.html#onNativeEvent-BBjNativeJavaScriptEvent-">onNativeEvent(BBjNativeJavaScriptEvent)</a></span> - Method in class <a href="BBjGridExWidget.html" title="class in &lt;Unnamed&gt;">BBjGridExWidget</a></dt>
-<dd>&nbsp;</dd>
-<dt><span class="memberNameLink"><a href="BBjGridExWidget.html#onPopupRequest-BBjPopupRequestEvent-">onPopupRequest(BBjPopupRequestEvent)</a></span> - Method in class <a href="BBjGridExWidget.html" title="class in &lt;Unnamed&gt;">BBjGridExWidget</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Event Handler for Native JavaScript Event (from the Grid)
+Determines and dispatches the actual event</div>
+</dd>
 </dl>
 <a name="I:P">
 <!--   -->
 </a>
 <h2 class="title">P</h2>
 <dl>
 <dt><span class="memberNameLink"><a href="BBjGridExWidget.html#pinColumn-BBjString-BBjString-">pinColumn(BBjString, BBjString)</a></span> - Method in class <a href="BBjGridExWidget.html" title="class in &lt;Unnamed&gt;">BBjGridExWidget</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">pin a column of the grid to the left or the right margin</div>
+</dd>
 </dl>
 <a name="I:R">
 <!--   -->
@@ -161,29 +171,52 @@ <h2 class="title">R</h2>
 <h2 class="title">S</h2>
 <dl>
 <dt><span class="memberNameLink"><a href="BBjGridExWidget.html#setColumnAlignment-BBjString-BBjNumber-">setColumnAlignment(BBjString, BBjNumber)</a></span> - Method in class <a href="BBjGridExWidget.html" title="class in &lt;Unnamed&gt;">BBjGridExWidget</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">set the alignment of a column</div>
+</dd>
 <dt><span class="memberNameLink"><a href="BBjGridExWidget.html#setColumnBackColor-BBjString-BBjColor-">setColumnBackColor(BBjString, BBjColor)</a></span> - Method in class <a href="BBjGridExWidget.html" title="class in &lt;Unnamed&gt;">BBjGridExWidget</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">set the background color of a column</div>
+</dd>
 <dt><span class="memberNameLink"><a href="BBjGridExWidget.html#setColumnForeColor-BBjString-BBjColor-">setColumnForeColor(BBjString, BBjColor)</a></span> - Method in class <a href="BBjGridExWidget.html" title="class in &lt;Unnamed&gt;">BBjGridExWidget</a></dt>
-<dd>&nbsp;</dd>
-<dt><span class="memberNameLink"><a href="BBjGridExWidget.html#setColumnWidth-BBjString-BBjInt-">setColumnWidth(BBjString, BBjInt)</a></span> - Method in class <a href="BBjGridExWidget.html" title="class in &lt;Unnamed&gt;">BBjGridExWidget</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">set the font color of a column</div>
+</dd>
+<dt><span class="memberNameLink"><a href="BBjGridExWidget.html#setColumnWidth-BBjString-BBjNumber-">setColumnWidth(BBjString, BBjNumber)</a></span> - Method in class <a href="BBjGridExWidget.html" title="class in &lt;Unnamed&gt;">BBjGridExWidget</a></dt>
+<dd>
+<div class="block">set the width of a column</div>
+</dd>
 <dt><span class="memberNameLink"><a href="BBjGridExWidget.html#setData-ResultSet-">setData(ResultSet)</a></span> - Method in class <a href="BBjGridExWidget.html" title="class in &lt;Unnamed&gt;">BBjGridExWidget</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">set the data into the grid</div>
+</dd>
 <dt><span class="memberNameLink"><a href="BBjGridExWidget.html#setData-DataTree-">setData(DataTree)</a></span> - Method in class <a href="BBjGridExWidget.html" title="class in &lt;Unnamed&gt;">BBjGridExWidget</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">set the data into the grid, to create a tree grid</div>
+</dd>
 <dt><span class="memberNameLink"><a href="BBjGridExWidget.html#setEnableFilter-BBjNumber-">setEnableFilter(BBjNumber)</a></span> - Method in class <a href="BBjGridExWidget.html" title="class in &lt;Unnamed&gt;">BBjGridExWidget</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Allow filters in the grid</div>
+</dd>
 <dt><span class="memberNameLink"><a href="BBjGridExWidget.html#setFitToGrid-BBjNumber-">setFitToGrid(BBjNumber)</a></span> - Method in class <a href="BBjGridExWidget.html" title="class in &lt;Unnamed&gt;">BBjGridExWidget</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">set the grid to scroll horizontally or fit into the client area</div>
+</dd>
 <dt><span class="memberNameLink"><a href="BBjGridExWidget.html#setMultipleSelection-BBjNumber-">setMultipleSelection(BBjNumber)</a></span> - Method in class <a href="BBjGridExWidget.html" title="class in &lt;Unnamed&gt;">BBjGridExWidget</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Allow selection of multiple cells or rows</div>
+</dd>
 <dt><span class="memberNameLink"><a href="BBjGridExWidget.html#setSelectionMode-BBjNumber-">setSelectionMode(BBjNumber)</a></span> - Method in class <a href="BBjGridExWidget.html" title="class in &lt;Unnamed&gt;">BBjGridExWidget</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">set the selection mode of the grid</div>
+</dd>
 <dt><span class="memberNameLink"><a href="BBjGridExWidget.html#showDeveloperConsole--">showDeveloperConsole()</a></span> - Method in class <a href="BBjGridExWidget.html" title="class in &lt;Unnamed&gt;">BBjGridExWidget</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">experimental function that shows the developer console
+(only in GUI, for BUI it's a NOOP)</div>
+</dd>
 </dl>
-<a href="#I:A">A</a>&nbsp;<a href="#I:B">B</a>&nbsp;<a href="#I:C">C</a>&nbsp;<a href="#I:E">E</a>&nbsp;<a href="#I:G">G</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:P">P</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a href="#I:S">S</a>&nbsp;</div>
+<a href="#I:A">A</a>&nbsp;<a href="#I:B">B</a>&nbsp;<a href="#I:C">C</a>&nbsp;<a href="#I:G">G</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:P">P</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a href="#I:S">S</a>&nbsp;</div>
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a name="navbar.bottom">
 <!--   -->

diff --git a/docs/javadoc/index.html b/docs/javadoc/index.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (1.8.0_144) on Mon Sep 25 18:13:30 CEST 2017 -->
+<!-- Generated by javadoc (1.8.0_144) on Mon Sep 25 19:08:16 CEST 2017 -->
 <title>Generated Documentation (Untitled)</title>
 <script type="text/javascript">
     tmpTargetPage = "" + window.location.search;

diff --git a/docs/javadoc/overview-tree.html b/docs/javadoc/overview-tree.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (1.8.0_144) on Mon Sep 25 18:13:30 CEST 2017 -->
+<!-- Generated by javadoc (1.8.0_144) on Mon Sep 25 19:08:16 CEST 2017 -->
 <title>Class Hierarchy</title>
 <meta name="date" content="2017-09-25">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

diff --git a/docs/javadoc/package-frame.html b/docs/javadoc/package-frame.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (1.8.0_144) on Mon Sep 25 18:13:30 CEST 2017 -->
+<!-- Generated by javadoc (1.8.0_144) on Mon Sep 25 19:08:16 CEST 2017 -->
 <title>&lt;Unnamed&gt;</title>
 <meta name="date" content="2017-09-25">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

diff --git a/docs/javadoc/package-summary.html b/docs/javadoc/package-summary.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (1.8.0_144) on Mon Sep 25 18:13:30 CEST 2017 -->
+<!-- Generated by javadoc (1.8.0_144) on Mon Sep 25 19:08:16 CEST 2017 -->
 <meta name="date" content="2017-09-25">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>

diff --git a/docs/javadoc/package-tree.html b/docs/javadoc/package-tree.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (1.8.0_144) on Mon Sep 25 18:13:30 CEST 2017 -->
+<!-- Generated by javadoc (1.8.0_144) on Mon Sep 25 19:08:16 CEST 2017 -->
 <title> Class Hierarchy</title>
 <meta name="date" content="2017-09-25">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">