Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
tree: 2e05df5b07
Fetching contributors…

Cannot retrieve contributors at this time

650 lines (434 sloc) 15.83 kB
<!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.options</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.options
</h1>
<!-- ============================== class summary ========================== -->
<p class="description">
Holds the default options for <a href="../symbols/jQuery.tabulate.html">jQuery.tabulate</a>
<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.options.">
<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.options.html#constructor">jQuery.tabulate.options</a></b>
</div>
<div class="description">The settings <a href="../symbols/jQuery.tabulate.html">jQuery.tabulate</a> will use by default.</div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== properties summary ===================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class jQuery.tabulate.options.">
<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.<b><a href="../symbols/jQuery.tabulate.options.html#.debug">debug</a></b>
</div>
<div class="description">Whether or not to enable debug mode.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
jQuery.tabulate.options.<b><a href="../symbols/jQuery.tabulate.options.html#.error_handlers">error_handlers</a></b>
</div>
<div class="description">Can be used to override the default error handlers that are
defined in <a href="../symbols/jQuery.tabulate.error_handlers.html">jQuery.tabulate.error_handlers</a>.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
jQuery.tabulate.options.<b><a href="../symbols/jQuery.tabulate.options.html#.event_handlers">event_handlers</a></b>
</div>
<div class="description">Can be used to override the default event handlers that are
defined in <a href="../symbols/jQuery.tabulate.event_handlers.html">jQuery.tabulate.event_handlers</a>.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
jQuery.tabulate.options.<b><a href="../symbols/jQuery.tabulate.options.html#.name">name</a></b>
</div>
<div class="description">The name for this class instance.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
jQuery.tabulate.options.<b><a href="../symbols/jQuery.tabulate.options.html#.results_per_page">results_per_page</a></b>
</div>
<div class="description">An Array of integer values that will be used to populate the
<a href="../symbols/jQuery.tabulate.options.elements.html#.$results_per_page">jQuery.tabulate.options.elements.$results_per_page</a> element.</div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== methods summary ======================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class jQuery.tabulate.options.">
<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.tabulate.options.<b><a href="../symbols/jQuery.tabulate.options.html#.parse_key">parse_key</a></b>()
</div>
<div class="description">A function that returns a RegExp object that will be used to
parse keys out of strings.</div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== events summary ======================== -->
<!-- ============================== constructor details ==================== -->
<div class="details"><a name="constructor"> </a>
<div class="sectionTitle">
Namespace Detail
</div>
<div class="fixedFont">
<b>jQuery.tabulate.options</b>
</div>
<div class="description">
The settings <a href="../symbols/jQuery.tabulate.html">jQuery.tabulate</a> will use by default.
<p>
Note that any and all of these values can be overwritten as needed
by passing them into the tabulate plugin upon initialization.
</p>
</div>
</div>
<!-- ============================== field details ========================== -->
<div class="sectionTitle">
Field Detail
</div>
<a name=".debug"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">{Boolean}</span>
<span class="light">jQuery.tabulate.options.</span><b>debug</b>
</div>
<div class="description">
Whether or not to enable debug mode.
</div>
<dl class="detailList">
<dt class="heading">Default Value:</dt>
<dd>
false
</dd>
</dl>
<hr />
<a name=".error_handlers"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">{Object}</span>
<span class="light">jQuery.tabulate.options.</span><b>error_handlers</b>
</div>
<div class="description">
Can be used to override the default error handlers that are
defined in <a href="../symbols/jQuery.tabulate.error_handlers.html">jQuery.tabulate.error_handlers</a>.
</div>
<dl class="detailList">
<dt class="heading">See:</dt>
<dd><a href="../symbols/jQuery.tabulate.error_handlers.html">jQuery.tabulate.error_handlers</a></dd>
</dl>
<hr />
<a name=".event_handlers"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">{Object}</span>
<span class="light">jQuery.tabulate.options.</span><b>event_handlers</b>
</div>
<div class="description">
Can be used to override the default event handlers that are
defined in <a href="../symbols/jQuery.tabulate.event_handlers.html">jQuery.tabulate.event_handlers</a>.
</div>
<dl class="detailList">
<dt class="heading">See:</dt>
<dd><a href="../symbols/jQuery.tabulate.event_handlers.html">jQuery.tabulate.event_handlers</a></dd>
</dl>
<hr />
<a name=".name"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">{String}</span>
<span class="light">jQuery.tabulate.options.</span><b>name</b>
</div>
<div class="description">
The name for this class instance.
<p>
Generally used to define what is being tabulated, especially if
another plugin is built on top of this one. This is also used
for namespacing events and for class names and ID's within the
table.
</p>
</div>
<dl class="detailList">
<dt class="heading">Default Value:</dt>
<dd>
"tabulate"
</dd>
</dl>
<hr />
<a name=".results_per_page"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">{Array}</span>
<span class="light">jQuery.tabulate.options.</span><b>results_per_page</b>
</div>
<div class="description">
An Array of integer values that will be used to populate the
<a href="../symbols/jQuery.tabulate.options.elements.html#.$results_per_page">jQuery.tabulate.options.elements.$results_per_page</a> element.
</div>
<dl class="detailList">
<dt class="heading">Default Value:</dt>
<dd>
[5, 10, 25]
</dd>
</dl>
<!-- ============================== method details ========================= -->
<div class="sectionTitle">
Method Detail
</div>
<a name=".parse_key"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">jQuery.tabulate.options.</span><b>parse_key</b>()
</div>
<div class="description">
A function that returns a RegExp object that will be used to
parse keys out of strings.
<p>
By default, parse_key matches anything between matching
brackets. A global flag is also included so that multiple keys
may be matched and replaced within one string.
</p>
<p>
If you're wondering why we are returning the RegExp object
inside of a function, see this jQuery bug ticket:
<a href="http://dev.jquery.com/ticket/4192">#4192</a>. Although
this issue has been fixed in jQuery 1.4, I am keeping this in
here for backwards compatibility.
</p>
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd>RegExp The RegExp object</dd>
</dl>
<!-- ============================== 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:20:11 GMT-0700 (PDT)
</div>
</body>
</html>
Jump to Line
Something went wrong with that request. Please try again.