Class JsmTable

Object
   |
   +--JsmObject
         |
         +--JsmTable

class JsmTable

extends JsmObject

Represents a table
Defined in net/sf/jsm/table/jsmTable.js

Field Detail

_actionCellSide

<private> String _actionCellSide

Defines if the actions cells should be displayed on the left or right side of the table; Default is 'right'

_columnIdx2ColumnName

<private> Hash _columnIdx2ColumnName

Mapping column idx to column name

_columnIdx2Comparator

<private> Hash _columnIdx2Comparator

Mapping column idx to comparator functions

_columnIdx2FilterGenerationConfig

<private> Array _columnIdx2FilterGenerationConfig

Array holding FilterGenerationConfigurations for filters generated by generateFilter() The value of the array is again an array with the 0th element being the widget and the 1st element being the filter

_columnIdx2PropertyPath

<private> Hash _columnIdx2PropertyPath

Mapping column idx to property paths to store cell values back into JavaBeans

_columnIdx2Widget

<private> Hash _columnIdx2Widget

Mapping column idx to widget

_columnName2ColumnIdx

<private> Hash _columnName2ColumnIdx

Mapping column name to column idx

_dirty

<private> boolean _dirty

Indicates that at least one row of this table is dirty

_filters

<private> Array _filters

Array holding Filter, eg. JsmRegExFilter, JsmExactFilter;

_footer

<private> Array _footer

Array holding the footer rows (JsmTr objects);

_footerActionCells

<private> Array _footerActionCells

Array holding JsmActionCell objects to display in the footer row;

_headerActionCells

<private> Array _headerActionCells

Array holding JsmActionCell objects to display in the header row;

_headerRow

<private> Array _headerRow

Array holding JsmTh objects; can be null

_noRowsToDisplayMessage

<private> String _noRowsToDisplayMessage

The message to show if there are no rows to display; default: There are currently no rows to display

_pageingCurrentStartRow

<private> int _pageingCurrentStartRow

The current start row when paging; defaults to 0

_pageingMaxRows

<private> int _pageingMaxRows

The amount of rows to show when paging; defaults to -1

_resizable

<private> boolean _resizable

Is the table resizable; defaults to false

_rowActionCells

<private> Array _rowActionCells

Array holding JsmActionCell objects to display in the data rows

_rows

<private> Array _rows

Array holding the data rows (JsmTr objects);

_showOnlyHeader

<private> boolean _showOnlyHeader

If set to true only the table header will be shown

_sortColumn

<private> int _sortColumn

the column idx by which the table is currently sorted; defaults to 0

_sortOrder

<private> Object _sortOrder

The tables sorting order: ascending or descending; Values are 'asc' or 'desc'

containerId

String containerId

The id of the element holding the table; Defaults to 'myTableContainer'

variableName

String variableName

The name of the variable holding this JsmTable object; Defaults to 'myTable'

JsmTable

JsmTable(<String> containerId, <String> variableName, <boolean> resizable)

Creates a new JsmTable object

Parameters:
containerId - Optional: The id of the element holding the table; If not specified the default value is 'myTableContainer'
variableName - Optional: The name of the variable holding this JsmTable object; If not specified the default value is 'myTable'
resizable - Optional: Indicates if the table should be resizable; default is false

_isNumberColumn

 <private> boolean _isNumberColumn(<int> columnIdx)

Determins if this column only hold numbers

Parameters:
columnIdx - The column index

Returns:
True if the column holds only number values

_updateRowIndex

 <private> Object _updateRowIndex()

Update the idx of the JsmTr objects

Returns:
this

addColumnName

Object addColumnName(<String> columnName, <int> columnIdx)

Add the name for a column so that they do not have to be refered to be idx

Parameters:
columnName -
columnIdx -

Returns:
this

addComparator

Object addComparator(columnIdxOrName, comparator)

Set the comparator function for this column

Parameters:
comparator - {Function} A comparator function
int - / String} columnIdxOrName

Returns:
this

addFilter

Object addFilter(filter)

Adds a filter;

Parameters:
filter -

Returns:
this

addFilterConfig

Object addFilterConfig(columnIdxOrName, widget, filter)

Add filter configuration for generateFilter() to a column; If already widgets for editing are set it is optional to set them via this method. The ones set by addWidget() would be used together with a {@JsmRegExFilter}

