Class DataTable

Object
   |
   +--Widget
         |
         +--DataTable

class DataTable

extends Widget

Defined in widgets/datatable.js

Field Detail

anchor

Object anchor

Current anchor row

desc

Boolean desc

Current order direction (true=descending, false=ascending)

root

Object root

Reference to the widget's root node

selected

Array selected

Current selected rows

sortIdx

Number sortIdx

Current sort column index

sortTypes

Object sortTypes

Sort types

table

Object table

Reference to the modified table

tbody

Object tbody

Reference to the table body

thead

Object thead

Reference to the table head

instances

<static> Object instances

Holds existent DataTable instances, indexed by widget ID.

DataTable

DataTable(<Object> attrs, <Function> func)

DataTable is a used that transforms a regular HTML table by adding dynamic behaviors, such as sorting, row highlighting and single/multiple row selection

Parameters:
attrs - Widget's attributes
func - Setup function

_compare

 <private> Number _compare(<Object> a, <Object> b)

Default method to compare 2 cell values. It's used to sort the array of values collected from a table column.

Parameters:
a - Left operand
b - Right operand

_getRowValue

 <private> String _getRowValue(<Object> row, <Number> idx)

Default method to read the text contents of a table cell

Parameters:
row - Table row
idx - Column index

_onResize

 <private> void _onResize()

Table resize handler

_setupRows

 <private> void _setupRows()

Configures CSS classes for all table rows

_setupScroll

 <private> void _setupScroll()

Adds scrollable behavior on the data table

addSortType

void addSortType(<String> type, <Function> valueFunc, <Function> compareFunc, <Function> rowFunc)

Register a new sort type

Parameters:
type - Type name (prefer using uppercase)
valueFunc - Function to traduce cell contents into a comparable value
compareFunc - Function to compare column values
rowFunc - Function to extract contents from a row's cell

getFirstRow

Object getFirstRow()

Get table's first row

getNextRow

Object getNextRow(<Object> row)

Get the previous sibling of a given row

Parameters:
row - Table row

getPreviousRow

Object getPreviousRow(<Object> row)

Get the next sibling of a given row

Parameters:
row - Table row

getSelectedRows

Array getSelectedRows()

Get current selected rows

reset

void reset()

Refreshes sorting and scrolling behaviors. This method should be used when the contents of the table are dinamically changed.

selectHandler

 <private> void selectHandler(<Event> e)

Handles click event on table rows

Parameters:
e - Event

selectRow

void selectRow(<Number> idx, <Boolean> b, r)

Selects or unselects a given table row

Parameters:
idx - Row index
b - Select/unselect
r - Whether 'changeselection' event must be triggered

selectRowUI

 <private> void selectRowUI(<Object> row, <Boolean> b)

Applies selection UI changes on a given row

Parameters:
row - Table row
b - Select/unselect

setup

void setup()

Initializes the widget

sort

void sort(<Number> idx, <Boolean> desc)

Sorts the table by a given column index

Parameters:
idx - Column index, zero based
desc - Descending?

sortHandler

 <private> void sortHandler(<Event> e)

Handles click event on table headers

Parameters:
e - Event