Package org.vaadin.tatu

Class BeanTable.Column<R>

java.lang.Object
org.vaadin.tatu.BeanTable.Column<R>
Type Parameters:
R - Bean type
All Implemented Interfaces:
Serializable
Enclosing class:
BeanTable<T>
public class BeanTable.Column<R> extends Object implements Serializable
Configuration class for the Columns.
See Also:

  • Constructor Details

    • Column

      public Column(String header, com.vaadin.flow.function.ValueProvider<T,?> valueProvider)
      Constructor with header and value provider
      Parameters:
      header - The header as text
      valueProvider - The valuprovider

    • Column

      public Column()
      Constructor without parameters

  • Method Details

    • setHeader

      public BeanTable<T>.Column<R> setHeader(String header)
      Set column header as String
      Parameters:
      header - String for header
      Returns:
      Column for chaining

    • setHeader

      public BeanTable<T>.Column<R> setHeader(com.vaadin.flow.component.Component header)
      Set column header as a Component
      Parameters:
      header - Component used for header
      Returns:
      Column for chaining

    • getHeader

      public com.vaadin.flow.component.Component getHeader()

    • setTooltipProvider

      public BeanTable<T>.Column<R> setTooltipProvider(BeanTable.StringProvider<T> tooltipProvider)
      Set tooltip provider function for the column,

      Note: Not tooltip provider applied on component columns. Add tooltip to the component directly.

      Parameters:
      tooltipProvider - StringProvider Lambda callback bean instance for the Column.
      Returns:
      Column for chaining

    • getTooltipProvider

      public BeanTable.StringProvider<T> getTooltipProvider()

    • setComponentProvider

      public BeanTable<T>.Column<R> setComponentProvider(BeanTable.ComponentProvider<T> componentProvider)
      Set component provider function for the column,
      Parameters:
      componentProvider - ComponnetProvider Lambda callback bean instance for the Column.
      Returns:
      Column for chaining

    • getComponentProvider

      public BeanTable.ComponentProvider<T> getComponentProvider()

    • getValueProvider

      public com.vaadin.flow.function.ValueProvider<T,?> getValueProvider()

    • setClassNameProvider

      public BeanTable<T>.Column<R> setClassNameProvider(BeanTable.StringProvider<T> classNameProvider)
      Set class name provider for a table column, i.e. cells in the column.
      Parameters:
      classNameProvider - StringProvider Lambda callback bean instance to String.
      Returns:
      Column for chaining

    • getClassNameProvider

      public BeanTable.StringProvider<T> getClassNameProvider()

    • setAlignment

      public BeanTable<T>.Column<R> setAlignment(BeanTable.ColumnAlignment alignment)
      Set vertical alignment of the cell content, CENTER, LEFT, RIGHT.
      Parameters:
      alignment - ColumnAlignment, null to unset.
      Returns:
      Column for chaining

    • getAlignment

      public BeanTable.ColumnAlignment getAlignment()

    • setWidth

      public BeanTable<T>.Column<R> setWidth(String width)
      Set the width of the column.
      Parameters:
      width - CSS compatible width string, null to unset.
      Returns:
      Column for chaining

    • getWidth

      public String getWidth()

    • setKey

      public BeanTable<T>.Column<R> setKey(String key)
      Set unique key for the column
      Parameters:
      key - String value
      Returns:
      Column for chaining

    • getKey

      public String getKey()
      Gets the key of the column. Keys are automatically set if columns are created by property names, in that case key is the property name.
      Returns:
      The key, can be null

    • setRowHeader

      public BeanTable<T>.Column<R> setRowHeader(boolean rowHeader)
      Sets the row header nature for the column for accessibility.
      Parameters:
      rowHeader - Use true if this column should act as row header.
      Returns:
      Column for chaining

    • isRowHeader

      public boolean isRowHeader()
      Returns if true if this column acts as row header.
      Returns:
      Boolean value.

    • setVisible

      public BeanTable<T>.Column<R> setVisible(boolean visible)
      Set the column visibility.
      Parameters:
      visible - Boolean value
      Returns:
      Column for chaining

    • isVisible

      public boolean isVisible()
      Return status of the column visibility.
      Returns:
      Boolean value.