Parameters:
widget - The widget to display as a filter
filter -
int - / String} columnIdxOrName

Returns:
this

addFooter

Object addFooter(<JsmTr> tr)

Add a footer row to this table; Sets the rows meta data 'jsmRowType' to 'footer'.

Parameters:
tr - The row holding the JsmTd objects

Returns:
this

addFooterActionCell

Object addFooterActionCell(<JsmActionCell> theActionCell)

Add a global action Td; will be displayed in the footer row

Parameters:
theActionCell -

Returns:
this

addHeaderActionCell

Object addHeaderActionCell(<JsmActionCell> theActionCell)

Add a global action Td; will be displayed in the header row

Parameters:
theActionCell -

Returns:
this

addPropertyPath

Object addPropertyPath(columnIdxOrName, propertyPath)

Set the property path for this column to set a cells value back on the JavaBean

Parameters:
propertyPath - {String} The propertyPath to set the cell value back on the JavaBean
int - / String} columnIdxOrName

Returns:
this

addRow

Object addRow(<JsmTr> tr, <boolean> renderImmediately)

Add a row to this table

Parameters:
tr - The row holding the JsmTd objects
renderImmediately - True if the added row should be rendered immediately

Returns:
this

addRowActionCell

Object addRowActionCell(<JsmActionCell> theActionCell)

Add a row action Td; will be displayed on side of each row

Parameters:
theActionCell -

Returns:
this

addRows

Object addRows(trs, <boolean> renderImmediately)

Add rows to this table

Parameters:
renderImmediately - True if the added rows should be rendered immediately
Array - } trs Array of JsmTd objects

Returns:
this

addWidget

Object addWidget(columnIdxOrName, widget)

Add a widget to a column; This will be used for editing all cells of this column

Parameters:
widget -
int - || String} columnIdxOrName

Returns:
this

cleanUpAfterSave

Object cleanUpAfterSave()

Clean up after a save, eg. remove edit mode from rows, remove JsmDoubleSelectFieldDiv

Returns:
this

focusOnFirstWidget

Object focusOnFirstWidget()

Sets the focus on the first widget found

Returns:
this

generateFilter

Object generateFilter(<String> filterContainerId, <Array> filterColumnIdxs, <int> horizontalSize)

Generates filter

Parameters:
filterContainerId - The id of the HTML element holding the filter
filterColumnIdxs - Array of column indices; For these columns a filter widget will be generated
horizontalSize - Optional: The number of filter widgets to display beside each other; defaults to 2

Returns:
this

getActionCellSide

String getActionCellSide()

Returns the side on which the action cells should be displayed

getColumnIdx

int getColumnIdx(<String> columnName)

Get column idx by column name

Parameters:
columnName -

Returns:
Index of column

getColumnName

String getColumnName(<int> columnIdx)

Get column name by column idx

Parameters:
columnIdx -

Returns:
Name of the column or null if not specified

getComparator

Function getComparator(<int> columnIdx)

Get the comparator function for this column

Parameters:
columnIdx -

Returns:
A comparator function; The default is JsmAlphaComparator if no comparator was specified

getContainerId

String getContainerId()

Get the id of the container displaying the table

Returns:
containerId

getFilterConfig

Array} getFilterConfig(<int> columnIdx)

Get the filter configuration for a column

Parameters:
columnIdx -

getFilteredRows

Array getFilteredRows()

Get the filtered data JsmTr rows;

getFilters

Array getFilters()

Get all associated filters

getFooter

Array getFooter()

Get the footer JsmTr objects;

getHeaderRow

JsmTr getHeaderRow()

Get the header row

Returns:
null if not set

getNode

Object getNode()

Get the node object; the model (this) will be attached to the node as property 'model'

Returns:
The created node object

getPageingCurrentStartRow

int getPageingCurrentStartRow()

Gets the current start row for paging

getPageingMaxRows

int getPageingMaxRows()

Gets the max number of rows to show

getPropertyPath

String getPropertyPath(<int> columnIdx)

Get the property path for this column to set a cells value back on the JavaBean

Parameters:
columnIdx -

Returns:
The propertyPath to set the cell value back on the JavaBean

getRow

JsmTr getRow(<int> trIdx)

Get the JsmTr object; same as getTr

Parameters:
trIdx - The row index

getRowCount

int getRowCount()

Get the number of data JsmTr rows;

getRows

Array getRows()

