[intro]     [up]

Class JavaScripTable


This is the JavaScripTable main class.

Example
//Instantiate the table, passing as arguments an arbitrary identifier and the container
var table = new JavaScripTable("jst", "tableContainer");

//Add the columns to the table
table.addColumn(new Column("Name", JST_TYPE_STRING));
table.addColumn(new Column("Age", JST_TYPE_NUMERIC));
table.addColumn(new Column("Sex", JST_TYPE_STRING));

//Add the rows
table.addRow(new Row(1, ["John Smith", 35, "male"]));
table.addRow(new Row(2, ["Mary Anne", 29, "female"]));

//Render the table
table.render();


Constructor Arguments
Name Type Default Description
id String   This is a unique id for the table
container Object   A reference to the HTML element, or element name or id, that will contain the table
width String The value of JST_DEFAULT_WIDTH constant The width property
align String The value of JST_DEFAULT_ALIGN constant The align property
border String The value of JST_DEFAULT_BORDER constant The border property
padding String The value of JST_DEFAULT_PADDING constant The padding property
spacing String The value of JST_DEFAULT_SPACING constant The spacing property

Properties
Basic properties
container A reference to the HTML element, or element name or id, that will contain the table
id This is a unique id for the table
Appearance and Comportamental properties
align The align property
ascSort Boolean value indicating whether the sort is in ascending (true) or descending (false) order
border The border property
columnHeaderHighlighting The highlighting mode for column headers
cropRepeated If set to true, don't display repeated values on contiguous rows
cropRepeatedTree If set to true, don't display repeated values on contiguous rows and columns, tracking dependent data
identifierName Used to build an ObjectRowMapper, where, in that case, will map the object identifier name
mapperClassName Used to build an ObjectRowMapper, where, in that case, will use this class to instantiate objects
mapperConstructorArguments Used to build an ObjectRowMapper, where, in that case, will use this array as the constructor arguments
maxRows If set to a non-negative number, will limit the number of rows in the table
navigation Defines the table's navigation bar options
onRender A callback function triggered every time the table is rendered
onSelectionChange A callback function triggered when the user changes the row selection
operationMode Defines whether the paging will be done in the client-side or in the server side
padding The padding property
pageOnlySelectAll This flag indicates if the selectAll() method (that is called when the selection type=multiple and the user clicks the header checkbox) will select all rows on current page only (true) or on every page (false)
pageSize When using paging, it's the row number on each page
printing Indicates whether the table is on printing mode, where many features are disabled, like highlighting and the navigation bar
rowCount The callback for table update events
rowFunction The name of the function called when the user clicks a row
rowHighlighting The highlighting mode for rows
selectionType Defines the row selection type
showColumnHeaders A flag indicating whether the column headers will be shown
showSelectAll Indicates whether the table will display a 'master' checkbox for selecting / deselecting all rows when the selection type is JST_SEL_MULTI
sortColumn The column index that is used for sort
spacing The spacing property
updateTableFunction The callback for table update events when in server mode
usePaging Defines the whether the table will display paged results (true) or all results (false)
width The width property
Style classes properties
additionalFooterClass The name of the table additional footer's style class
additionalHeaderClass The name of the table additional header's style class
columnHeaderClass The name of the column header style class
columnHeaderTextClass The name of the column header text style class
editControlClass The name of the table cells' edition controls style class
editControlRadioCheckboxClass The name of the table cells' edition controls style class when edit control is a radio or checkbox
evenRowCellClass The name of even row cells style class
evenRowClass The name of even rows style class
evenRowTextClass The name of even row text style class
evenRowTextWithFunctionClass The name of even row texts style class when it has a cellFunction
footerClass The name of the table footer's style class
headerClass The name of the table header's style class
highlightedColumnHeaderClass The name of the column header style class when the mouse is over it
highlightedColumnHeaderTextClass The name of the column header text style class when the mouse is over it
highlightedEvenRowCellClass The name of even row cells style class when the mouse is over it
highlightedEvenRowClass The name of even rows style class when the mouse is over it
highlightedEvenRowTextClass The name of even row text style class when the mouse is over it
highlightedEvenRowTextWithFunctionClass The name of even row text style class when it has a cellFunction and the mouse is over it
highlightedNavigationLinkClass The name of the table's navigation bar link style class when the mouse is over it
highlightedOddRowCellClass The name of odd row cells style class when the mouse is over it
highlightedOddRowClass The name of odd rows style class when the mouse is over it
highlightedOddRowTextClass The name of odd row text style class when the mouse is over it
highlightedOddRowTextWithFunctionClass The name of odd row text style class when it has a cellFunction and the mouse is over it
invalidEditControlClass The name of the table cells' edition controls style class when the user types an invalid data
navigationClass The name of the table's navigation bar style class
navigationLinkClass The name of the table's navigation bar link style class
oddRowCellClass The name of odd row cells style class
oddRowClass The name of odd rows style class
oddRowTextClass The name of odd row text style class
oddRowTextWithFunctionClass The name of odd row texts style class when it has a cellFunction
selectionControlClass The name of the table's selection controls style class
tableClass The name of the <TABLE> element's style class
Text properties
emptyTableText If set, is the text displayed when the table is empty
footerText The text for the table's footer
headerText The text for the table's header
waitText If set, is the text displayed when the table is being rendered
Label properties
ascLabel Appears besides the sorting column's header when it's sorting in ascending order
descLabel Appears besides the sorting column's header when it's sorting in descending order
falseLabel Displayed on a boolean false value
trueLabel Displayed on a boolean true value
Data separators properties
columnSeparator The separator to be used when between columns
rowSeparator The separator to be used when between rows
valueSeparator The separator to be used when a cell has multiple values (it's value is an Array)
Data parsers properties
booleanParser The default boolean parser
currencyParser The default currency parser
dateParser The default date parser
numberParser The default number parser
stringParser The default string parser
Encoding parsers properties
booleanEncodingParser The default boolean encoding parser
currencyEncodingParser The default currency encoding parser
dateEncodingParser The default date encoding parser
numberEncodingParser The default number encoding parser
stringEncodingParser The default string encoding parser
Custom messages properties
changePageDescription Message displayed in the browser's status bar when the user hovers on the navigation's link to change the current page
changePagePrompt Message propted to the user when changing the current page
changePageSizeDescription Message displayed in the browser's status bar when the user hovers on the navigation's link to change the page size
changePageSizePrompt Message propted to the user when changing the page size
firstPageDescription Message displayed in the browser's status bar when the user hovers on the navigation's link to the first page
firstPageText Text on the navigation bar to the first page's link
invalidColumnMessage Message when an invalid column is being added to the table
invalidRowIdMessage Message when an row with an invalid identifier is being added to the table
invalidRowMessage Message when an an invalid row is being added to the table
invalidTableContainerMessage Message when the table was created using an invalid container
invalidTableIdMessage Message when the table was created using an invalid identifier
lastPageDescription Message displayed in the browser's status bar when the user hovers on the navigation's link to the last page
lastPageText Text on the navigation bar to the last page's link
messagesOnStatusBar When set to true, show messages on the status bar instead of in tooltips
multipleRowText Navigation bar's text when there are multiple rows in the table
nextPageDescription Message displayed in the browser's status bar when the user hovers on the navigation's link to the next page
nextPageText Text on the navigation bar to the next page's link
pageText Navigation bar's text when using paging
previousPageDescription Message displayed in the browser's status bar when the user hovers on the navigation's link to the previous page
previousPageText Text on the navigation bar to the previous page's link
rowIdAlreadyInUseMessage Message when the identifier of the row being added is already in use by another row
showAllDescription Message displayed in the browser's status bar when the user hovers on the navigation's link to show all rows
showAllText Text on the navigation bar to the show all's link
singleRowText Navigation bar's text when there is a single row in the table
sortMessage Message displayed in the browser's status bar when the cursor is above a sortable columnMessage displayed in the browser's status bar when the cursor is above a sortable column
tableNotInitializedMessage Message when the the table's render() method is called, and the table's mandatory properties were not correctly set
topDescription Message displayed in the browser's status bar when the user hovers on the navigation's link to the table's top anchor
topText Text on the navigation bar to the anchor to the table's top link
usePagingDescription Message displayed in the browser's status bar when the user hovers on the navigation's link to show paged rows
usePagingText Text on the navigation bar to the use paging's link

Methods
Rendering Methods
render Renders the table
update Updates the table after any modifications
Column Manipulation Methods
addColumn Adds the column to the table
getAllColumns Returns all table columns
getColumnByIndex Return the column with the specified index
getColumnCount Returns the number of columns on the table
getSortColumn Returns the current sort column
getVisibleColumns Returns all table visible columns
removeAllColumns Removes all table columns
removeColumn Removes a table column
Row Manipulation Methods
addRow Adds the row to the table
getAllRowIds Returns all row identifiers
getAllRows Returns all rows
getRowById Returns the specified row
getRowCount Returns the row count
getSelectedRowCount Returns the selected row count
getSelectedRowIds Returns the selected row identifiers
getSelectedRows Returns the selected rows
removeAllRows Removes all rows
removeRowById Removes the row with the specified id
removeSelectedRows Removes all selected rows
updateRow Update the row on the table
Header and Footer Methods
addFooter Adds a footer row, returning it
addHeader Adds a header row, returning it
clearFooters Removes all footer rows
clearHeaders Removes all header rows
getFooter Returns the footer associated with the given index
getFooterCount Returns the number of additional footer rows
getHeader Returns the header associated with the given index
getHeaderCount Returns the number of additional header rows
Data Manipulation Methods
encode Encodes the data on a single String
getAllRowsAsObjects The rows converted into objects using the table's ObjectRowMapper
getCellValue Returns the value of the specified cell
getFormattedCellValue Returns the formatted value of the specified cell
getObjectRowMapper Returns an ObjectRowMapper for the table
getRowByIdAsObject Returns the specified row, converted into object using the table's ObjectRowMapper
getSelectedRowsAsObjects Returns the selected rows converted into objects using the table's ObjectRowMapper
setCellValue Sets the value of the specified cell
setFormattedCellValue Sets the formatted value of the specified cell
Navigation Methods
changePage Sets the current page
changePageSize Sets the current page size
setPage Sets the table current page, updating the table
setSort Sets the column to sort data, updating the table
setUsePaging Sets if rows will be paged (true) or displayed all at once (false), updating the table
Misc Methods
getMaxPage Returns the last visible page
getRowCount Returns number of rows on the table
selectAll Makes all rows to be selected or not, according to the specified flag
setSelection Makes the row with the specified id to be selected or not, according to the specified flag
Highlighting helper methods
buildHighlightingConstant Return the constant for the given parts
buildHighlightingParts Return the parts for the given constant
getColumnHeaderHighlightingParts Returns the column header highlighting parts
getRowHighlightingParts Returns the row highlighting parts
setColumnHeaderHighlightingParts Sets the column header highlighting with individual parts
setRowHighlightingParts Sets the row highlighting with individual parts


Properties
Basic properties
Basic table properties
container
A reference to the HTML element, or element name or id, that will contain the table
id
This is a unique id for the table


Appearance and Comportamental properties
properties that defines the table appearance or behavior
align
The align property
ascSort
Boolean value indicating whether the sort is in ascending (true) or descending (false) order
border
The border property
columnHeaderHighlighting
The highlighting mode for column headers
cropRepeated
If set to true, don't display repeated values on contiguous rows
cropRepeatedTree
If set to true, don't display repeated values on contiguous rows and columns, tracking dependent data. Only makes sense when cropRepeated is true or column.cropRepeated is true
identifierName
Used to build an ObjectRowMapper, where, in that case, will map the object identifier name
mapperClassName
Used to build an ObjectRowMapper, where, in that case, will use this class to instantiate objects
mapperConstructorArguments
Used to build an ObjectRowMapper, where, in that case, will use this array as the constructor arguments
maxRows
If set to a non-negative number, will limit the number of rows in the table
navigation
Defines the table's navigation bar options
onRender
A callback function triggered every time the table is rendered. The table instance itself passed as parameter
onSelectionChange
A callback function triggered when the user changes the row selection. The passed parameters are: the row identifier, a flag indicating the new value and the table reference
operationMode
Defines whether the paging will be done in the client-side or in the server side
padding
The padding property
pageOnlySelectAll
This flag indicates if the selectAll() method (that is called when the selection type=multiple and the user clicks the header checkbox) will select all rows on current page only (true) or on every page (false). This only makes sense when the operation mode is client-side, the results are paged and the selection type is multiple.
pageSize
When using paging, it's the row number on each page
printing
Indicates whether the table is on printing mode, where many features are disabled, like highlighting and the navigation bar
rowCount
The callback for table update events
rowFunction
The name of the function called when the user clicks a row. The row id is passed as argument
rowHighlighting
The highlighting mode for rows
selectionType
Defines the row selection type
showColumnHeaders
A flag indicating whether the column headers will be shown
showSelectAll
Indicates whether the table will display a 'master' checkbox for selecting / deselecting all rows when the selection type is JST_SEL_MULTI
sortColumn
The column index that is used for sort. -1 means no sort
spacing
The spacing property
updateTableFunction
The callback for table update events when in server mode. The table itself will be passed by parameter. Then the table's properties like currentPage, sortColumn and ascSort may be readed for doing the correct actions
usePaging
Defines the whether the table will display paged results (true) or all results (false)
width
The width property


Style classes properties
CSS classes for table elements
additionalFooterClass
The name of the table additional footer's style class
additionalHeaderClass
The name of the table additional header's style class
columnHeaderClass
The name of the column header style class
columnHeaderTextClass
The name of the column header text style class
editControlClass
The name of the table cells' edition controls style class
editControlRadioCheckboxClass
The name of the table cells' edition controls style class when edit control is a radio or checkbox
evenRowCellClass
The name of even row cells style class
evenRowClass
The name of even rows style class
evenRowTextClass
The name of even row text style class
evenRowTextWithFunctionClass
The name of even row texts style class when it has a cellFunction
footerClass
The name of the table footer's style class
headerClass
The name of the table header's style class
highlightedColumnHeaderClass
The name of the column header style class when the mouse is over it
highlightedColumnHeaderTextClass
The name of the column header text style class when the mouse is over it
highlightedEvenRowCellClass
The name of even row cells style class when the mouse is over it
highlightedEvenRowClass
The name of even rows style class when the mouse is over it
highlightedEvenRowTextClass
The name of even row text style class when the mouse is over it
highlightedEvenRowTextWithFunctionClass
The name of even row text style class when it has a cellFunction and the mouse is over it
highlightedNavigationLinkClass
The name of the table's navigation bar link style class when the mouse is over it
highlightedOddRowCellClass
The name of odd row cells style class when the mouse is over it
highlightedOddRowClass
The name of odd rows style class when the mouse is over it
highlightedOddRowTextClass
The name of odd row text style class when the mouse is over it
highlightedOddRowTextWithFunctionClass
The name of odd row text style class when it has a cellFunction and the mouse is over it
invalidEditControlClass
The name of the table cells' edition controls style class when the user types an invalid data
navigationClass
The name of the table's navigation bar style class
navigationLinkClass
The name of the table's navigation bar link style class
oddRowCellClass
The name of odd row cells style class
oddRowClass
The name of odd rows style class
oddRowTextClass
The name of odd row text style class
oddRowTextWithFunctionClass
The name of odd row texts style class when it has a cellFunction
selectionControlClass
The name of the table's selection controls style class
tableClass
The name of the <TABLE> element's style class


Text properties
Table text properties
emptyTableText
If set, is the text displayed when the table is empty. Otherwise an empty table will be drawed
footerText
The text for the table's footer. An empty value makes the table to have no footer
headerText
The text for the table's header. An empty value makes the table to have no header
waitText
If set, is the text displayed when the table is being rendered


Label properties
The labels may be strings or an Image instance. If the label is intented to be an image, an Image instance will preload the images. An string with an <img> tag would make the table download the image every time
ascLabel
Appears besides the sorting column's header when it's sorting in ascending order
descLabel
Appears besides the sorting column's header when it's sorting in descending order
falseLabel
Displayed on a boolean false value
trueLabel
Displayed on a boolean true value


Data separators properties
Separator characters used on data encode
columnSeparator
The separator to be used when between columns
rowSeparator
The separator to be used when between rows
valueSeparator
The separator to be used when a cell has multiple values (it's value is an Array)


Data parsers properties
Default parsers used on data entry
booleanParser
The default boolean parser
currencyParser
The default currency parser
dateParser
The default date parser
numberParser
The default number parser
stringParser
The default string parser


Encoding parsers properties
Default parsers used on data encoding
booleanEncodingParser
The default boolean encoding parser
currencyEncodingParser
The default currency encoding parser
dateEncodingParser
The default date encoding parser
numberEncodingParser
The default number encoding parser
stringEncodingParser
The default string encoding parser


Custom messages properties
The table messages. Used for customization and internationalization
changePageDescription
Message displayed in the browser's status bar when the user hovers on the navigation's link to change the current page
changePagePrompt
Message propted to the user when changing the current page
changePageSizeDescription
Message displayed in the browser's status bar when the user hovers on the navigation's link to change the page size
changePageSizePrompt
Message propted to the user when changing the page size
firstPageDescription
Message displayed in the browser's status bar when the user hovers on the navigation's link to the first page
firstPageText
Text on the navigation bar to the first page's link
invalidColumnMessage
Message when an invalid column is being added to the table
invalidRowIdMessage
Message when an row with an invalid identifier is being added to the table
invalidRowMessage
Message when an an invalid row is being added to the table
invalidTableContainerMessage
Message when the table was created using an invalid container
invalidTableIdMessage
Message when the table was created using an invalid identifier
lastPageDescription
Message displayed in the browser's status bar when the user hovers on the navigation's link to the last page
lastPageText
Text on the navigation bar to the last page's link
messagesOnStatusBar
When set to true, show messages on the status bar instead of in tooltips
multipleRowText
Navigation bar's text when there are multiple rows in the table
nextPageDescription
Message displayed in the browser's status bar when the user hovers on the navigation's link to the next page
nextPageText
Text on the navigation bar to the next page's link
pageText
Navigation bar's text when using paging. 2 variables can be used within the text: ${current} and ${total}
previousPageDescription
Message displayed in the browser's status bar when the user hovers on the navigation's link to the previous page
previousPageText
Text on the navigation bar to the previous page's link
rowIdAlreadyInUseMessage
Message when the identifier of the row being added is already in use by another row
showAllDescription
Message displayed in the browser's status bar when the user hovers on the navigation's link to show all rows
showAllText
Text on the navigation bar to the show all's link
singleRowText
Navigation bar's text when there is a single row in the table
sortMessage
Message displayed in the browser's status bar when the cursor is above a sortable columnMessage displayed in the browser's status bar when the cursor is above a sortable column
tableNotInitializedMessage
Message when the the table's render() method is called, and the table's mandatory properties were not correctly set
topDescription
Message displayed in the browser's status bar when the user hovers on the navigation's link to the table's top anchor
topText
Text on the navigation bar to the anchor to the table's top link
usePagingDescription
Message displayed in the browser's status bar when the user hovers on the navigation's link to show paged rows
usePagingText
Text on the navigation bar to the use paging's link




Methods
Rendering Methods
Methods for rendering/updating the table
 
render
Renders the table. Should be called only once, after all columns/rows are added to the table. After that, modifications should be displayed via the update() method
 
update
Updates the table after any modifications


Column Manipulation Methods
Methods for adding/removing/retrieving columns
 
addColumn
Adds the column to the table
Arguments
Name Type Default Description
column Column   The Column instance to add
 
getAllColumns
Returns all table columns
 
getColumnByIndex
Return the column with the specified index
Arguments
Name Type Default Description
index Number   The column index
 
getColumnCount
Returns the number of columns on the table
 
getSortColumn
Returns the current sort column. If none, return null
 
getVisibleColumns
Returns all table visible columns
 
removeAllColumns
Removes all table columns
 
removeColumn
Removes a table column
Arguments
Name Type Default Description
index Number   The column index


Row Manipulation Methods
Methods for adding/removing/retrieving rows
 
addRow
Adds the row to the table. The row id must be unique
Arguments
Name Type Default Description
row Row or Object   The Row instance to add, or, when the table has the identifierName and the columns the propertyName correctly set, may be an object that will be mapped to a row
refresh boolean false Should the table be refreshed to display the changes?
 
getAllRowIds
Returns all row identifiers
 
getAllRows
Returns all rows
 
getRowById
Returns the specified row
Arguments
Name Type Default Description
id Object   The row id
 
getRowCount
Returns the row count
 
getSelectedRowCount
Returns the selected row count
 
getSelectedRowIds
Returns the selected row identifiers
 
getSelectedRows
Returns the selected rows
 
removeAllRows
Removes all rows
Arguments
Name Type Default Description
refresh boolean false Should the table be refreshed to display the changes?
 
removeRowById
Removes the row with the specified id
Arguments
Name Type Default Description
id Object   The Row id
refresh boolean false Should the table be refreshed to display the changes?
 
removeSelectedRows
Removes all selected rows
Arguments
Name Type Default Description
refresh boolean false Should the table be refreshed to display the changes?
 
updateRow
Update the row on the table. If the row id does not exist on the table, nothing happens
Arguments
Name Type Default Description
row Row or Object   The Row instance to add, or, when the table has the identifierName and the columns the propertyName correctly set, may be an object that will be mapped to a row
refresh boolean false Should the table be refreshed to display the changes?


Header and Footer Methods
Methods for creating headers and footers
 
addFooter
Adds a footer row, returning it. Any arguments will be passed on to the JavaScripTableCellContainer class
 
addHeader
Adds a header row, returning it. Any arguments will be passed on to the JavaScripTableCellContainer class
 
clearFooters
Removes all footer rows
 
clearHeaders
Removes all header rows
 
getFooter
Returns the footer associated with the given index
 
getFooterCount
Returns the number of additional footer rows
 
getHeader
Returns the header associated with the given index
 
getHeaderCount
Returns the number of additional header rows


Data Manipulation Methods
Methods for setting/getting cell data
 
encode
Encodes the data on a single String. If the data is an Array, join the values with the table's rowSeparator. If the array items are Row instances, their encode() method is called. The columns to be encoded may also be specified, as well as if the row id will be encoded or not
Arguments
Name Type Default Description
data Object   The data to be encoded
columns Number[] All columns The columns to be encoded when the data is a Row or a Row Array
encodeRowId boolean true Will the row identifier be encoded toghether?
 
getAllRowsAsObjects
The rows converted into objects using the table's ObjectRowMapper. When the table has no mapper, the array will contain Row instances
 
getCellValue
Returns the value of the specified cell
Arguments
Name Type Default Description
rowId Object   The row identifier
columnIndex Number   The column index
 
getFormattedCellValue
Returns the formatted value of the specified cell. The column parser is used to format the value
Arguments
Name Type Default Description
rowId Object   The row identifier
columnIndex Number   The column index
 
getObjectRowMapper
Returns an ObjectRowMapper for the table. If the table identifierName is not set, return null
 
getRowByIdAsObject
Returns the specified row, converted into object using the table's ObjectRowMapper. When the table has no mapper, the return will be the Row itself
Arguments
Name Type Default Description
id Object   The row id
 
getSelectedRowsAsObjects
Returns the selected rows converted into objects using the table's ObjectRowMapper. When the table has no mapper, the array will contain Row instances
 
setCellValue
Sets the value of the specified cell
Arguments
Name Type Default Description
rowId Object   The row identifier
columnIndex Number   The column index
value Object   The cell value. The type must be an instance of the column type
refresh boolean false Should the table be refreshed to display the changes?
 
setFormattedCellValue
Sets the formatted value of the specified cell. The column parser is used to parse the String
Arguments
Name Type Default Description
rowId Object   The row identifier
columnIndex Number   The column index
value String   The formatted value
refresh boolean false Should the table be refreshed to display the changes?


Navigation Methods
Methods to navigate on the table
 
changePage
Sets the current page. If the page is not specified, prompts the user for the page
Arguments
Name Type Default Description
page Number Prompts the user The page number
 
changePageSize
Sets the current page size. If the size is not specified, prompts the user for the size
Arguments
Name Type Default Description
size Number Prompts the user The page size number
 
setPage
Sets the table current page, updating the table. Only for client-side operation
Arguments
Name Type Default Description
page Number   The page number to navigate
 
setSort
Sets the column to sort data, updating the table. Only for client-side operation
Arguments
Name Type Default Description
columnIndex Number   The column index to sort
asc boolean Will invert the sort if the column is the current sort column. Otherwise, true Will the sort be in ascending order?
 
setUsePaging
Sets if rows will be paged (true) or displayed all at once (false), updating the table. Only for client-side operation
Arguments
Name Type Default Description
flag boolean   The paging flag


Misc Methods
Other methods
 
getMaxPage
Returns the last visible page
 
getRowCount
Returns number of rows on the table
 
selectAll
Makes all rows to be selected or not, according to the specified flag
Arguments
Name Type Default Description
flag boolean   Will the rows be selected or not?
 
setSelection
Makes the row with the specified id to be selected or not, according to the specified flag
Arguments
Name Type Default Description
rowId Object   The row id
flag boolean   Will the row be selected or not?


Highlighting helper methods
Methods to make easier to retrieve / set highlighting parts
 
buildHighlightingConstant
Return the constant for the given parts
Arguments
Name Type Default Description
row boolean   Has row highlighting?
cell boolean   Has cell highlighting?
text boolean   Has text highlighting?
 
buildHighlightingParts
Return the parts for the given constant
Arguments
Name Type Default Description
constant string   The highlighting constant
 
getColumnHeaderHighlightingParts
Returns the column header highlighting parts
 
getRowHighlightingParts
Returns the row highlighting parts
 
setColumnHeaderHighlightingParts
Sets the column header highlighting with individual parts
Arguments
Name Type Default Description
cell boolean   Has cell highlighting?
text boolean   Has text highlighting?
update boolean   Will the table be updated?
 
setRowHighlightingParts
Sets the row highlighting with individual parts
Arguments
Name Type Default Description
row boolean   Has row highlighting?
cell boolean   Has cell highlighting?
text boolean   Has text highlighting?
update boolean   Will the table be updated?