Class Index | File Index

Classes


Namespace jQuery.tabulate.options

Holds the default options for jQuery.tabulate
Defined in: jquery.tabulate.js.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
The settings jQuery.tabulate will use by default.
Field Summary
Field Attributes Field Name and Description
<static>  
jQuery.tabulate.options.debug
Whether or not to enable debug mode.
<static>  
jQuery.tabulate.options.error_handlers
Can be used to override the default error handlers that are defined in jQuery.tabulate.error_handlers.
<static>  
jQuery.tabulate.options.event_handlers
Can be used to override the default event handlers that are defined in jQuery.tabulate.event_handlers.
<static>  
jQuery.tabulate.options.name
The name for this class instance.
<static>  
jQuery.tabulate.options.results_per_page
An Array of integer values that will be used to populate the jQuery.tabulate.options.elements.$results_per_page element.
Method Summary
Method Attributes Method Name and Description
<static>  
jQuery.tabulate.options.parse_key()
A function that returns a RegExp object that will be used to parse keys out of strings.
Namespace Detail
jQuery.tabulate.options
The settings jQuery.tabulate will use by default.

Note that any and all of these values can be overwritten as needed by passing them into the tabulate plugin upon initialization.

Field Detail
<static> {Boolean} jQuery.tabulate.options.debug
Whether or not to enable debug mode.
Default Value:
false

<static> {Object} jQuery.tabulate.options.error_handlers
Can be used to override the default error handlers that are defined in jQuery.tabulate.error_handlers.
See:
jQuery.tabulate.error_handlers

<static> {Object} jQuery.tabulate.options.event_handlers
Can be used to override the default event handlers that are defined in jQuery.tabulate.event_handlers.
See:
jQuery.tabulate.event_handlers

<static> {String} jQuery.tabulate.options.name
The name for this class instance.

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.

Default Value:
"tabulate"

<static> {Array} jQuery.tabulate.options.results_per_page
An Array of integer values that will be used to populate the jQuery.tabulate.options.elements.$results_per_page element.
Default Value:
[5, 10, 25]
Method Detail
<static> jQuery.tabulate.options.parse_key()
A function that returns a RegExp object that will be used to parse keys out of strings.

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.

If you're wondering why we are returning the RegExp object inside of a function, see this jQuery bug ticket: #4192. Although this issue has been fixed in jQuery 1.4, I am keeping this in here for backwards compatibility.

Returns:
RegExp The RegExp object

Documentation generated by JsDoc Toolkit 2.3.2 on Tue Oct 12 2010 18:20:11 GMT-0700 (PDT)