Class CAF.Table.Model

Object
   |
   +--CAF.Output.Model
         |
         +--CAF.Input.Model
               |
               +--CAF.Select.Model
                     |
                     +--CAF.Select.Radio.Model
                           |
                           +--CAF.Table.Model

Direct Known Subclasses:

CAF.Tree.Model, CAF.List.Model

class CAF.Table.Model

extends CAF.Select.Radio.Model

Table client-side model.
Defined in table.js

Field Detail

classes

Object classes

CAF.Table.Model

CAF.Table.Model()

addRowChangeListener

void addRowChangeListener(fn, key)

Adds row-change listener. Row-change listener function takes three arguments:
1. table id
2. row id (if available)
3. event type ("add", "remove", "update", or "select")

Parameters:
fn - Row-change listener.
key - (optional) Key with which to unregister listener (defaults to fn).

addTableChangeListener

void addTableChangeListener(fn, key)

Adds table-change listener. Table-change listener function takes one argument:
1. table id
2. event type ("page", "select-all", "select-none")

Parameters:
fn - Table-change listener.
key - (optional) Key with which to unregister listener (defaults to fn).

getFirst

Object getFirst()

(Zero-based) first item in current page.

getRowCount

Object getRowCount()

Total rows in table.

getRows

Object getRows()

Max page size.

getRowSelectedCount

Object getRowSelectedCount()

Total selected rows in table.

go

void go(first, rows, sort)

Pages and/or sorts table (using JSF form paging).

Parameters:
first - First row to display (zero-based), or -1 to ignore.
rows - Number of rows to display, or -1 to ignore.
sort - (optional) Comma-separated column ids to sort on, or null to ignore. Each id should be followed by '+' or '-', to signal ascending or descending. CAF.Table.Model.prototype.Ex = "user+,permissions+,modified-";.

indexOf

Object indexOf(x)

Returns index of specified value or item.

Parameters:
x - Value or existing CAF.Select.Item.Model, or array of values or CAF.Select.Item.Models.

Returns:
Index of item, or -1 for each item not found.

listRowChangeListeners

Object listRowChangeListeners()

Lists registered row-change listeners.

Parameters:
Array - of row-change listener fns. Never null.

listTableChangeListeners

Object listTableChangeListeners()

Lists registered paging listeners.

Parameters:
Array - of paging listener fns. Never null.

move

Object move(from, to)

Moves row(s) from the specified server-side (absolute) index to the specified server-side (absolute) index. Does not move if index out of range. If item or items moved off current page, table does not page.

Parameters:
from - Zero-based item index or array of indicies.
to - Zero-based item index or array of indicies.

refresh

void refresh()

Refreshes the content of this control from the server.

removeRowChangeListener

void removeRowChangeListener(fn)

Removes row-change listener.

Parameters:
fn - Row-change listener.

removeTableChangeListener

void removeTableChangeListener(fn)

Removes paging listener.

Parameters:
fn - Paging listener.

selectAll

void selectAll(selected)

Selects all items.

Parameters:
selected - (optional) True to select all, false to unselect all.

setDisabled

Object setDisabled(disabled)

Sets this control as disabled or enabled.

Returns:
True to disabled, false to enable.

template

Object template()

Returns row model for template row, if available.

Returns:
CAF.Table.Row.Model for template row or null.