org.dashbuilder.displayer.impl

Class TableDisplayerSettingsBuilderImpl

java.lang.Object

org.dashbuilder.dataset.impl.AbstractDataSetLookupBuilder<T>

org.dashbuilder.displayer.impl.AbstractDisplayerSettingsBuilder<TableDisplayerSettingsBuilderImpl>

org.dashbuilder.displayer.impl.TableDisplayerSettingsBuilderImpl

All Implemented Interfaces:

org.dashbuilder.dataset.DataSetLookupBuilder<TableDisplayerSettingsBuilderImpl>, DisplayerSettingsBuilder<TableDisplayerSettingsBuilderImpl>, TableDisplayerSettingsBuilder<TableDisplayerSettingsBuilderImpl>

@Portable
public class TableDisplayerSettingsBuilderImpl
extends AbstractDisplayerSettingsBuilder<TableDisplayerSettingsBuilderImpl>
implements TableDisplayerSettingsBuilder<TableDisplayerSettingsBuilderImpl>

Field Summary

Fields inherited from class org.dashbuilder.displayer.impl.AbstractDisplayerSettingsBuilder

displayerSettings

Constructor Summary

Constructors

Constructor and Description
TableDisplayerSettingsBuilderImpl()

Method Summary

Modifier and Type	Method and Description
DisplayerSettings	createDisplayerSettings()
TableDisplayerSettingsBuilderImpl	tableColumnPickerEnabled(boolean enabled) If true, it enables to show/hide the table columns by means of a column picker widget.
TableDisplayerSettingsBuilderImpl	tableOrderDefault(String columnId, org.dashbuilder.dataset.sort.SortOrder order) Set the default ordering column.
TableDisplayerSettingsBuilderImpl	tableOrderDefault(String columnId, String order) Set the default ordering column.
TableDisplayerSettingsBuilderImpl	tableOrderEnabled(boolean enabled) If true, it enables the table columns to be ordered.
TableDisplayerSettingsBuilderImpl	tablePageSize(int pageSize) Sets the page size (i.e. the number of rows per page) for this table displayer.
TableDisplayerSettingsBuilderImpl	tableWidth(int tableWidth) Set the table total width.

Methods inherited from class org.dashbuilder.displayer.impl.AbstractDisplayerSettingsBuilder

allowCsvExport, allowExcelExport, backgroundColor, buildSettings, dataset, expression, expression, filterOff, filterOn, format, format, format, htmlTemplate, jsTemplate, refreshOff, refreshOn, refreshOn, renderer, subtype, title, titleVisible, uuid, xAxisAngle, xAxisTitle, yAxisTitle

Methods inherited from class org.dashbuilder.dataset.impl.AbstractDataSetLookupBuilder

asc, buildColumnId, buildLookup, column, column, column, column, column, dataset, desc, dynamic, dynamic, dynamic, filter, filter, firstDay, firstMonth, fixed, getCurrentOp, group, group, group, join, rowNumber, rowOffset, select, sort, sort

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dashbuilder.displayer.DisplayerSettingsBuilder

backgroundColor, buildSettings, dataset, expression, expression, filterOff, filterOn, format, format, format, htmlTemplate, jsTemplate, refreshOff, refreshOn, refreshOn, renderer, subtype, title, titleVisible, uuid

Methods inherited from interface org.dashbuilder.dataset.DataSetLookupBuilder

asc, buildLookup, column, column, column, column, column, dataset, desc, dynamic, dynamic, dynamic, filter, filter, firstDay, firstMonth, fixed, group, group, group, join, rowNumber, rowOffset, select, sort, sort

Constructor Detail

TableDisplayerSettingsBuilderImpl

public TableDisplayerSettingsBuilderImpl()

Method Detail

createDisplayerSettings

public DisplayerSettings createDisplayerSettings()

Specified by:

createDisplayerSettings in class AbstractDisplayerSettingsBuilder<TableDisplayerSettingsBuilderImpl>

tablePageSize

public TableDisplayerSettingsBuilderImpl tablePageSize(int pageSize)

Description copied from interface: TableDisplayerSettingsBuilder

Sets the page size (i.e. the number of rows per page) for this table displayer.

Specified by:

tablePageSize in interface TableDisplayerSettingsBuilder<TableDisplayerSettingsBuilderImpl>

Parameters:

pageSize - The page size.

Returns:

The DisplayerSettingsBuilder instance that is being used to configure a Table data displayer.

tableOrderEnabled

public TableDisplayerSettingsBuilderImpl tableOrderEnabled(boolean enabled)

Description copied from interface: TableDisplayerSettingsBuilder

If true, it enables the table columns to be ordered.

Specified by:

tableOrderEnabled in interface TableDisplayerSettingsBuilder<TableDisplayerSettingsBuilderImpl>

Parameters:

enabled - True to enable, false to disable.

Returns:

The DisplayerSettingsBuilder instance that is being used to configure a Table data displayer.

tableOrderDefault

public TableDisplayerSettingsBuilderImpl tableOrderDefault(String columnId,
                                                           org.dashbuilder.dataset.sort.SortOrder order)

Description copied from interface: TableDisplayerSettingsBuilder

Set the default ordering column.

Specified by:

tableOrderDefault in interface TableDisplayerSettingsBuilder<TableDisplayerSettingsBuilderImpl>

Parameters:

columnId - The identifier of the column by which the table should by default be ordered.

order - The sort order to apply on the specified column.

Returns:

The DisplayerSettingsBuilder instance that is being used to configure a Table data displayer.

See Also:

SortOrder

tableOrderDefault

public TableDisplayerSettingsBuilderImpl tableOrderDefault(String columnId,
                                                           String order)

Description copied from interface: TableDisplayerSettingsBuilder

Set the default ordering column.

Specified by:

tableOrderDefault in interface TableDisplayerSettingsBuilder<TableDisplayerSettingsBuilderImpl>

Parameters:

columnId - The identifier of the column by which the table should by default be ordered.

order - The sort order to apply on the specified column, as a String (accepted values are "asc" and "desc".

Returns:

The DisplayerSettingsBuilder instance that is being used to configure a Table data displayer.

tableWidth

public TableDisplayerSettingsBuilderImpl tableWidth(int tableWidth)

Description copied from interface: TableDisplayerSettingsBuilder

Set the table total width.

Specified by:

tableWidth in interface TableDisplayerSettingsBuilder<TableDisplayerSettingsBuilderImpl>

Parameters:

tableWidth - The total table width, in pixels.

Returns:

The DisplayerSettingsBuilder instance that is being used to configure a Table data displayer.

tableColumnPickerEnabled

public TableDisplayerSettingsBuilderImpl tableColumnPickerEnabled(boolean enabled)

Description copied from interface: TableDisplayerSettingsBuilder

If true, it enables to show/hide the table columns by means of a column picker widget.

Specified by:

tableColumnPickerEnabled in interface TableDisplayerSettingsBuilder<TableDisplayerSettingsBuilderImpl>

Parameters:

enabled - True to enable, false to disable.

Returns:

The DisplayerSettingsBuilder instance that is being used to configure a Table data displayer.