Get the data JsmTr rows;

getSortColumn

int getSortColumn()

Returns:
The index of the column currently sorted

getSortOrder

int getSortOrder()

Returns:
The tables sorting order

getTd

JsmTd getTd(<int> trIdx, <int> tdIdx)

Get the JsmTd object

Parameters:
trIdx - The row index
tdIdx - The column index

Returns:
null if not found

getTds

Array getTds(<int> trIdx)

Get the JsmTd objects of this row

Parameters:
trIdx - The row index

Returns:
null if not found

getTr

JsmTr getTr(<int> trIdx)

Get the JsmTr object

Parameters:
trIdx - The row index

getValue

Object getValue(<int> trIdx, <int> tdIdx)

Get the value for the specified cell

Parameters:
trIdx - The row index
tdIdx - The column index

Returns:
The value or null if not defined

getVariableName

String getVariableName()

Set the name of the variable holding this JsmTable object

Returns:
variableName

getWidget

Object getWidget(columnIdxOrName)

Get the widget of a column

Parameters:
int - || String} columnIdxOrName

Returns:
the widget or null if not specified

isDirty

boolean isDirty()

Returns:
Value of the dirty flag

isShowOnlyHeader

boolean isShowOnlyHeader()

Should only the header be shown

removeFilters

Object removeFilters()

Remove all associated filters

Returns:
this

removeRow

Object removeRow(<int> idx)

Remove a row from this table

Parameters:
idx - The row index

Returns:
this

render

Object render()

Render this table into the container

Returns:
this

saveAllRowsInEditMode

Object saveAllRowsInEditMode()

Calles _jsmOnSaveRow for each row in edit mode

Returns:
this

setActionCellSide

Object setActionCellSide(<String> leftOrRight)

Defines if the actions cells should be displayed on the left or right side of the table

Parameters:
leftOrRight - Set to 'left' or 'right'

Returns:
this

setContainerId

Object setContainerId(<String> containerId)

Set the id of the container displaying the table

Parameters:
containerId -

Returns:
this

setDirty

Object setDirty(<boolean> dirty)

Sets the dirty flag; if set to false will propagate this to the child rows

Parameters:
dirty -

Returns:
this

setHeaderRow

Object setHeaderRow(<JsmTr> tr)

Set the header row; Sets the rows meta data 'jsmRowType' to 'header'. Will also set the value of the JsmTh objects as column names if not already specified by addColumnName()

Parameters:
tr - The row holding the JsmTh objects

Returns:
this

setNoRowsToDisplayMessage

Object setNoRowsToDisplayMessage(<String> noRowsToDisplayMessage)

The message to display if there are no rows to diplay

Parameters:
noRowsToDisplayMessage -

Returns:
this

setPageingCurrentStartRow

Object setPageingCurrentStartRow(<int> pageingCurrentStartRow)

Sets the current start row for paging

Parameters:
pageingCurrentStartRow - Zero based

Returns:
this

setPageingMaxRows

Object setPageingMaxRows(<int> pageingMaxRows)

Sets the max number of rows to show

Parameters:
pageingMaxRows -

Returns:
this

setShowOnlyHeader

Object setShowOnlyHeader(<boolean> showOnlyHeader)

Determin if only the header should be shown

Parameters:
showOnlyHeader -

Returns:
this

setSortColumn

Object setSortColumn(<String/int> sortColumn)

Set the sorting column

Parameters:
sortColumn - The column index (the index is zero based) or the column name

Returns:
this

setSortOrder

Object setSortOrder(<String> sortOrder)

Set the sorting order

Parameters:
sortOrder - 'asc' or 'desc'

Returns:
this

setValue

Object setValue(<int> trIdx, <int> tdIdx, <String> value)

Set the value for the specified cell

Parameters:
trIdx - The row index
tdIdx - The column index
value - Can contain HTML tags

Returns:
this

setVariableName

Object setVariableName(<String> variableName)

Set the name of the variable holding this JsmTable object

Parameters:
variableName -

Returns:
this

sort

Object sort(columnIdxOrName)

Sort the rows

Parameters:
columnIdxOrName - (Optional) Column index or name of the colum to sort; if not specified will sort on the currently set {@see #_sortColumn}

Returns:
this

unSetEditModeForAllRows

Object unSetEditModeForAllRows()

Sets the edit mode of every row to false

Returns:
this