Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Stephan Wald committed Feb 16, 2018
1 parent ef0fb16 commit 6409352
Show file tree
Hide file tree
Showing 16 changed files with 951 additions and 90 deletions.
141 changes: 98 additions & 43 deletions docs/javadoc/BBjGridExWidget.html
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_144) on Mon Jan 29 12:59:35 CET 2018 -->
<!-- Generated by javadoc (1.8.0_144) on Fri Feb 16 19:10:21 CET 2018 -->
<title>BBjGridExWidget</title>
<meta name="date" content="2018-01-29">
<meta name="date" content="2018-02-16">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand All @@ -18,7 +18,7 @@
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":9,"i15":9,"i16":9,"i17":9,"i18":9,"i19":9,"i20":9,"i21":9,"i22":10,"i23":9,"i24":9,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10};
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":9,"i15":9,"i16":9,"i17":9,"i18":9,"i19":9,"i20":9,"i21":9,"i22":10,"i23":9,"i24":9,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
Expand Down Expand Up @@ -218,7 +218,7 @@ <h3>Method Summary</h3>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="BBjGridExWidgetColumnState.html" title="class in &lt;Unnamed&gt;">BBjGridExWidgetColumnState</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="BBjGridExWidget.html#getColumnsState--">getColumnsState</a></span>()</code>&nbsp;</td>
<td class="colLast"><code><span class="memberNameLink"><a href="BBjGridExWidget.html#getColumnState--">getColumnState</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>BBjString</code></td>
Expand All @@ -227,7 +227,7 @@ <h3>Method Summary</h3>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>BBjNumber</code></td>
<td class="colFirst"><code><a href="BBjGridExWidgetRow.html" title="class in &lt;Unnamed&gt;">BBjGridExWidgetRow</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="BBjGridExWidget.html#getSelectedRow--">getSelectedRow</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
Expand Down Expand Up @@ -343,7 +343,7 @@ <h3>Method Summary</h3>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="BBjGridExWidget.html#setColumnsState-BBjGridExWidgetColumnState-">setColumnsState</a></span>(<a href="BBjGridExWidgetColumnState.html" title="class in &lt;Unnamed&gt;">BBjGridExWidgetColumnState</a>&nbsp;state!)</code>&nbsp;</td>
<td class="colLast"><code><span class="memberNameLink"><a href="BBjGridExWidget.html#setColumnState-BBjGridExWidgetColumnState-">setColumnState</a></span>(<a href="BBjGridExWidgetColumnState.html" title="class in &lt;Unnamed&gt;">BBjGridExWidgetColumnState</a>&nbsp;state!)</code>&nbsp;</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>void</code></td>
Expand All @@ -360,104 +360,122 @@ <h3>Method Summary</h3>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="BBjGridExWidget.html#setData-DataTree-BBjString-">setData</a></span>(DataTree&nbsp;rs!,
BBjString&nbsp;RowNodeId$)</code>&nbsp;</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="BBjGridExWidget.html#setData-DataTree-BBjString-BBjString-">setData</a></span>(DataTree&nbsp;rs!,
BBjString&nbsp;RowNodeId$,
BBjString&nbsp;ParentNodeId$)</code>&nbsp;</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="BBjGridExWidget.html#setData-ResultSet-">setData</a></span>(ResultSet&nbsp;rs!)</code>
<div class="block">set the data into the grid</div>
</td>
</tr>
<tr id="i38" class="altColor">
<tr id="i40" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="BBjGridExWidget.html#setData-ResultSet-BBjString-">setData</a></span>(ResultSet&nbsp;rs!,
BBjString&nbsp;RowNodeId$)</code>
<div class="block">set the data into the grid</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="BBjGridExWidget.html#setEnableFilter-BBjNumber-">setEnableFilter</a></span>(BBjNumber&nbsp;enable)</code>
<div class="block">Allow filters in the grid</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<tr id="i42" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="BBjGridExWidget.html#setEnableFloatingFilter-BBjNumber-">setEnableFloatingFilter</a></span>(BBjNumber&nbsp;enable)</code>
<div class="block">Allow floating filters in the grid</div>
</td>
</tr>
<tr id="i40" class="altColor">
<tr id="i43" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="BBjGridExWidget.html#setFitToGrid-BBjNumber-">setFitToGrid</a></span>(BBjNumber&nbsp;fit!)</code>
<div class="block">set the grid to scroll horizontally or fit into the client area</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<tr id="i44" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="BBjGridExWidget.html#setGroupColumnLabel-BBjString-">setGroupColumnLabel</a></span>(BBjString&nbsp;label$)</code>
<div class="block">set the label for the group column if the grid is a tree-grid
defaults to "Group"</div>
</td>
</tr>
<tr id="i42" class="altColor">
<tr id="i45" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="BBjGridExWidget.html#setGroupSelectsChildren-BBjNumber-">setGroupSelectsChildren</a></span>(BBjNumber&nbsp;x!)</code>
<div class="block">When true, selecting a group will have the impact of selecting all its children
When false, then the group is selectable independently of the child nodes</div>
</td>
</tr>
<tr id="i43" class="rowColor">
<tr id="i46" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="BBjGridExWidget.html#setMultipleSelection-BBjNumber-">setMultipleSelection</a></span>(BBjNumber&nbsp;multiple)</code>
<div class="block">Allow selection of multiple cells or rows</div>
</td>
</tr>
<tr id="i44" class="altColor">
<tr id="i47" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="BBjGridExWidget.html#setQuickFilter-BBjNumber-">setQuickFilter</a></span>(BBjNumber&nbsp;filter)</code>
<div class="block">Perform throw columns search</div>
</td>
</tr>
<tr id="i45" class="rowColor">
<tr id="i48" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="BBjGridExWidget.html#setQuickFilter-BBjString-">setQuickFilter</a></span>(BBjString&nbsp;filter!)</code>
<div class="block">Perform throw columns search</div>
</td>
</tr>
<tr id="i46" class="altColor">
<tr id="i49" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="BBjGridExWidget.html#setSelectedRow-BBjNumber-">setSelectedRow</a></span>(BBjNumber&nbsp;x!)</code>
<div class="block">set the selected row</div>
</td>
</tr>
<tr id="i47" class="rowColor">
<tr id="i50" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="BBjGridExWidget.html#setSelectedRows-BBjVector-">setSelectedRows</a></span>(BBjVector&nbsp;x!)</code>
<div class="block">set the selected row indices</div>
</td>
</tr>
<tr id="i48" class="altColor">
<tr id="i51" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="BBjGridExWidget.html#setSelectionMode-BBjNumber-">setSelectionMode</a></span>(BBjNumber&nbsp;mode)</code>
<div class="block">set the selection mode of the grid</div>
</td>
</tr>
<tr id="i49" class="rowColor">
<tr id="i52" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="BBjGridExWidget.html#setShowGroupChildCount-BBjNumber-">setShowGroupChildCount</a></span>(BBjNumber&nbsp;status!)</code>
<div class="block">Optinally Suppress the number of items in a group</div>
</td>
</tr>
<tr id="i50" class="altColor">
<tr id="i53" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="BBjGridExWidget.html#setShowSelectionCheckbox-BBjNumber-">setShowSelectionCheckbox</a></span>(BBjNumber&nbsp;x!)</code>
<div class="block">When true, selection box will be show on the first column
When false, no checkbox will be displayed</div>
</td>
</tr>
<tr id="i51" class="rowColor">
<tr id="i54" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="BBjGridExWidget.html#setTheme-BBjString-">setTheme</a></span>(BBjString&nbsp;theme$)</code>&nbsp;</td>
</tr>
<tr id="i52" class="altColor">
<tr id="i55" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="BBjGridExWidget.html#setVisibleColumn-BBjString-">setVisibleColumn</a></span>(BBjString&nbsp;columnId!)</code>
<div class="block">set visible column

