webEditors

Module: nmodule/webEditors/rc/wb/table/model/ComponentTableModel

new (require("nmodule/webEditors/rc/wb/table/model/ComponentTableModel"))(params)

API Status: Development

Table model where each row in the table represents a Component.

A ComponentTableModel is backed by a ComponentSource, which provides
the list of Components to build into table rows.

Extends:
Parameters:
Name Type Description
params Object | baja.Component

parameters object, or a Component
if no parameters required.

Properties
Name Type Description
componentSource baja.Component | module:nmodule/webEditors/rc/wb/table/model/ComponentSource

the source of components to build into table rows.
If a Component is given it will just be wrapped in a ComponentSource
with no parameters.
columns Array.<module:nmodule/webEditors/rc/wb/table/model/Column>

Methods

clearRows()

Remove all rows from the model.

Will trigger a rowsRemoved tinyevent, with
parameters:

  • rowsRemoved: the rows that were removed
  • indices: the original indices of the rows that were removed
Inherited From:
Returns:
Type
Promise

getColumn(name)

Get the column in this model matching the given name.

Parameters:
Name Type Description
name String
Inherited From:
Returns:

the matching
column, or null if not found

Type
module:nmodule/webEditors/rc/wb/table/model/Column

getColumnIndex(column)

Get the index of the given column.

Parameters:
Name Type Description
column module:nmodule/webEditors/rc/wb/table/model/Column
Inherited From:
Returns:

the column's index, or -1 if not found

Type
number

getColumns( [flags])

Get the current set of columns, optionally filtered by flags.

Parameters:
Name Type Argument Description
flags Number <optional>

if given, only return columns that have these
flags.
Inherited From:
Returns:
Type
Array.<module:nmodule/webEditors/rc/wb/table/model/Column>

getComponentSource()

Get the ComponentSource backing this table model.

Returns:
Type
module:nmodule/webEditors/rc/wb/table/model/ComponentSource

getEditableColumns()

Return all columns with the EDITABLE flag set.

Inherited From:
Returns:
Type
Array.<module:nmodule/webEditors/rc/wb/table/model/Column>

getRowIndex(row)

Get the index of the given row.

Parameters:
Name Type Description
row module:nmodule/webEditors/rc/wb/table/model/Row
Inherited From:
Returns:

the row's index, or -1 if not found

Type
number

getRows()

Get the current set of rows.

Inherited From:
Returns:
Type
Array.<module:nmodule/webEditors/rc/wb/table/model/Row>

getValueAt(x, y)

Ask the column at the given index for the value from the row at the
given index.

Parameters:
Name Type Description
x Number

column index
y Number

row index
Inherited From:
Returns:

promise to be resolved with the value

Type
Promise

insertColumns(toInsert [, index])

Add new columns to the model. Will trigger a columnsAdded tinyevent.

Parameters:
Name Type Argument Description
toInsert Array.<module:nmodule/webEditors/rc/wb/table/model/Column>
index Number <optional>

index to insert the columns; will append to the
end if omitted
Inherited From:
Returns:

promise to be resolved if the insert is
successful

Type
Promise

insertRows(toInsert [, index])

Add new rows to the model. If non-Row instances are given, they will be
converted to Rows using makeRow().

If a row filter has been set to a non null function the index passed to this
function will be relative to the resulting filtered array returned from getRows().

Will trigger a rowsAdded tinyevent.

Parameters:
Name Type Argument Description
toInsert Array.<(module:nmodule/webEditors/rc/wb/table/model/Row|*)>
index Number <optional>

index to insert the rows; will append to the
end if omitted
Inherited From:
Returns:

promise to be resolved if the insert is
successful

Type
Promise

makeRow(subject)

Instantiate a new row for the given subject. insertRows will delegate
to this if values are passed in rather than Row instances. Override
as necessary.

Parameters:
Name Type Description
subject *
Inherited From:
Returns:
Type
module:nmodule/webEditors/rc/wb/table/model/Row

removeColumns(toRemove [, end])

Remove columns from the model. Will trigger a columnsRemoved tinyevent.

Parameters:
Name Type Argument Description
toRemove Array.<module:nmodule/webEditors/rc/wb/table/model/Column> | Number

the columns to remove; or, start index
end Number <optional>

end index
Inherited From:
Returns:

promise to be resolved if the remove is
successful

Type
Promise

removeRows(toRemove [, end])

Remove rows from the model. Will trigger a rowsRemoved tinyevent, with
parameters:

  • rowsRemoved: the rows that were removed
  • indices: the original indices of the rows that were removed

If a row filter has been set to a non null function any indices passed to this
function will be relative to the resulting filtered array returned from getRows().

Note that rowsRemoved and indices will always be sorted by their
original index in the model's rows, regardless of the order of rows passed
to the removeRows function.

Parameters:
Name Type Argument Description
toRemove Array.<module:nmodule/webEditors/rc/wb/table/model/Row> | Number

the rows to remove; or, start index
end <optional>

end index
Inherited From:
Returns:

promise to be resolved if the remove is
successful

Type
Promise

setRowFilter(rowFilterFunction)

Filter the table's rows according to the given filter function. Setting
the rowFilterFunction to null will remove the current filter and
reset the table model to display all rows.

Will trigger a rowsFiltered tinyevent.

Remember that Array#filter is synchronous, so if the filter needs to use
any data that is asynchronously retrieved, the async work must be performed
before the filter so that the filter function can work synchronously.

Parameters:
Name Type Description
rowFilterFunction function

standard array filter function
Inherited From:
Throws:

if a non-Function is given

Type
Error
Returns:
Type
Promise

sort(sortFunction)

Sort the table's rows according to the given sort function. Emits a
rowsReordered event.

Remember that Array#sort is synchronous, so if the sort needs to use
any data that is asynchronously retrieved, the async work must be performed
before the sort so that the sort function can work synchronously.

Parameters:
Name Type Description
sortFunction function

standard array sort function to receive
two Row instances
Inherited From:
Throws:

if a non-Function is given

Type
Error