Major changes to the Rico 3 server control for SimpleGrids - much improved control...
[infodrom/rico3] / documentation / LiveGrid.html
index ccc411f..73603ea 100644 (file)
@@ -706,21 +706,20 @@ any filter that is found.  Filter parameters must be of the form "f[x]=" where x
 <dd>Allow columns to be resized by the user? If true, then resizing for individual columns \r
 can be disabled using <a href='#noResize'>noResize</a> in columnSpecs[].\r
 \r
-<dt>panels\r
+<dt>ColGroups\r
 <dd>An array of strings that can serve as secondary headings.\r
 In LiveGrid Forms, they also serve as the headings for the tabbed panels on the input form.\r
 \r
-<dt>PanelNamesOnTabHdr\r
-<dd>Set to 'true' for the strings in panels[] to be used as secondary headings.\r
-In LiveGrid Forms, it may be set to 'false' so that panels[] is only used on the input form.\r
+<dt>ColGroupsOnTabHdr\r
+<dd>Set to 'true' for the strings in ColGroups[] to be used as secondary headings.\r
+In LiveGrid Forms, it may be set to 'false' so that ColGroups[] is only used on the input form.\r
 \r
-<dt><a name='FilterLocation'>FilterLocation</a>\r
-<dd>Specifies the heading row where filters should be placed.\r
--1 causes a new row to be appended to the header and that new row used for filtering.\r
-See also the <a href='#filterUI'>filterUI</a> option.\r
+<dt><a name='AutoFilter'>AutoFilter</a>\r
+<dd>If enabled, an additional row is added to the grid header where column filters are placed.\r
+See the <a href='#filterUI'>filterUI</a> option to customize each column's filter.\r
 \r
 <dt>FilterAllToken\r
-<dd>Token in select filters used to indicate "show all values" (default: "___ALL___").\r
+<dd>The token in select filters used to indicate "show all values" (default: "___ALL___").\r
 </dl>\r
 \r
 <h4>Cookie options</h4>\r
@@ -831,9 +830,9 @@ This only needs to be specified if the web page uses multiple distinct zones.
 <dd>A string that specifies when the grid's menu should be invoked\r
   <ul>\r
   <li>'click' -- invoke menu on single-click\r
-  <li>'dblclick' -- invoke menu on double-click (default)\r
+  <li>'dblclick' -- invoke menu on double-click\r
   <li>'contextmenu' -- invoke menu on right-click\r
-  <li>'none' -- no pop-up menu\r
+  <li>'none' -- no pop-up menu (default)\r
   </ul>\r
 \r
 <dt>windowResize\r
@@ -1116,24 +1115,20 @@ MyCustomColumn.prototype = {
 </pre>\r
 \r
 <dt><a name='filterUI'></a>filterUI\r
-<dd>If a <a href='#FilterLocation'>FilterLocation</a> option is specified for the grid, then filterUI will control\r
+<dd>If the <a href='#AutoFilter'>AutoFilter</a> option is enabled for the grid, then filterUI will control\r
 how each column is filtered. If filterUI is:\r
 <ul>\r
 <li>null or omitted, then no filter is displayed for the column.\r
 <li>'t' - will generate a text box filter and the records being displayed\r
 are filtered as the user types. \r
-<br>May optionally be followed by a caret (^) to\r
-indicate that text box values should match the beginning of the column value.\r
-Otherwise, they can match anywhere in the column's value.\r
-<br>May also be followed by a number to indicate the size of the text box (default size is 10).\r
+<br>May be followed by a number to indicate the size of the text box (default size is 10).\r
 <pre>\r
-filterUI:'t^20' \r
+filterUI:'t20' \r
 // will create a text box that is 20 characters wide\r
-// text typed into the box will be compared to\r
-//    the beginning of each column value\r
 </pre>\r
 <li>'s' - will generate a select list filter with all possible column values contained in the list.\r
 Populated using a 'select distinct' query if the grid's source is a SQL query.\r
+<li>'m' - will generate multi-select checklist filter, with a checkbox text to each item.\r
 </ul>\r
 \r
 <dt></a>filterCol\r