Package org.dashbuilder.displayer

Interface TableDisplayerSettingsBuilder<T extends TableDisplayerSettingsBuilder>

  • All Superinterfaces:
    org.dashbuilder.dataset.DataSetLookupBuilder<T>, DisplayerSettingsBuilder<T>
    All Known Implementing Classes:
    TableDisplayerSettingsBuilderImpl
    public interface TableDisplayerSettingsBuilder<T extends TableDisplayerSettingsBuilder>
extends DisplayerSettingsBuilder<T>
    A displayer settings builder for tables 
       DisplayerSettingsFactory.newTableSettings()
   .title("List of Opportunities")
   .tablePageSize(20)
   .tableOrderEnabled(true)
   .tableOrderDefault("amount", "desc")
   .buildSettings()

    • Method Detail

      • tablePageSize

        T tablePageSize​(int pageSize)
        Sets the page size (i.e. the number of rows per page) for this table displayer.
        Parameters:
        pageSize - The page size.
        Returns:
        The DisplayerSettingsBuilder instance that is being used to configure a Table data displayer.

      • tableOrderEnabled

        T tableOrderEnabled​(boolean enabled)
        If true, it enables the table columns to be ordered.
        Parameters:
        enabled - True to enable, false to disable.
        Returns:
        The DisplayerSettingsBuilder instance that is being used to configure a Table data displayer.

      • tableOrderDefault

        T tableOrderDefault​(String columnId,
                    org.dashbuilder.dataset.sort.SortOrder order)
        Set the default ordering column.
        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

        T tableOrderDefault​(String columnId,
                    String order)
        Set the default ordering column.
        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

        T tableWidth​(int tableWidth)
        Set the table total width.
        Parameters:
        tableWidth - The total table width, in pixels.
        Returns:
        The DisplayerSettingsBuilder instance that is being used to configure a Table data displayer.

      • tableColumnPickerEnabled

        T tableColumnPickerEnabled​(boolean enabled)
        If true, it enables to show/hide the table columns by means of a column picker widget.
        Parameters:
        enabled - True to enable, false to disable.
        Returns:
        The DisplayerSettingsBuilder instance that is being used to configure a Table data displayer.

      • resizable

        T resizable​(boolean enabled)
        If true, makes the table with full width and responsible
        Parameters:
        enabled - True to enable, false to disable.
        Returns:
        The DisplayerSettingsBuilder instance that is being used to configure a Table data displayer.