Package io.jenkins.plugins.datatables

Klasse TableConfiguration

java.lang.Object

io.jenkins.plugins.datatables.TableConfiguration

public class TableConfiguration
extends Object

Provides a configuration for the whole DataTable. This is merged with a default configuration in table.js.

Autor:

Andreas Pabst

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static enum	TableConfiguration.SelectStyle	The possible values of the select.style option, which is used for enabling the selection for datatables and setting its style (the default is TableConfiguration.SelectStyle.OS.

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
TableConfiguration()

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
TableConfiguration	buttons()	Enable the default buttons.
TableConfiguration	buttons(String... types)	Enable specific buttons.
TableConfiguration	colReorder()	Enable reordering of table columns.
String	getConfiguration()	Get the configuration as JSON.
boolean	isUseButtons()	Returns whether buttons were configured to be used.
boolean	isUseColReorder()	Returns whether column reordering was configured to be used.
boolean	isUsePaging()	Returns whether paging is configured to be used.
boolean	isUseResponsive()	Returns whether the responsive extension was configured to be used.
boolean	isUseSelect()	Returns whether select is configured to be used.
boolean	isUseStateSave()	Returns whether stateSave is configured to be used.
TableConfiguration	noPaging()	Disable paging.
TableConfiguration	responsive()	Make the table responsive, i.e.
TableConfiguration	select(TableConfiguration.SelectStyle selectStyle)	Enable selection.
TableConfiguration	stateSave()	Enable saving of the table state.

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

TableConfiguration

public TableConfiguration()

Methodendetails

responsive

public TableConfiguration responsive()

Make the table responsive, i.e. the columns wrap over to a child column.

Gibt zurück:

this TableConfiguration for chaining methods

Siehe auch:

• https://datatables.net/extensions/responsive/

isUseResponsive

public boolean isUseResponsive()

Returns whether the responsive extension was configured to be used.

Gibt zurück:

true, if the responsive extension should be used, false otherwise

colReorder

public TableConfiguration colReorder()

Enable reordering of table columns.

Gibt zurück:

this TableConfiguration for chaining methods

Siehe auch:

• https://datatables.net/extensions/colreorder/

isUseColReorder

public boolean isUseColReorder()

Returns whether column reordering was configured to be used.

Gibt zurück:

true, if column reordering should be used, false otherwise

buttons

public TableConfiguration buttons()

Enable the default buttons.

Gibt zurück:

this TableConfiguration for chaining methods

Siehe auch:

• https://datatables.net/extensions/buttons/

buttons

public TableConfiguration buttons(String... types)

Enable specific buttons.

Parameter:

types - List of buttons to use

Gibt zurück:

this TableConfiguration for chaining methods

Siehe auch:

• https://datatables.net/extensions/buttons/built-in

isUseButtons

public boolean isUseButtons()

Returns whether buttons were configured to be used.

Gibt zurück:

true, if buttons should be used, false otherwise

select

public TableConfiguration select(TableConfiguration.SelectStyle selectStyle)

Enable selection.

Parameter:

selectStyle - The selection style

Gibt zurück:

this TableConfiguration for chaining methods

Siehe auch:

• https://datatables.net/reference/option/select

isUseSelect

public boolean isUseSelect()

Returns whether select is configured to be used.

Gibt zurück:

true, if select should be used, false otherwise

stateSave

public TableConfiguration stateSave()

Enable saving of the table state.

Gibt zurück:

this TableConfiguration for chaining methods

Siehe auch:

• https://datatables.net/reference/option/stateSave

isUseStateSave

public boolean isUseStateSave()

Returns whether stateSave is configured to be used.

Gibt zurück:

true, if stateSave should be used, false otherwise

noPaging

public TableConfiguration noPaging()

Disable paging.

Gibt zurück:

this TableConfiguration for chaining methods

Siehe auch:

• https://datatables.net/reference/option/paging

isUsePaging

public boolean isUsePaging()

Returns whether paging is configured to be used.

Gibt zurück:

true, if paging should be used, false otherwise.

getConfiguration

public String getConfiguration()

Get the configuration as JSON.

Gibt zurück:

a JSON Object with the configuration