Ensures the column is visible, scrolling the table if needed.</div>
</td>
</tr>
<tr id="i53" class="rowColor">
<tr id="i56" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="BBjGridExWidget.html#setVisibleRow-BBjNumber-BBjString-">setVisibleRow</a></span>(BBjNumber&nbsp;index!,
BBjString&nbsp;position!)</code>
Expand All @@ -466,7 +484,7 @@ <h3>Method Summary</h3>
Ensures the row index is visible by vertically scrolling the grid.</div>
</td>
</tr>
<tr id="i54" class="altColor">
<tr id="i57" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="BBjGridExWidget.html#showDeveloperConsole--">showDeveloperConsole</a></span>()</code>
<div class="block">experimental function that shows the developer console
Expand Down Expand Up @@ -759,6 +777,22 @@ <h4>setData</h4>
</dl>
</li>
</ul>
<a name="setData-ResultSet-BBjString-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setData</h4>
<pre>public&nbsp;void&nbsp;setData(ResultSet&nbsp;rs!,
BBjString&nbsp;RowNodeId$)</pre>
<div class="block">set the data into the grid</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ResultSet:</code> - the com.basiscomponents.db.ResultSet with the data</dd>
<dd><code>BBjString:</code> - field used to generate id</dd>
</dl>
</li>
</ul>
<a name="setData-DataTree-">
<!-- -->
</a>
Expand All @@ -776,6 +810,27 @@ <h4>setData</h4>
</dl>
</li>
</ul>
<a name="setData-DataTree-BBjString-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setData</h4>
<pre>public&nbsp;void&nbsp;setData(DataTree&nbsp;rs!,
BBjString&nbsp;RowNodeId$)</pre>
</li>
</ul>
<a name="setData-DataTree-BBjString-BBjString-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setData</h4>
<pre>public&nbsp;void&nbsp;setData(DataTree&nbsp;rs!,
BBjString&nbsp;RowNodeId$,
BBjString&nbsp;ParentNodeId$)</pre>
</li>
</ul>
<a name="clearColumnDefinitions--">
<!-- -->
</a>
Expand Down Expand Up @@ -1080,22 +1135,22 @@ <h4>getGroupColumnLabel</h4>
<div class="block">get the label for the group column if the grid is a tree-grid</div>
</li>
</ul>
<a name="getColumnsState--">
<a name="getColumnState--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColumnsState</h4>
<pre>public&nbsp;<a href="BBjGridExWidgetColumnState.html" title="class in &lt;Unnamed&gt;">BBjGridExWidgetColumnState</a>&nbsp;getColumnsState()</pre>
<h4>getColumnState</h4>
<pre>public&nbsp;<a href="BBjGridExWidgetColumnState.html" title="class in &lt;Unnamed&gt;">BBjGridExWidgetColumnState</a>&nbsp;getColumnState()</pre>
</li>
</ul>
<a name="setColumnsState-BBjGridExWidgetColumnState-">
<a name="setColumnState-BBjGridExWidgetColumnState-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setColumnsState</h4>
<pre>public&nbsp;void&nbsp;setColumnsState(<a href="BBjGridExWidgetColumnState.html" title="class in &lt;Unnamed&gt;">BBjGridExWidgetColumnState</a>&nbsp;state!)</pre>
<h4>setColumnState</h4>
<pre>public&nbsp;void&nbsp;setColumnState(<a href="BBjGridExWidgetColumnState.html" title="class in &lt;Unnamed&gt;">BBjGridExWidgetColumnState</a>&nbsp;state!)</pre>
</li>
</ul>
<a name="getSelectedRows--">
Expand All @@ -1107,39 +1162,39 @@ <h4>getSelectedRows</h4>
<pre>public&nbsp;BBjVector&nbsp;getSelectedRows()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>BBjVector with the selected row indexes</dd>
<dd>Hashmap with the selected row indexes and items</dd>
</dl>
</li>
</ul>
<a name="setTheme-BBjString-">
<a name="getSelectedRow--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTheme</h4>
<pre>public&nbsp;void&nbsp;setTheme(BBjString&nbsp;theme$)</pre>
<h4>getSelectedRow</h4>
<pre>public&nbsp;<a href="BBjGridExWidgetRow.html" title="class in &lt;Unnamed&gt;">BBjGridExWidgetRow</a>&nbsp;getSelectedRow()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the selected row</dd>
</dl>
</li>
</ul>
<a name="getThemes--">
<a name="setTheme-BBjString-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getThemes</h4>
<pre>public&nbsp;BBjVector&nbsp;getThemes()</pre>
<h4>setTheme</h4>
<pre>public&nbsp;void&nbsp;setTheme(BBjString&nbsp;theme$)</pre>
</li>
</ul>
<a name="getSelectedRow--">
<a name="getThemes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSelectedRow</h4>
<pre>public&nbsp;BBjNumber&nbsp;getSelectedRow()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the selected row index</dd>
</dl>
<h4>getThemes</h4>
<pre>public&nbsp;BBjVector&nbsp;getThemes()</pre>
</li>
</ul>
<a name="GRID_ALIGN_LEFT--">
Expand Down
8 changes: 4 additions & 4 deletions docs/javadoc/BBjGridExWidgetColumnState.html
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_144) on Mon Jan 29 12:59:35 CET 2018 -->
<!-- Generated by javadoc (1.8.0_144) on Fri Feb 16 19:10:21 CET 2018 -->
<title>BBjGridExWidgetColumnState</title>
<meta name="date" content="2018-01-29">
<meta name="date" content="2018-02-16">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand Down Expand Up @@ -42,7 +42,7 @@
<div class="subNav">
<ul class="navList">
<li><a href="BBjGridExWidget.html" title="class in &lt;Unnamed&gt;"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="BBjGridExWidgetRowDoubleClickEvent.html" title="class in &lt;Unnamed&gt;"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
<li><a href="BBjGridExWidgetDoubleClickRowEvent.html" title="class in &lt;Unnamed&gt;"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="index.html?BBjGridExWidgetColumnState.html" target="_top">Frames</a></li>
Expand Down Expand Up @@ -224,7 +224,7 @@ <h4>BBjGridExWidgetColumnState</h4>
<div class="subNav">
<ul class="navList">
<li><a href="BBjGridExWidget.html" title="class in &lt;Unnamed&gt;"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="BBjGridExWidgetRowDoubleClickEvent.html" title="class in &lt;Unnamed&gt;"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
<li><a href="BBjGridExWidgetDoubleClickRowEvent.html" title="class in &lt;Unnamed&gt;"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="index.html?BBjGridExWidgetColumnState.html" target="_top">Frames</a></li>
Expand Down

0 comments on commit 6409352

Please sign in to comment.