io.jenkins.plugins.datatables.api

Class TableModel

java.lang.Object

io.jenkins.plugins.datatables.api.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:

• header name for each column
• column definition for each column
• width for each column
• row content
• content for each row

Author:

Ullrich Hafner

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TableModel.ColumnDefinitionBuilder A JQuery DataTables column definition builder.
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
protected abstract void	configureColumns(TableModel.ColumnDefinitionBuilder builder) Configures the columns of the report table.
String	getColumnsDefinition() Returns the column definitions of the table.
abstract List<String>	getHeaders() Returns the table header labels of the table.
abstract String	getId() Returns the ID of the table.
abstract List<Object>	getRows() Returns the rows of the table.
abstract List<Integer>	getWidths() Returns the widths of the table columns.

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

getHeaders

public abstract List<String> getHeaders()

Returns the table header labels of the table.

Returns:

the table headers

getWidths

public abstract List<Integer> getWidths()

Returns the widths of the table columns.

Returns:

the width of the table columns

getColumnsDefinition

public final String getColumnsDefinition()

Returns the column definitions of the table.

Returns:

the column definitions

configureColumns

protected abstract void configureColumns(TableModel.ColumnDefinitionBuilder builder)

Configures the columns of the report table.

Parameters:

builder - the columns definition builder

getRows

public abstract List<Object> getRows()

Returns the rows of the table.

Returns:

the rows