Permalink
Browse files

update docs

  • Loading branch information...
1 parent 6bcdd67 commit 66a84eb32cf7de748089c121768686c38fff9751 @kflorence committed Oct 13, 2010
View
16 doc/files.html
@@ -196,22 +196,26 @@
<li><a href="symbols/jQuery.tabulate.event_handlers.html">jQuery.tabulate.event_handlers</a></li>
- <li><a href="symbols/jQuery.tabulate.options.html">jQuery.tabulate.options</a></li>
-
- <li><a href="symbols/jQuery.tabulate.options.%24elements.html">jQuery.tabulate.options.$elements</a></li>
+ <li><a href="symbols/jQuery.tabulate.filters.html">jQuery.tabulate.filters</a></li>
- <li><a href="symbols/jQuery.tabulate.options.%24fragments.html">jQuery.tabulate.options.$fragments</a></li>
+ <li><a href="symbols/jQuery.tabulate.options.html">jQuery.tabulate.options</a></li>
<li><a href="symbols/jQuery.tabulate.options.data.html">jQuery.tabulate.options.data</a></li>
<li><a href="symbols/jQuery.tabulate.options.data.filters.html">jQuery.tabulate.options.data.filters</a></li>
<li><a href="symbols/jQuery.tabulate.options.data.source.html">jQuery.tabulate.options.data.source</a></li>
+ <li><a href="symbols/jQuery.tabulate.options.elements.html">jQuery.tabulate.options.elements</a></li>
+
+ <li><a href="symbols/jQuery.tabulate.options.fragments.html">jQuery.tabulate.options.fragments</a></li>
+
<li><a href="symbols/jQuery.tabulate.options.keys.html">jQuery.tabulate.options.keys</a></li>
<li><a href="symbols/jQuery.tabulate.options.paths.html">jQuery.tabulate.options.paths</a></li>
+ <li><a href="symbols/jQuery.tabulate.options.paths.images.html">jQuery.tabulate.options.paths.images</a></li>
+
<li><a href="symbols/jQuery.tabulate.options.table.html">jQuery.tabulate.options.table</a></li>
<li><a href="symbols/tabulate.html">tabulate</a></li>
@@ -235,7 +239,7 @@ <h1 class="classTitle">File Index</h1>
<dt class="heading">Version:</dt>
- <dd>1.0.20100610</dd>
+ <dd>2.2.20101008</dd>
@@ -247,7 +251,7 @@ <h1 class="classTitle">File Index</h1>
</div>
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.3.2 on Thu Sep 16 2010 17:15:10 GMT-0700 (PDT)
+ Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.3.2 on Tue Oct 12 2010 18:14:07 GMT-0700 (PDT)
</div>
</body>
</html>
View
48 doc/index.html
@@ -196,22 +196,26 @@
<li><a href="symbols/jQuery.tabulate.event_handlers.html">jQuery.tabulate.event_handlers</a></li>
- <li><a href="symbols/jQuery.tabulate.options.html">jQuery.tabulate.options</a></li>
-
- <li><a href="symbols/jQuery.tabulate.options.%24elements.html">jQuery.tabulate.options.$elements</a></li>
+ <li><a href="symbols/jQuery.tabulate.filters.html">jQuery.tabulate.filters</a></li>
- <li><a href="symbols/jQuery.tabulate.options.%24fragments.html">jQuery.tabulate.options.$fragments</a></li>
+ <li><a href="symbols/jQuery.tabulate.options.html">jQuery.tabulate.options</a></li>
<li><a href="symbols/jQuery.tabulate.options.data.html">jQuery.tabulate.options.data</a></li>
<li><a href="symbols/jQuery.tabulate.options.data.filters.html">jQuery.tabulate.options.data.filters</a></li>
<li><a href="symbols/jQuery.tabulate.options.data.source.html">jQuery.tabulate.options.data.source</a></li>
+ <li><a href="symbols/jQuery.tabulate.options.elements.html">jQuery.tabulate.options.elements</a></li>
+
+ <li><a href="symbols/jQuery.tabulate.options.fragments.html">jQuery.tabulate.options.fragments</a></li>
+
<li><a href="symbols/jQuery.tabulate.options.keys.html">jQuery.tabulate.options.keys</a></li>
<li><a href="symbols/jQuery.tabulate.options.paths.html">jQuery.tabulate.options.paths</a></li>
+ <li><a href="symbols/jQuery.tabulate.options.paths.images.html">jQuery.tabulate.options.paths.images</a></li>
+
<li><a href="symbols/jQuery.tabulate.options.table.html">jQuery.tabulate.options.table</a></li>
<li><a href="symbols/tabulate.html">tabulate</a></li>
@@ -261,38 +265,44 @@ <h1 class="classTitle">Class Index</h1>
<hr />
<div>
+ <h2><a href="symbols/jQuery.tabulate.filters.html">jQuery.tabulate.filters</a></h2>
+ Contains filters to apply to the data set.
+ </div>
+ <hr />
+
+ <div>
<h2><a href="symbols/jQuery.tabulate.options.html">jQuery.tabulate.options</a></h2>
Holds the default options for <a href="symbols/jQuery.tabulate.html">jQuery.tabulate</a>
</div>
<hr />
<div>
- <h2><a href="symbols/jQuery.tabulate.options.%24elements.html">jQuery.tabulate.options.$elements</a></h2>
- Holds all of our jQuery objects
+ <h2><a href="symbols/jQuery.tabulate.options.data.html">jQuery.tabulate.options.data</a></h2>
+ Holds JSON data or AJAX request settings.
</div>
<hr />
<div>
- <h2><a href="symbols/jQuery.tabulate.options.%24fragments.html">jQuery.tabulate.options.$fragments</a></h2>
- Holds all of our jQuery object fragments
+ <h2><a href="symbols/jQuery.tabulate.options.data.filters.html">jQuery.tabulate.options.data.filters</a></h2>
+ Contains filters to apply to the data set.
</div>
<hr />
<div>
- <h2><a href="symbols/jQuery.tabulate.options.data.html">jQuery.tabulate.options.data</a></h2>
- Holds JSON data or AJAX request settings.
+ <h2><a href="symbols/jQuery.tabulate.options.data.source.html">jQuery.tabulate.options.data.source</a></h2>
+ Holds information about the source of our data.
</div>
<hr />
<div>
- <h2><a href="symbols/jQuery.tabulate.options.data.filters.html">jQuery.tabulate.options.data.filters</a></h2>
- Contains the filters to apply to the data set.
+ <h2><a href="symbols/jQuery.tabulate.options.elements.html">jQuery.tabulate.options.elements</a></h2>
+ Holds all of our jQuery objects
</div>
<hr />
<div>
- <h2><a href="symbols/jQuery.tabulate.options.data.source.html">jQuery.tabulate.options.data.source</a></h2>
- Holds information about the source of our data.
+ <h2><a href="symbols/jQuery.tabulate.options.fragments.html">jQuery.tabulate.options.fragments</a></h2>
+ Holds all of our jQuery object fragments
</div>
<hr />
@@ -309,8 +319,14 @@ <h1 class="classTitle">Class Index</h1>
<hr />
<div>
+ <h2><a href="symbols/jQuery.tabulate.options.paths.images.html">jQuery.tabulate.options.paths.images</a></h2>
+ The paths to images needed by tabulate.
+ </div>
+ <hr />
+
+ <div>
<h2><a href="symbols/jQuery.tabulate.options.table.html">jQuery.tabulate.options.table</a></h2>
- Contains table sections and filters
+
</div>
<hr />
@@ -324,7 +340,7 @@ <h1 class="classTitle">Class Index</h1>
</div>
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.3.2 on Thu Sep 16 2010 17:15:10 GMT-0700 (PDT)
+ Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.3.2 on Tue Oct 12 2010 18:14:07 GMT-0700 (PDT)
</div>
</body>
</html>
View
14 doc/symbols/_global_.html
@@ -201,22 +201,26 @@
<li><a href="../symbols/jQuery.tabulate.event_handlers.html">jQuery.tabulate.event_handlers</a></li>
- <li><a href="../symbols/jQuery.tabulate.options.html">jQuery.tabulate.options</a></li>
-
- <li><a href="../symbols/jQuery.tabulate.options.%24elements.html">jQuery.tabulate.options.$elements</a></li>
+ <li><a href="../symbols/jQuery.tabulate.filters.html">jQuery.tabulate.filters</a></li>
- <li><a href="../symbols/jQuery.tabulate.options.%24fragments.html">jQuery.tabulate.options.$fragments</a></li>
+ <li><a href="../symbols/jQuery.tabulate.options.html">jQuery.tabulate.options</a></li>
<li><a href="../symbols/jQuery.tabulate.options.data.html">jQuery.tabulate.options.data</a></li>
<li><a href="../symbols/jQuery.tabulate.options.data.filters.html">jQuery.tabulate.options.data.filters</a></li>
<li><a href="../symbols/jQuery.tabulate.options.data.source.html">jQuery.tabulate.options.data.source</a></li>
+ <li><a href="../symbols/jQuery.tabulate.options.elements.html">jQuery.tabulate.options.elements</a></li>
+
+ <li><a href="../symbols/jQuery.tabulate.options.fragments.html">jQuery.tabulate.options.fragments</a></li>
+
<li><a href="../symbols/jQuery.tabulate.options.keys.html">jQuery.tabulate.options.keys</a></li>
<li><a href="../symbols/jQuery.tabulate.options.paths.html">jQuery.tabulate.options.paths</a></li>
+ <li><a href="../symbols/jQuery.tabulate.options.paths.images.html">jQuery.tabulate.options.paths.images</a></li>
+
<li><a href="../symbols/jQuery.tabulate.options.table.html">jQuery.tabulate.options.table</a></li>
<li><a href="../symbols/tabulate.html">tabulate</a></li>
@@ -348,7 +352,7 @@ <h1 class="classTitle">
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Thu Sep 16 2010 17:15:10 GMT-0700 (PDT)
+ Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Tue Oct 12 2010 18:14:06 GMT-0700 (PDT)
</div>
</body>
</html>
View
14 doc/symbols/jQuery.fn.html
@@ -201,22 +201,26 @@
<li><a href="../symbols/jQuery.tabulate.event_handlers.html">jQuery.tabulate.event_handlers</a></li>
- <li><a href="../symbols/jQuery.tabulate.options.html">jQuery.tabulate.options</a></li>
-
- <li><a href="../symbols/jQuery.tabulate.options.%24elements.html">jQuery.tabulate.options.$elements</a></li>
+ <li><a href="../symbols/jQuery.tabulate.filters.html">jQuery.tabulate.filters</a></li>
- <li><a href="../symbols/jQuery.tabulate.options.%24fragments.html">jQuery.tabulate.options.$fragments</a></li>
+ <li><a href="../symbols/jQuery.tabulate.options.html">jQuery.tabulate.options</a></li>
<li><a href="../symbols/jQuery.tabulate.options.data.html">jQuery.tabulate.options.data</a></li>
<li><a href="../symbols/jQuery.tabulate.options.data.filters.html">jQuery.tabulate.options.data.filters</a></li>
<li><a href="../symbols/jQuery.tabulate.options.data.source.html">jQuery.tabulate.options.data.source</a></li>
+ <li><a href="../symbols/jQuery.tabulate.options.elements.html">jQuery.tabulate.options.elements</a></li>
+
+ <li><a href="../symbols/jQuery.tabulate.options.fragments.html">jQuery.tabulate.options.fragments</a></li>
+
<li><a href="../symbols/jQuery.tabulate.options.keys.html">jQuery.tabulate.options.keys</a></li>
<li><a href="../symbols/jQuery.tabulate.options.paths.html">jQuery.tabulate.options.paths</a></li>
+ <li><a href="../symbols/jQuery.tabulate.options.paths.images.html">jQuery.tabulate.options.paths.images</a></li>
+
<li><a href="../symbols/jQuery.tabulate.options.table.html">jQuery.tabulate.options.table</a></li>
<li><a href="../symbols/tabulate.html">tabulate</a></li>
@@ -416,7 +420,7 @@ <h1 class="classTitle">
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Thu Sep 16 2010 17:15:10 GMT-0700 (PDT)
+ Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Tue Oct 12 2010 18:14:06 GMT-0700 (PDT)
</div>
</body>
</html>
View
193 doc/symbols/jQuery.html
@@ -201,22 +201,26 @@
<li><a href="../symbols/jQuery.tabulate.event_handlers.html">jQuery.tabulate.event_handlers</a></li>
- <li><a href="../symbols/jQuery.tabulate.options.html">jQuery.tabulate.options</a></li>
-
- <li><a href="../symbols/jQuery.tabulate.options.%24elements.html">jQuery.tabulate.options.$elements</a></li>
+ <li><a href="../symbols/jQuery.tabulate.filters.html">jQuery.tabulate.filters</a></li>
- <li><a href="../symbols/jQuery.tabulate.options.%24fragments.html">jQuery.tabulate.options.$fragments</a></li>
+ <li><a href="../symbols/jQuery.tabulate.options.html">jQuery.tabulate.options</a></li>
<li><a href="../symbols/jQuery.tabulate.options.data.html">jQuery.tabulate.options.data</a></li>
<li><a href="../symbols/jQuery.tabulate.options.data.filters.html">jQuery.tabulate.options.data.filters</a></li>
<li><a href="../symbols/jQuery.tabulate.options.data.source.html">jQuery.tabulate.options.data.source</a></li>
+ <li><a href="../symbols/jQuery.tabulate.options.elements.html">jQuery.tabulate.options.elements</a></li>
+
+ <li><a href="../symbols/jQuery.tabulate.options.fragments.html">jQuery.tabulate.options.fragments</a></li>
+
<li><a href="../symbols/jQuery.tabulate.options.keys.html">jQuery.tabulate.options.keys</a></li>
<li><a href="../symbols/jQuery.tabulate.options.paths.html">jQuery.tabulate.options.paths</a></li>
+ <li><a href="../symbols/jQuery.tabulate.options.paths.images.html">jQuery.tabulate.options.paths.images</a></li>
+
<li><a href="../symbols/jQuery.tabulate.options.table.html">jQuery.tabulate.options.table</a></li>
<li><a href="../symbols/tabulate.html">tabulate</a></li>
@@ -279,6 +283,51 @@ <h1 class="classTitle">
<!-- ============================== methods summary ======================== -->
+
+
+ <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class jQuery.">
+ <caption>Method Summary</caption>
+ <thead>
+ <tr>
+ <th scope="col">Method Attributes</th>
+ <th scope="col">Method Name and Description</th>
+ </tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td class="attributes">&lt;static&gt; &nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont">jQuery.<b><a href="../symbols/jQuery.html#.getLength">getLength</a></b>(Mixed)
+ </div>
+ <div class="description"></div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&lt;static&gt; &nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont">jQuery.<b><a href="../symbols/jQuery.html#.isEmpty">isEmpty</a></b>(Mixed)
+ </div>
+ <div class="description"></div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&lt;static&gt; &nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont">jQuery.<b><a href="../symbols/jQuery.html#.isNumber">isNumber</a></b>(Mixed)
+ </div>
+ <div class="description"></div>
+ </td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
<!-- ============================== events summary ======================== -->
@@ -324,6 +373,140 @@ <h1 class="classTitle">
<!-- ============================== method details ========================= -->
+ <div class="sectionTitle">
+ Method Detail
+ </div>
+
+ <a name=".getLength"> </a>
+ <div class="fixedFont">&lt;static&gt;
+
+
+ <span class="light">jQuery.</span><b>getLength</b>(Mixed)
+
+ </div>
+ <div class="description">
+
+
+
+ </div>
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <b>Mixed</b>
+
+ </dt>
+ <dd>a The argument to test against.</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd>Mixed Returns the length of argument or undefined if not known.</dd>
+
+ </dl>
+
+
+
+
+ <hr />
+
+ <a name=".isEmpty"> </a>
+ <div class="fixedFont">&lt;static&gt;
+
+
+ <span class="light">jQuery.</span><b>isEmpty</b>(Mixed)
+
+ </div>
+ <div class="description">
+
+
+
+ </div>
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <b>Mixed</b>
+
+ </dt>
+ <dd>o The argument to test against.</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd>Boolean Returns true if argument is empty, false otherwise.</dd>
+
+ </dl>
+
+
+
+
+ <hr />
+
+ <a name=".isNumber"> </a>
+ <div class="fixedFont">&lt;static&gt;
+
+
+ <span class="light">jQuery.</span><b>isNumber</b>(Mixed)
+
+ </div>
+ <div class="description">
+
+
+
+ </div>
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <b>Mixed</b>
+
+ </dt>
+ <dd>n The argument to test against.</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd>Boolean Returns true if argument is a finite number, false otherwise.</dd>
+
+ </dl>
+
+
+
+
+
+
+
<!-- ============================== event details ========================= -->
@@ -335,7 +518,7 @@ <h1 class="classTitle">
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Thu Sep 16 2010 17:15:10 GMT-0700 (PDT)
+ Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Tue Oct 12 2010 18:14:06 GMT-0700 (PDT)
</div>
</body>
</html>
View
14 doc/symbols/jQuery.tabulate.error_handlers.html
@@ -201,22 +201,26 @@
<li><a href="../symbols/jQuery.tabulate.event_handlers.html">jQuery.tabulate.event_handlers</a></li>
- <li><a href="../symbols/jQuery.tabulate.options.html">jQuery.tabulate.options</a></li>
-
- <li><a href="../symbols/jQuery.tabulate.options.%24elements.html">jQuery.tabulate.options.$elements</a></li>
+ <li><a href="../symbols/jQuery.tabulate.filters.html">jQuery.tabulate.filters</a></li>
- <li><a href="../symbols/jQuery.tabulate.options.%24fragments.html">jQuery.tabulate.options.$fragments</a></li>
+ <li><a href="../symbols/jQuery.tabulate.options.html">jQuery.tabulate.options</a></li>
<li><a href="../symbols/jQuery.tabulate.options.data.html">jQuery.tabulate.options.data</a></li>
<li><a href="../symbols/jQuery.tabulate.options.data.filters.html">jQuery.tabulate.options.data.filters</a></li>
<li><a href="../symbols/jQuery.tabulate.options.data.source.html">jQuery.tabulate.options.data.source</a></li>
+ <li><a href="../symbols/jQuery.tabulate.options.elements.html">jQuery.tabulate.options.elements</a></li>
+
+ <li><a href="../symbols/jQuery.tabulate.options.fragments.html">jQuery.tabulate.options.fragments</a></li>
+
<li><a href="../symbols/jQuery.tabulate.options.keys.html">jQuery.tabulate.options.keys</a></li>
<li><a href="../symbols/jQuery.tabulate.options.paths.html">jQuery.tabulate.options.paths</a></li>
+ <li><a href="../symbols/jQuery.tabulate.options.paths.images.html">jQuery.tabulate.options.paths.images</a></li>
+
<li><a href="../symbols/jQuery.tabulate.options.table.html">jQuery.tabulate.options.table</a></li>
<li><a href="../symbols/tabulate.html">tabulate</a></li>
@@ -423,7 +427,7 @@ <h1 class="classTitle">
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Thu Sep 16 2010 17:15:10 GMT-0700 (PDT)
+ Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Tue Oct 12 2010 18:14:07 GMT-0700 (PDT)
</div>
</body>
</html>
View
112 doc/symbols/jQuery.tabulate.event_handlers.html
@@ -201,22 +201,26 @@
<li><a href="../symbols/jQuery.tabulate.event_handlers.html">jQuery.tabulate.event_handlers</a></li>
- <li><a href="../symbols/jQuery.tabulate.options.html">jQuery.tabulate.options</a></li>
-
- <li><a href="../symbols/jQuery.tabulate.options.%24elements.html">jQuery.tabulate.options.$elements</a></li>
+ <li><a href="../symbols/jQuery.tabulate.filters.html">jQuery.tabulate.filters</a></li>
- <li><a href="../symbols/jQuery.tabulate.options.%24fragments.html">jQuery.tabulate.options.$fragments</a></li>
+ <li><a href="../symbols/jQuery.tabulate.options.html">jQuery.tabulate.options</a></li>
<li><a href="../symbols/jQuery.tabulate.options.data.html">jQuery.tabulate.options.data</a></li>
<li><a href="../symbols/jQuery.tabulate.options.data.filters.html">jQuery.tabulate.options.data.filters</a></li>
<li><a href="../symbols/jQuery.tabulate.options.data.source.html">jQuery.tabulate.options.data.source</a></li>
+ <li><a href="../symbols/jQuery.tabulate.options.elements.html">jQuery.tabulate.options.elements</a></li>
+
+ <li><a href="../symbols/jQuery.tabulate.options.fragments.html">jQuery.tabulate.options.fragments</a></li>
+
<li><a href="../symbols/jQuery.tabulate.options.keys.html">jQuery.tabulate.options.keys</a></li>
<li><a href="../symbols/jQuery.tabulate.options.paths.html">jQuery.tabulate.options.paths</a></li>
+ <li><a href="../symbols/jQuery.tabulate.options.paths.images.html">jQuery.tabulate.options.paths.images</a></li>
+
<li><a href="../symbols/jQuery.tabulate.options.table.html">jQuery.tabulate.options.table</a></li>
<li><a href="../symbols/tabulate.html">tabulate</a></li>
@@ -300,6 +304,15 @@ <h1 class="classTitle">
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
+ <div class="fixedFont">jQuery.tabulate.event_handlers.<b><a href="../symbols/jQuery.tabulate.event_handlers.html#event:.no_results">no_results</a></b>(Object)
+ </div>
+ <div class="description">Called if there was no data to tabulate upon.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&lt;static&gt; &nbsp;</td>
+ <td class="nameDescription">
<div class="fixedFont">jQuery.tabulate.event_handlers.<b><a href="../symbols/jQuery.tabulate.event_handlers.html#event:.post_init">post_init</a></b>(Object)
</div>
<div class="description">Called after <a href="../symbols/jQuery.tabulate.html#.init">jQuery.tabulate.init</a> finishes processing.</div>
@@ -329,7 +342,16 @@ <h1 class="classTitle">
<td class="nameDescription">
<div class="fixedFont">jQuery.tabulate.event_handlers.<b><a href="../symbols/jQuery.tabulate.event_handlers.html#event:.refresh">refresh</a></b>(Object, Object, Object)
</div>
- <div class="description">Generally called when data needs to be re-loaded.</div>
+ <div class="description">Refresh changes the scope of the data shown.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&lt;static&gt; &nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont">jQuery.tabulate.event_handlers.<b><a href="../symbols/jQuery.tabulate.event_handlers.html#event:.reset">reset</a></b>(Object)
+ </div>
+ <div class="description">Resets tabulate back to it's default state.</div>
</td>
</tr>
@@ -438,7 +460,7 @@ <h1 class="classTitle">
<dl class="detailList">
<dt class="heading">See:</dt>
- <dd>jQuery.tabulate.options.elements.$loading</dd>
+ <dd><a href="../symbols/jQuery.tabulate.options.elements.html#.$loading">jQuery.tabulate.options.elements.$loading</a></dd>
<dd>The jQuery <a href="http://api.jquery.com/category/events/event-object/">Event</a> Object</dd>
@@ -447,6 +469,42 @@ <h1 class="classTitle">
<hr />
+ <a name="event:.no_results"> </a>
+ <div class="fixedFont">&lt;static&gt;
+
+
+ <span class="light">jQuery.tabulate.event_handlers.</span><b>no_results</b>(Object)
+
+ </div>
+ <div class="description">
+ Called if there was no data to tabulate upon.
+
+
+ </div>
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <b>Object</b>
+
+ </dt>
+ <dd>event The jQuery Event object.</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+ <hr />
+
<a name="event:.post_init"> </a>
<div class="fixedFont">&lt;static&gt;
@@ -610,7 +668,9 @@ <h1 class="classTitle">
</div>
<div class="description">
- Generally called when data needs to be re-loaded.
+ Refresh changes the scope of the data shown. This might mean
+gathering and displaying new data, or simply changing the display
+scope of data we already have.
</div>
@@ -655,6 +715,42 @@ <h1 class="classTitle">
</dl>
+ <hr />
+
+ <a name="event:.reset"> </a>
+ <div class="fixedFont">&lt;static&gt;
+
+
+ <span class="light">jQuery.tabulate.event_handlers.</span><b>reset</b>(Object)
+
+ </div>
+ <div class="description">
+ Resets tabulate back to it's default state.
+
+
+ </div>
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <b>Object</b>
+
+ </dt>
+ <dd>event The jQuery Event Object</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
@@ -666,7 +762,7 @@ <h1 class="classTitle">
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Thu Sep 16 2010 17:15:10 GMT-0700 (PDT)
+ Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Tue Oct 12 2010 18:14:07 GMT-0700 (PDT)
</div>
</body>
</html>
View
434 doc/symbols/jQuery.tabulate.filters.html
@@ -0,0 +1,434 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+ <meta name="generator" content="JsDoc Toolkit" />
+
+ <title>JsDoc Reference - jQuery.tabulate.filters</title>
+
+ <style type="text/css">
+ /* default.css */
+body
+{
+ font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
+ width: 800px;
+}
+
+.header
+{
+ clear: both;
+ background-color: #ccc;
+ padding: 8px;
+}
+
+h1
+{
+ font-size: 150%;
+ font-weight: bold;
+ padding: 0;
+ margin: 1em 0 0 .3em;
+}
+
+hr
+{
+ border: none 0;
+ border-top: 1px solid #7F8FB1;
+ height: 1px;
+}
+
+pre.code
+{
+ display: block;
+ padding: 8px;
+ border: 1px dashed #ccc;
+}
+
+#index
+{
+ margin-top: 24px;
+ float: left;
+ width: 160px;
+ position: absolute;
+ left: 8px;
+ background-color: #F3F3F3;
+ padding: 8px;
+}
+
+#content
+{
+ margin-left: 190px;
+ width: 600px;
+}
+
+.classList
+{
+ list-style-type: none;
+ padding: 0;
+ margin: 0 0 0 8px;
+ font-family: arial, sans-serif;
+ font-size: 1em;
+ overflow: auto;
+}
+
+.classList li
+{
+ padding: 0;
+ margin: 0 0 8px 0;
+}
+
+.summaryTable { width: 100%; }
+
+h1.classTitle
+{
+ font-size:170%;
+ line-height:130%;
+}
+
+h2 { font-size: 110%; }
+caption, div.sectionTitle
+{
+ background-color: #7F8FB1;
+ color: #fff;
+ font-size:130%;
+ text-align: left;
+ padding: 2px 6px 2px 6px;
+ border: 1px #7F8FB1 solid;
+}
+
+div.sectionTitle { margin-bottom: 8px; }
+.summaryTable thead { display: none; }
+
+.summaryTable td
+{
+ vertical-align: top;
+ padding: 4px;
+ border-bottom: 1px #7F8FB1 solid;
+ border-right: 1px #7F8FB1 solid;
+}
+
+/*col#summaryAttributes {}*/
+.summaryTable td.attributes
+{
+ border-left: 1px #7F8FB1 solid;
+ width: 140px;
+ text-align: right;
+}
+
+td.attributes, .fixedFont
+{
+ line-height: 15px;
+ color: #002EBE;
+ font-family: "Courier New",Courier,monospace;
+ font-size: 13px;
+}
+
+.summaryTable td.nameDescription
+{
+ text-align: left;
+ font-size: 13px;
+ line-height: 15px;
+}
+
+.summaryTable td.nameDescription, .description
+{
+ line-height: 15px;
+ padding: 4px;
+ padding-left: 4px;
+}
+
+.summaryTable { margin-bottom: 8px; }
+
+ul.inheritsList
+{
+ list-style: square;
+ margin-left: 20px;
+ padding-left: 0;
+}
+
+.detailList {
+ margin-left: 20px;
+ line-height: 15px;
+}
+.detailList dt { margin-left: 20px; }
+
+.detailList .heading
+{
+ font-weight: bold;
+ padding-bottom: 6px;
+ margin-left: 0;
+}
+
+.light, td.attributes, .light a:link, .light a:visited
+{
+ color: #777;
+ font-style: italic;
+}
+
+.fineprint
+{
+ text-align: right;
+ font-size: 10px;
+}
+ </style>
+ </head>
+
+ <body>
+<!-- ============================== header ================================= -->
+ <!-- begin static/header.html -->
+ <div id="header">
+</div>
+ <!-- end static/header.html -->
+
+<!-- ============================== classes index ============================ -->
+ <div id="index">
+ <!-- begin publish.classesIndex -->
+ <div align="center"><a href="../index.html">Class Index</a>
+| <a href="../files.html">File Index</a></div>
+<hr />
+<h2>Classes</h2>
+<ul class="classList">
+
+ <li><i><a href="../symbols/_global_.html">_global_</a></i></li>
+
+ <li><a href="../symbols/jQuery.html">jQuery</a></li>
+
+ <li><a href="../symbols/jQuery.fn.html">jQuery.fn</a></li>
+
+ <li><a href="../symbols/jQuery.tabulate.html">jQuery.tabulate</a></li>
+
+ <li><a href="../symbols/jQuery.tabulate.error_handlers.html">jQuery.tabulate.error_handlers</a></li>
+
+ <li><a href="../symbols/jQuery.tabulate.event_handlers.html">jQuery.tabulate.event_handlers</a></li>
+
+ <li><a href="../symbols/jQuery.tabulate.filters.html">jQuery.tabulate.filters</a></li>
+
+ <li><a href="../symbols/jQuery.tabulate.options.html">jQuery.tabulate.options</a></li>
+
+ <li><a href="../symbols/jQuery.tabulate.options.data.html">jQuery.tabulate.options.data</a></li>
+
+ <li><a href="../symbols/jQuery.tabulate.options.data.filters.html">jQuery.tabulate.options.data.filters</a></li>
+
+ <li><a href="../symbols/jQuery.tabulate.options.data.source.html">jQuery.tabulate.options.data.source</a></li>
+
+ <li><a href="../symbols/jQuery.tabulate.options.elements.html">jQuery.tabulate.options.elements</a></li>
+
+ <li><a href="../symbols/jQuery.tabulate.options.fragments.html">jQuery.tabulate.options.fragments</a></li>
+
+ <li><a href="../symbols/jQuery.tabulate.options.keys.html">jQuery.tabulate.options.keys</a></li>
+
+ <li><a href="../symbols/jQuery.tabulate.options.paths.html">jQuery.tabulate.options.paths</a></li>
+
+ <li><a href="../symbols/jQuery.tabulate.options.paths.images.html">jQuery.tabulate.options.paths.images</a></li>
+
+ <li><a href="../symbols/jQuery.tabulate.options.table.html">jQuery.tabulate.options.table</a></li>
+
+ <li><a href="../symbols/tabulate.html">tabulate</a></li>
+
+</ul>
+<hr />
+ <!-- end publish.classesIndex -->
+ </div>
+
+ <div id="content">
+<!-- ============================== class title ============================ -->
+ <h1 class="classTitle">
+
+ Namespace jQuery.tabulate.filters
+ </h1>
+
+<!-- ============================== class summary ========================== -->
+ <p class="description">
+
+
+
+ Contains filters to apply to the data set.
+
+
+ <br /><i>Defined in: </i> <a href="../symbols/src/_home_kflorence_sandbox_jquery-tabulate_src_jquery.tabulate.js.html">jquery.tabulate.js</a>.
+
+ </p>
+
+<!-- ============================== constructor summary ==================== -->
+
+ <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class jQuery.tabulate.filters.">
+ <caption>Namespace Summary</caption>
+ <thead>
+ <tr>
+ <th scope="col">Constructor Attributes</th>
+ <th scope="col">Constructor Name and Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription" >
+ <div class="fixedFont">
+ <b><a href="../symbols/jQuery.tabulate.filters.html#constructor">jQuery.tabulate.filters</a></b>
+ </div>
+ <div class="description">Global filters to apply to the data set will go here.</div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+
+<!-- ============================== properties summary ===================== -->
+
+
+
+ <table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class jQuery.tabulate.filters.">
+ <caption>Field Summary</caption>
+ <thead>
+ <tr>
+ <th scope="col">Field Attributes</th>
+ <th scope="col">Field Name and Description</th>
+ </tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td class="attributes">&lt;static&gt; &nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont">
+ jQuery.tabulate.filters.<b><a href="../symbols/jQuery.tabulate.filters.html#.limit">limit</a></b>
+ </div>
+ <div class="description">How many items to show per page.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&lt;static&gt; &nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont">
+ jQuery.tabulate.filters.<b><a href="../symbols/jQuery.tabulate.filters.html#.offset">offset</a></b>
+ </div>
+ <div class="description">The number of items by which to offest our data set.</div>
+ </td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+<!-- ============================== methods summary ======================== -->
+
+<!-- ============================== events summary ======================== -->
+
+
+<!-- ============================== constructor details ==================== -->
+
+ <div class="details"><a name="constructor"> </a>
+ <div class="sectionTitle">
+ Namespace Detail
+ </div>
+
+ <div class="fixedFont">
+ <b>jQuery.tabulate.filters</b>
+ </div>
+
+ <div class="description">
+ Global filters to apply to the data set will go here.
+
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+
+
+<!-- ============================== field details ========================== -->
+
+ <div class="sectionTitle">
+ Field Detail
+ </div>
+
+ <a name=".limit"> </a>
+ <div class="fixedFont">&lt;static&gt;
+
+ <span class="light">{integer}</span>
+ <span class="light">jQuery.tabulate.filters.</span><b>limit</b>
+
+ </div>
+ <div class="description">
+ How many items to show per page.
+
+
+ </div>
+
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Default Value:</dt>
+ <dd>
+ 0
+ </dd>
+ </dl>
+
+
+ <hr />
+
+ <a name=".offset"> </a>
+ <div class="fixedFont">&lt;static&gt;
+
+ <span class="light">{integer}</span>
+ <span class="light">jQuery.tabulate.filters.</span><b>offset</b>
+
+ </div>
+ <div class="description">
+ The number of items by which to offest our data set.
+
+
+ </div>
+
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Default Value:</dt>
+ <dd>
+ 0
+ </dd>
+ </dl>
+
+
+
+
+
+
+<!-- ============================== method details ========================= -->
+
+
+<!-- ============================== event details ========================= -->
+
+
+ <hr />
+ </div>
+
+
+<!-- ============================== footer ================================= -->
+ <div class="fineprint" style="clear:both">
+
+ Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Tue Oct 12 2010 18:14:07 GMT-0700 (PDT)
+ </div>
+ </body>
+</html>
View
328 doc/symbols/jQuery.tabulate.html
@@ -201,22 +201,26 @@
<li><a href="../symbols/jQuery.tabulate.event_handlers.html">jQuery.tabulate.event_handlers</a></li>
- <li><a href="../symbols/jQuery.tabulate.options.html">jQuery.tabulate.options</a></li>
-
- <li><a href="../symbols/jQuery.tabulate.options.%24elements.html">jQuery.tabulate.options.$elements</a></li>
+ <li><a href="../symbols/jQuery.tabulate.filters.html">jQuery.tabulate.filters</a></li>
- <li><a href="../symbols/jQuery.tabulate.options.%24fragments.html">jQuery.tabulate.options.$fragments</a></li>
+ <li><a href="../symbols/jQuery.tabulate.options.html">jQuery.tabulate.options</a></li>
<li><a href="../symbols/jQuery.tabulate.options.data.html">jQuery.tabulate.options.data</a></li>
<li><a href="../symbols/jQuery.tabulate.options.data.filters.html">jQuery.tabulate.options.data.filters</a></li>
<li><a href="../symbols/jQuery.tabulate.options.data.source.html">jQuery.tabulate.options.data.source</a></li>
+ <li><a href="../symbols/jQuery.tabulate.options.elements.html">jQuery.tabulate.options.elements</a></li>
+
+ <li><a href="../symbols/jQuery.tabulate.options.fragments.html">jQuery.tabulate.options.fragments</a></li>
+
<li><a href="../symbols/jQuery.tabulate.options.keys.html">jQuery.tabulate.options.keys</a></li>
<li><a href="../symbols/jQuery.tabulate.options.paths.html">jQuery.tabulate.options.paths</a></li>
+ <li><a href="../symbols/jQuery.tabulate.options.paths.images.html">jQuery.tabulate.options.paths.images</a></li>
+
<li><a href="../symbols/jQuery.tabulate.options.table.html">jQuery.tabulate.options.table</a></li>
<li><a href="../symbols/tabulate.html">tabulate</a></li>
@@ -287,19 +291,29 @@ <h1 class="classTitle">
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
+ jQuery.tabulate.<b><a href="../symbols/jQuery.tabulate.html#.cache">cache</a></b>
+ </div>
+ <div class="description">Contains any data that has already been loaded.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&lt;static&gt; &nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont">
jQuery.tabulate.<b><a href="../symbols/jQuery.tabulate.html#.columns">columns</a></b>
</div>
- <div class="description">The number of columns in the table (at its widest point)</div>
+ <div class="description">The number of columns in the table (at its widest point).</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
- jQuery.tabulate.<b><a href="../symbols/jQuery.tabulate.html#.count">count</a></b>
+ jQuery.tabulate.<b><a href="../symbols/jQuery.tabulate.html#.current_count">current_count</a></b>
</div>
- <div class="description">The total number of rows in the dataset.</div>
+ <div class="description">The current number of rows in the data set.</div>
</td>
</tr>
@@ -309,7 +323,17 @@ <h1 class="classTitle">
<div class="fixedFont">
jQuery.tabulate.<b><a href="../symbols/jQuery.tabulate.html#.current_page">current_page</a></b>
</div>
- <div class="description">The "page" of the dataset that is currently being viewed.</div>
+ <div class="description">The "page" of the data set that is currently being viewed.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&lt;static&gt; &nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont">
+ jQuery.tabulate.<b><a href="../symbols/jQuery.tabulate.html#.total_count">total_count</a></b>
+ </div>
+ <div class="description">The total number of rows in the data set.</div>
</td>
</tr>
@@ -319,7 +343,7 @@ <h1 class="classTitle">
<div class="fixedFont">
jQuery.tabulate.<b><a href="../symbols/jQuery.tabulate.html#.total_pages">total_pages</a></b>
</div>
- <div class="description">The total number of "pages" in the dataset that are available for
+ <div class="description">The total number of "pages" in the data set that are available for
viewing.</div>
</td>
</tr>
@@ -350,14 +374,14 @@ <h1 class="classTitle">
<td class="nameDescription">
<div class="fixedFont">jQuery.tabulate.<b><a href="../symbols/jQuery.tabulate.html#.apply_properties">apply_properties</a></b>(jQuery, Object, properties)
</div>
- <div class="description">Applies properties to rows, columns and cells in the table.</div>
+ <div class="description">Applies properties to rows and cells in the table.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
- <div class="fixedFont">jQuery.tabulate.<b><a href="../symbols/jQuery.tabulate.html#.build_section">build_section</a></b>(String, jQuery, Object)
+ <div class="fixedFont">jQuery.tabulate.<b><a href="../symbols/jQuery.tabulate.html#.build_section">build_section</a></b>(String, Object, Object)
</div>
<div class="description">Builds and appends a section of the table.</div>
</td>
@@ -384,7 +408,7 @@ <h1 class="classTitle">
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
- <div class="fixedFont">jQuery.tabulate.<b><a href="../symbols/jQuery.tabulate.html#.go_to">go_to</a></b>(element, integer)
+ <div class="fixedFont">jQuery.tabulate.<b><a href="../symbols/jQuery.tabulate.html#.go_to">go_to</a></b>(integer)
</div>
<div class="description">Updates <a href="../symbols/jQuery.tabulate.html#.current_page">jQuery.tabulate.current_page</a> to point to the specified
page.</div>
@@ -449,9 +473,9 @@ <h1 class="classTitle">
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
- <div class="fixedFont">jQuery.tabulate.<b><a href="../symbols/jQuery.tabulate.html#.update_filters">update_filters</a></b>(Object, Object)
+ <div class="fixedFont">jQuery.tabulate.<b><a href="../symbols/jQuery.tabulate.html#.update_filters">update_filters</a></b>(Object, Boolean, Object)
</div>
- <div class="description">Updates the filters that will be applied to the current dataset.</div>
+ <div class="description">Updates the filters that will be applied to the current data set.</div>
</td>
</tr>
@@ -500,15 +524,37 @@ <h1 class="classTitle">
Field Detail
</div>
+ <a name=".cache"> </a>
+ <div class="fixedFont">&lt;static&gt;
+
+ <span class="light">{Object}</span>
+ <span class="light">jQuery.tabulate.</span><b>cache</b>
+
+ </div>
+ <div class="description">
+ Contains any data that has already been loaded.
+
+
+ </div>
+
+
+
+
+
+
+
+
+ <hr />
+
<a name=".columns"> </a>
<div class="fixedFont">&lt;static&gt;
- <span class="light">{integer}</span>
+ <span class="light">{Number}</span>
<span class="light">jQuery.tabulate.</span><b>columns</b>
</div>
<div class="description">
- The number of columns in the table (at its widest point)
+ The number of columns in the table (at its widest point).
</div>
@@ -529,21 +575,19 @@ <h1 class="classTitle">
<hr />
- <a name=".count"> </a>
+ <a name=".current_count"> </a>
<div class="fixedFont">&lt;static&gt;
- <span class="light">{integer}</span>
- <span class="light">jQuery.tabulate.</span><b>count</b>
+ <span class="light">{Number}</span>
+ <span class="light">jQuery.tabulate.</span><b>current_count</b>
</div>
<div class="description">
- The total number of rows in the dataset.
+ The current number of rows in the data set.
<p>
- This value is usually based on the value of
- jQuery.tabulate.options.keys.rows, but in it's absence may also
- be calculated by the number of rows found in the dataset. It is
- set in <a href="../symbols/jQuery.tabulate.html#.tabulate">jQuery.tabulate.tabulate</a>.
+ This value is set by counting the number of "data" items within
+ the returned data set.
</p>
@@ -554,6 +598,13 @@ <h1 class="classTitle">
+ <dl class="detailList">
+ <dt class="heading">See:</dt>
+
+ <dd>jQuery.tabulate.keys.data</dd>
+
+ </dl>
+
<dl class="detailList">
<dt class="heading">Default Value:</dt>
@@ -568,16 +619,50 @@ <h1 class="classTitle">
<a name=".current_page"> </a>
<div class="fixedFont">&lt;static&gt;
- <span class="light">{integer}</span>
+ <span class="light">{Number}</span>
<span class="light">jQuery.tabulate.</span><b>current_page</b>
</div>
<div class="description">
- The "page" of the dataset that is currently being viewed.
+ The "page" of the data set that is currently being viewed.
<p>
Used by the internal pagination system to limit the current view of
- the dataset. This variable is modified by the navigation functions.
+ the data set. This variable is modified by the navigation functions.
+</p>
+
+
+ </div>
+
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Default Value:</dt>
+ <dd>
+ 1
+ </dd>
+ </dl>
+
+
+ <hr />
+
+ <a name=".total_count"> </a>
+ <div class="fixedFont">&lt;static&gt;
+
+ <span class="light">{Number}</span>
+ <span class="light">jQuery.tabulate.</span><b>total_count</b>
+
+ </div>
+ <div class="description">
+ The total number of rows in the data set.
+
+<p>
+ This value may be set within the data set to allow for lazy-loading
+ data (not loading it all at once).
</p>
@@ -591,19 +676,15 @@ <h1 class="classTitle">
<dl class="detailList">
<dt class="heading">See:</dt>
- <dd><a href="../symbols/jQuery.tabulate.html#.previous">jQuery.tabulate.previous</a></dd>
-
- <dd><a href="../symbols/jQuery.tabulate.html#.next">jQuery.tabulate.next</a></dd>
-
- <dd><a href="../symbols/jQuery.tabulate.html#.go_to">jQuery.tabulate.go_to</a></dd>
+ <dd>jQuery.tabulate.keys.count</dd>
</dl>
<dl class="detailList">
<dt class="heading">Default Value:</dt>
<dd>
- 1
+ 0
</dd>
</dl>
@@ -613,17 +694,17 @@ <h1 class="classTitle">
<a name=".total_pages"> </a>
<div class="fixedFont">&lt;static&gt;
- <span class="light">{integer}</span>
+ <span class="light">{Number}</span>
<span class="light">jQuery.tabulate.</span><b>total_pages</b>
</div>
<div class="description">
- The total number of "pages" in the dataset that are available for
+ The total number of "pages" in the data set that are available for
viewing.
<p>
This value is calculated in <a href="../symbols/jQuery.tabulate.html#.tabulate">jQuery.tabulate.tabulate</a> based upon
- the values of <a href="../symbols/jQuery.tabulate.html#.count">jQuery.tabulate.count</a> and jQuery.tabulate.filters.limit.
+ the values of jQuery.tabulate.count and <a href="../symbols/jQuery.tabulate.filters.html#.limit">jQuery.tabulate.filters.limit</a>.
</p>
@@ -661,108 +742,7 @@ <h1 class="classTitle">
</div>
<div class="description">
- Applies properties to rows, columns and cells in the table.
-
-<p>
- Each row or column in the table may have any number of properties
- assigned to it. These properties are passed into the plugin upon
- initialization as jQuery.tabulate.options.rows for rows, and
- jQuery.tabulate.options.columns for columns. The following
- outlines valid properties for both rows and columns (note that
- "cell" refers to a column within a row):
-</p>
-
-<ul>
- <li>
- <strong>name</strong> - The name associated with the current cell
- or row. In the case of an object, this would be the key. In the
- case of an Array, this would be the index.
- </li>
- <li>
- <strong>data</strong> - The data associated with the current row.
- It can be used for extracting the value of a key and storing it
- as the cell's content.
- </li>
- <li>
- <strong>args</strong> - An array of arguments to pass to the
- callback function via javaScript's apply function.
- </li>
- <li>
- <p>
- <strong>callback</strong> - This is a function that will be
- called when the cell or row is instantiated. This is useful
- for manipulating something based on the data assigned to a cell
- or row. Inside of the this function, <em>this</em> is equal to
- <a href="../symbols/jQuery.tabulate.html">jQuery.tabulate</a>. The arguments passed to this function vary
- between cells and rows.
- </p>
-
- <p>The arguments passed for a row are:</p>
-
- <ul>
- <li>
- <strong>$row</strong> - The jQuery object representing the
- current row.
- </li>
- <li>
- <strong>row_data</strong> - The data associated with the current
- row.
- </li>
- </ul>
-
- <p>The arguments passed for a cell are:</p>
-
- <ul>
- <li>
- <strong>$row</strong> - The jQuery object representing the
- current row.
- </li>
- <li>
- <strong>$cell</strong> - The jQuery object representing the
- current cell.
- </li>
- <li>
- <strong>$content</strong> - The jQuery object representing
- $cell's content wrapper.
- </li>
- <li>
- <strong>row_data</strong> - The data associated with the
- current row.
- </li>
- </ul>
- </li>
- <li>
- <strong>event_handlers</strong> - An object containing event
- handlers to bind to the cell or row. These should be defined in
- the same format as <a href="../symbols/jQuery.tabulate.event_handlers.html">jQuery.tabulate.event_handlers</a>.
- </li>
- <li>
- <strong>styles</strong> - An object containing style information
- to be applied to the row or cell. This object is passed to the
- <a href="http://api.jquery.com/jQuery.css/">jQuery.css</a>
- function.
- </li>
-</ul>
-
-<p>
- Columns may also contain these properties, in addition to those
- defined above:
-</p>
-
-<ul>
- <li>
- <strong>$content</strong> - The jQuery object in which to append
- content inside of. If not given, defaults to $element.
- </li>
- <li>
- <strong>content</strong> - The content to append inside $content.
- Content can be passed in as a string, a jQuery object, or as a
- key within the dataset <em>data</em>. If you wish to pass in a
- key, you may do so within curly braces like so: "{some_key}". If
- the key is nested within the dataset, you may separate each level
- by use of a dot like so: "{obj.prop.key}".
- </li>
-</ul>
+ Applies properties to rows and cells in the table.
</div>
@@ -783,7 +763,7 @@ <h1 class="classTitle">
<b>Object</b>
</dt>
- <dd>properties An object containing the properties.</dd>
+ <dd>settings An object containing settings for the</dd>
<dt>
<b>properties</b>
@@ -809,15 +789,9 @@ <h1 class="classTitle">
<dl class="detailList">
<dt class="heading">See:</dt>
- <dd><a href="http://api.jquery.com/jQuery.css/">jQuery.css</a></dd>
-
- <dd><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Function/apply">Function.apply</a></dd>
-
- <dd>jQuery.tabulate.options.rows</dd>
-
- <dd>jQuery.tabulate.options.columns</dd>
+ <dd>jQuery.table.body.rows</dd>
- <dd><a href="../symbols/jQuery.tabulate.event_handlers.html">jQuery.tabulate.event_handlers</a></dd>
+ <dd>jQuery.table.body.cells</dd>
</dl>
@@ -828,7 +802,7 @@ <h1 class="classTitle">
<div class="fixedFont">&lt;static&gt;
- <span class="light">jQuery.tabulate.</span><b>build_section</b>(String, jQuery, Object)
+ <span class="light">jQuery.tabulate.</span><b>build_section</b>(String, Object, Object)
</div>
<div class="description">
@@ -847,33 +821,27 @@ <h1 class="classTitle">
<b>String</b>
</dt>
- <dd>name The name of the section</dd>
+ <dd>section The name of the section</dd>
<dt>
- <b>jQuery</b>
+ <b>Object</b>
</dt>
- <dd>$element The element to append rows to</dd>
+ <dd>options Contains the section key, $section fragment
+ and any additional properties to bestow upon the section.</dd>
<dt>
<b>Object</b>
</dt>
- <dd>data The data to populate the section with</dd>
+ <dd>data The data given to tabulate</dd>
</dl>
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd>Number The number of columns in the section.</dd>
-
- </dl>
-
@@ -978,7 +946,7 @@ <h1 class="classTitle">
<div class="fixedFont">&lt;static&gt;
- <span class="light">jQuery.tabulate.</span><b>go_to</b>(element, integer)
+ <span class="light">jQuery.tabulate.</span><b>go_to</b>(integer)
</div>
<div class="description">
@@ -1001,12 +969,6 @@ <h1 class="classTitle">
<dt class="heading">Parameters:</dt>
<dt>
- <b>element</b>
-
- </dt>
- <dd>element The DOM element that was clicked.</dd>
-
- <dt>
<b>integer</b>
</dt>
@@ -1035,7 +997,7 @@ <h1 class="classTitle">
<p>
Merges default options with those passed in, builds the table
- skeleton, creates jQuery objects from jQuery.tabulate.options.elements
+ skeleton, creates jQuery objects from <a href="../symbols/jQuery.tabulate.options.elements.html">jQuery.tabulate.options.elements</a>
and binds any needed event handlers. Finally, triggers
<a href="../symbols/jQuery.tabulate.event_handlers.html#event:.event:post_init">jQuery.tabulate.event_handlers.event:post_init</a>.
</p>
@@ -1281,24 +1243,11 @@ <h1 class="classTitle">
<div class="fixedFont">&lt;static&gt;
- <span class="light">jQuery.tabulate.</span><b>update_filters</b>(Object, Object)
+ <span class="light">jQuery.tabulate.</span><b>update_filters</b>(Object, Boolean, Object)
</div>
<div class="description">
- Updates the filters that will be applied to the current dataset.
-
-<p>
- This function will merge any filters that are passed in with those
- already present, overwriting any values that are already contained
- in the filters Object. Any type of filter may be passed in here,
- including custom filters that you wish to pass to your controller.
-</p>
-
-<p>
- When the merge is complete, the current_page will be reset to 1 and
- the <a href="../symbols/jQuery.tabulate.event_handlers.html#event:.event:refresh">jQuery.tabulate.event_handlers.event:refresh</a> event handler is
- called which reloads the data with the new filters applied.
-</p>
+ Updates the filters that will be applied to the current data set.
</div>
@@ -1313,13 +1262,22 @@ <h1 class="classTitle">
<b>Object</b>
</dt>
- <dd>filters The filters to apply to the dataset.</dd>
+ <dd>filters The filters to apply to the data set.</dd>
+
+ <dt>
+ <b>Boolean</b>
+
+ </dt>
+ <dd>overwrite Whether or not to overwrite the current filters
+ with the new filters. Defaults to true. If false, the two filter
+ objects would be merged.</dd>
<dt>
<b>Object</b>
</dt>
- <dd>refresh Whether or not to call the refresh handler. Defaults to true.</dd>
+ <dd>refresh Whether or not to call the refresh handler.
+ Defaults to true.</dd>
</dl>
@@ -1344,7 +1302,7 @@ <h1 class="classTitle">
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Thu Sep 16 2010 17:15:10 GMT-0700 (PDT)
+ Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Tue Oct 12 2010 18:14:07 GMT-0700 (PDT)
</div>
</body>
</html>
View
124 doc/symbols/jQuery.tabulate.options.data.filters.html
@@ -201,22 +201,26 @@
<li><a href="../symbols/jQuery.tabulate.event_handlers.html">jQuery.tabulate.event_handlers</a></li>
- <li><a href="../symbols/jQuery.tabulate.options.html">jQuery.tabulate.options</a></li>
-
- <li><a href="../symbols/jQuery.tabulate.options.%24elements.html">jQuery.tabulate.options.$elements</a></li>
+ <li><a href="../symbols/jQuery.tabulate.filters.html">jQuery.tabulate.filters</a></li>
- <li><a href="../symbols/jQuery.tabulate.options.%24fragments.html">jQuery.tabulate.options.$fragments</a></li>
+ <li><a href="../symbols/jQuery.tabulate.options.html">jQuery.tabulate.options</a></li>
<li><a href="../symbols/jQuery.tabulate.options.data.html">jQuery.tabulate.options.data</a></li>
<li><a href="../symbols/jQuery.tabulate.options.data.filters.html">jQuery.tabulate.options.data.filters</a></li>
<li><a href="../symbols/jQuery.tabulate.options.data.source.html">jQuery.tabulate.options.data.source</a></li>
+ <li><a href="../symbols/jQuery.tabulate.options.elements.html">jQuery.tabulate.options.elements</a></li>
+
+ <li><a href="../symbols/jQuery.tabulate.options.fragments.html">jQuery.tabulate.options.fragments</a></li>
+
<li><a href="../symbols/jQuery.tabulate.options.keys.html">jQuery.tabulate.options.keys</a></li>
<li><a href="../symbols/jQuery.tabulate.options.paths.html">jQuery.tabulate.options.paths</a></li>
+ <li><a href="../symbols/jQuery.tabulate.options.paths.images.html">jQuery.tabulate.options.paths.images</a></li>
+
<li><a href="../symbols/jQuery.tabulate.options.table.html">jQuery.tabulate.options.table</a></li>
<li><a href="../symbols/tabulate.html">tabulate</a></li>
@@ -238,7 +242,7 @@ <h1 class="classTitle">
- Contains the filters to apply to the data set.
+ Contains filters to apply to the data set.
<br /><i>Defined in: </i> <a href="../symbols/src/_home_kflorence_sandbox_jquery-tabulate_src_jquery.tabulate.js.html">jquery.tabulate.js</a>.
@@ -262,7 +266,7 @@ <h1 class="classTitle">
<div class="fixedFont">
<b><a href="../symbols/jQuery.tabulate.options.data.filters.html#constructor">jQuery.tabulate.options.data.filters</a></b>
</div>
- <div class="description"></div>
+ <div class="description">These filters will be attached to the data set.</div>
</td>
</tr>
</tbody>
@@ -271,44 +275,6 @@ <h1 class="classTitle">
<!-- ============================== properties summary ===================== -->
-
-
- <table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class jQuery.tabulate.options.data.filters.">
- <caption>Field Summary</caption>
- <thead>
- <tr>
- <th scope="col">Field Attributes</th>
- <th scope="col">Field Name and Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
- <td class="attributes">&lt;static&gt; &nbsp;</td>
- <td class="nameDescription">
- <div class="fixedFont">
- jQuery.tabulate.options.data.filters.<b><a href="../symbols/jQuery.tabulate.options.data.filters.html#.limit">limit</a></b>
- </div>
- <div class="description">How many items to show per page.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes">&lt;static&gt; &nbsp;</td>
- <td class="nameDescription">
- <div class="fixedFont">
- jQuery.tabulate.options.data.filters.<b><a href="../symbols/jQuery.tabulate.options.data.filters.html#.offset">offset</a></b>
- </div>
- <div class="description">The number of items by which to offest our data set.</div>
- </td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
<!-- ============================== methods summary ======================== -->
@@ -327,7 +293,10 @@ <h1 class="classTitle">
</div>
<div class="description">
-
+ These filters will be attached to the data set. They may
+override any global filter values, but the global filters
+will always be present (whether or not their values are
+overwritten).
</div>
@@ -347,69 +316,6 @@ <h1 class="classTitle">
<!-- ============================== field details ========================== -->
- <div class="sectionTitle">
- Field Detail
- </div>
-
- <a name=".limit"> </a>
- <div class="fixedFont">&lt;static&gt;
-
- <span class="light">{integer}</span>
- <span class="light">jQuery.tabulate.options.data.filters.</span><b>limit</b>
-
- </div>
- <div class="description">
- How many items to show per page.
-
-
- </div>
-
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Default Value:</dt>
- <dd>
- 0
- </dd>
- </dl>
-
-
- <hr />
-
- <a name=".offset"> </a>
- <div class="fixedFont">&lt;static&gt;
-
- <span class="light">{integer}</span>
- <span class="light">jQuery.tabulate.options.data.filters.</span><b>offset</b>
-
- </div>
- <div class="description">
- The number of items by which to offest our data set.
-
-
- </div>
-
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Default Value:</dt>
- <dd>
- 0
- </dd>
- </dl>
-
-
-
-
-
<!-- ============================== method details ========================= -->
@@ -424,7 +330,7 @@ <h1 class="classTitle">
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Thu Sep 16 2010 17:15:10 GMT-0700 (PDT)
+ Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Tue Oct 12 2010 18:14:07 GMT-0700 (PDT)
</div>
</body>
</html>
View
14 doc/symbols/jQuery.tabulate.options.data.html
@@ -201,22 +201,26 @@
<li><a href="../symbols/jQuery.tabulate.event_handlers.html">jQuery.tabulate.event_handlers</a></li>
- <li><a href="../symbols/jQuery.tabulate.options.html">jQuery.tabulate.options</a></li>
-
- <li><a href="../symbols/jQuery.tabulate.options.%24elements.html">jQuery.tabulate.options.$elements</a></li>
+ <li><a href="../symbols/jQuery.tabulate.filters.html">jQuery.tabulate.filters</a></li>
- <li><a href="../symbols/jQuery.tabulate.options.%24fragments.html">jQuery.tabulate.options.$fragments</a></li>
+ <li><a href="../symbols/jQuery.tabulate.options.html">jQuery.tabulate.options</a></li>
<li><a href="../symbols/jQuery.tabulate.options.data.html">jQuery.tabulate.options.data</a></li>
<li><a href="../symbols/jQuery.tabulate.options.data.filters.html">jQuery.tabulate.options.data.filters</a></li>
<li><a href="../symbols/jQuery.tabulate.options.data.source.html">jQuery.tabulate.options.data.source</a></li>
+ <li><a href="../symbols/jQuery.tabulate.options.elements.html">jQuery.tabulate.options.elements</a></li>
+
+ <li><a href="../symbols/jQuery.tabulate.options.fragments.html">jQuery.tabulate.options.fragments</a></li>
+
<li><a href="../symbols/jQuery.tabulate.options.keys.html">jQuery.tabulate.options.keys</a></li>
<li><a href="../symbols/jQuery.tabulate.options.paths.html">jQuery.tabulate.options.paths</a></li>
+ <li><a href="../symbols/jQuery.tabulate.options.paths.images.html">jQuery.tabulate.options.paths.images</a></li>
+
<li><a href="../symbols/jQuery.tabulate.options.table.html">jQuery.tabulate.options.table</a></li>
<li><a href="../symbols/tabulate.html">tabulate</a></li>
@@ -334,7 +338,7 @@ <h1 class="classTitle">
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Thu Sep 16 2010 17:15:10 GMT-0700 (PDT)
+ Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Tue Oct 12 2010 18:14:07 GMT-0700 (PDT)
</div>
</body>
</html>
View
211 doc/symbols/jQuery.tabulate.options.data.source.html
@@ -201,22 +201,26 @@
<li><a href="../symbols/jQuery.tabulate.event_handlers.html">jQuery.tabulate.event_handlers</a></li>
- <li><a href="../symbols/jQuery.tabulate.options.html">jQuery.tabulate.options</a></li>
-
- <li><a href="../symbols/jQuery.tabulate.options.%24elements.html">jQuery.tabulate.options.$elements</a></li>
+ <li><a href="../symbols/jQuery.tabulate.filters.html">jQuery.tabulate.filters</a></li>
- <li><a href="../symbols/jQuery.tabulate.options.%24fragments.html">jQuery.tabulate.options.$fragments</a></li>
+ <li><a href="../symbols/jQuery.tabulate.options.html">jQuery.tabulate.options</a></li>
<li><a href="../symbols/jQuery.tabulate.options.data.html">jQuery.tabulate.options.data</a></li>
<li><a href="../symbols/jQuery.tabulate.options.data.filters.html">jQuery.tabulate.options.data.filters</a></li>
<li><a href="../symbols/jQuery.tabulate.options.data.source.html">jQuery.tabulate.options.data.source</a></li>
+ <li><a href="../symbols/jQuery.tabulate.options.elements.html">jQuery.tabulate.options.elements</a></li>
+
+ <li><a href="../symbols/jQuery.tabulate.options.fragments.html">jQuery.tabulate.options.fragments</a></li>
+
<li><a href="../symbols/jQuery.tabulate.options.keys.html">jQuery.tabulate.options.keys</a></li>
<li><a href="../symbols/jQuery.tabulate.options.paths.html">jQuery.tabulate.options.paths</a></li>
+ <li><a href="../symbols/jQuery.tabulate.options.paths.images.html">jQuery.tabulate.options.paths.images</a></li>
+
<li><a href="../symbols/jQuery.tabulate.options.table.html">jQuery.tabulate.options.table</a></li>
<li><a href="../symbols/tabulate.html">tabulate</a></li>
@@ -262,7 +266,7 @@ <h1 class="classTitle">
<div class="fixedFont">
<b><a href="../symbols/jQuery.tabulate.options.data.source.html#constructor">jQuery.tabulate.options.data.source</a></b>
</div>
- <div class="description"></div>
+ <div class="description">Contains data sources to work upon.</div>
</td>
</tr>
</tbody>
@@ -271,44 +275,6 @@ <h1 class="classTitle">
<!-- ============================== properties summary ===================== -->
-
-
- <table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class jQuery.tabulate.options.data.source.">
- <caption>Field Summary</caption>
- <thead>
- <tr>
- <th scope="col">Field Attributes</th>
- <th scope="col">Field Name and Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
- <td class="attributes">&lt;static&gt; &nbsp;</td>
- <td class="nameDescription">
- <div class="fixedFont">
- jQuery.tabulate.options.data.source.<b><a