io.jenkins.plugins.datatables

Class TableModel

java.lang.Object

io.jenkins.plugins.datatables.TableModel

public abstract class TableModel
extends Object

Provides a model for tables that are rendered with JQuery DataTables. The model consists of the following parts:

• id for the table
• column model for each column
• content for each row

Author:

Ullrich Hafner

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TableModel.DetailedColumnDefinition A column value attribute that provides a display and sort property so that a JQuery DataTables can use different properties to sort and display a column.

Constructor Summary

Constructors

Constructor and Description
TableModel()

Method Summary

Modifier and Type	Method and Description
abstract List<TableColumn>	getColumns() Returns the table columns.
String	getColumnsDefinition() Returns the column definitions of this table as JSON array.
abstract String	getId() Returns the ID of the table.
abstract List<Object>	getRows() Returns the rows of the table.
TableConfiguration	getTableConfiguration() Returns the configuration of a table.
String	getTableConfigurationDefinition() Returns the configuration of this table as JSON object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TableModel

public TableModel()

Method Detail

getId

public abstract String getId()

Returns the ID of the table. All IDs must be unique on a given web page.

Returns:

the table ID

getColumns

public abstract List<TableColumn> getColumns()

Returns the table columns.

Returns:

the table columns

getColumnsDefinition

public String getColumnsDefinition()

Returns the column definitions of this table as JSON array.

Returns:

the column definitions

See Also:

DataTables API Reference

getRows

public abstract List<Object> getRows()

Returns the rows of the table.

Returns:

the rows

getTableConfiguration

public TableConfiguration getTableConfiguration()

Returns the configuration of a table. This may be overridden to change the configuration of a table.

Returns:

the configuration

getTableConfigurationDefinition

public String getTableConfigurationDefinition()

Returns the configuration of this table as JSON object.

Returns:

the table configuration JSON