io.jenkins.plugins.datatables.api

Class TableColumn

java.lang.Object

io.jenkins.plugins.datatables.api.TableColumn

public class TableColumn
extends Object

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

• header label
• header CSS class
• column definition
• width
• tooltip

Author:

Ullrich Hafner

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TableColumn.ColumnCss Supported CSS classes that will enable special handling or rendering for table columns.

Constructor Summary

Constructors

Constructor and Description
TableColumn(String headerLabel, String dataPropertyName) Creates a simple column: it maps the specified property of the row entity to the column value.
TableColumn(String headerLabel, String dataPropertyName, String columnDataType) Creates a complex column: it maps the specified property of the row entity to the display and sort attributes of the column.

Method Summary

Modifier and Type	Method and Description
String	getDefinition()
String	getHeaderClass()
String	getHeaderLabel()
int	getWidth()
TableColumn	setHeaderClass(TableColumn.ColumnCss headerClass) Sets the CSS class for the column <th> tag.
TableColumn	setWidth(int width) Sets the width of the column.

Methods inherited from class java.lang.Object

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

Constructor Detail

TableColumn

public TableColumn(String headerLabel,
                   String dataPropertyName)

Creates a simple column: it maps the specified property of the row entity to the column value.

Parameters:

headerLabel - the label of the column header

dataPropertyName - the property to extract from the entity, it will be shown as column value

TableColumn

public TableColumn(String headerLabel,
                   String dataPropertyName,
                   String columnDataType)

Creates a complex column: it maps the specified property of the row entity to the display and sort attributes of the column. The property dataPropertyName must be of type TableModel.DetailedColumnDefinition.

Parameters:

headerLabel - the label of the column header

dataPropertyName - the property to extract from the entity, it will be shown as column value

columnDataType - JQuery DataTables data type of the column

Method Detail

setHeaderClass

public TableColumn setHeaderClass(TableColumn.ColumnCss headerClass)

Sets the CSS class for the column <th> tag. Multiple classes need to be separated using a space.

Parameters:

headerClass - the CSS class(es) for the <th> tag

Returns:

this column

setWidth

public TableColumn setWidth(int width)

Sets the width of the column. Will be expanded to the class col-width-[width], see jenkins-style.css for details about the actual percentages.

Parameters:

width - the width CSS class to select for the column

Returns:

this column

getHeaderLabel

public String getHeaderLabel()

getHeaderClass

public String getHeaderClass()

getWidth

public int getWidth()

getDefinition

public String getDefinition()