Package com.flowingcode.vaadin.addons.gridhelpers

Class GridHelper<T>

java.lang.Object
com.flowingcode.vaadin.addons.gridhelpers.GridHelper<T>
All Implemented Interfaces:
Serializable
@JsModule("./fcGridHelper/connector.js") @CssImport(value="./fcGridHelper/vaadin-menu-bar.css",themeFor="vaadin-menu-bar") @CssImport(value="./fcGridHelper/vaadin-grid.css",themeFor="vaadin-grid") @CssImport(value="./fcGridHelper/vaadin-context-menu-item.css",themeFor="vaadin-context-menu-item") @CssImport(value="./fcGridHelper/vaadin-context-menu-list-box.css",themeFor="vaadin-context-menu-list-box") @CssImport(value="./fcGridHelper/vaadin-menu-bar-item.css",themeFor="vaadin-menu-bar-item") @CssImport(value="./fcGridHelper/vaadin-menu-bar-list-box.css",themeFor="vaadin-menu-bar-list-box") @CssImport(value="./fcGridHelper/vaadin-checkbox.css",themeFor="vaadin-checkbox") public final class GridHelper<T> extends Object implements Serializable
See Also:

  • Field Details

  • Method Details

    • setHelperClassNameGenerator

      protected void setHelperClassNameGenerator(Class<?> clazz, SerializableFunction<T,String> generator)

    • getSelectionMode

      public static Grid.SelectionMode getSelectionMode(Grid<?> grid)
      Return the grid selection mode

    • setClassNameGenerator

      public void setClassNameGenerator(SerializableFunction<T,String> classNameGenerator)
      Sets the function that is used for generating CSS class names for all the cells in the rows in this grid. Returning null from the generator results in no custom class name being set. Multiple class names can be returned from the generator as space-separated.

      If Grid.Column.setClassNameGenerator(SerializableFunction) is used together with this method, resulting class names from both methods will be effective. Class names generated by grid are applied to the cells before the class names generated by column. This means that if the classes contain conflicting style properties, column's classes will win.

      Parameters:
      classNameGenerator - the class name generator to set, not null
      Throws:
      NullPointerException - if classNameGenerator is null
      See Also:

    • setSelectOnClick

      public static void setSelectOnClick(Grid<?> grid, boolean selectOnClick)

    • isSelectOnClick

      public static boolean isSelectOnClick(Grid<?> grid)

    • setArrowSelectionEnabled

      public static void setArrowSelectionEnabled(Grid<?> grid, boolean value)
      Allows Grid rows to be selected using up/down arrow keys.

    • isArrowSelectionEnabled

      public static boolean isArrowSelectionEnabled(Grid<?> grid)
      Returns whether Grid rows can be selected using up/down arrow keys.

    • setSelectionColumnHidden

      public static void setSelectionColumnHidden(Grid<?> grid, boolean value)
      Sets whether the multiselect selection column is hidden.

    • setSelectionColumnFrozen

      @Deprecated public static void setSelectionColumnFrozen(Grid<?> grid, boolean value)
      Deprecated.
      Sets whether the multiselect selection column is frozen.

    • isSelectionColumnHidden

      public static boolean isSelectionColumnHidden(Grid<?> grid)
      Returns whether the multiselect selection column is hidden.

    • isSelectionColumnFrozen

      @Deprecated public static boolean isSelectionColumnFrozen(Grid<?> grid)
      Deprecated.
      Returns whether the multiselect selection column is frozen.

    • setSelectionFilter

      public static <T> void setSelectionFilter(Grid<T> grid, SerializablePredicate<T> predicate)
      Sets a predicate for determining which rows are selectable.

      After a call to Grid.setSelectionMode(SelectionMode) the selection filter is lost and it has to be configured again: 

       GridHelper.setSelectionFilter(grid, GridHelper.getSelectionFilter(grid)); // static call
 grid.setSelectionFilter(grid.getSelectionFilter()); // with lombok extension

    • getSelectionFilter

      public static <T> SerializablePredicate<T> getSelectionFilter(Grid<T> grid)
      Returns the predicate for determining which rows are selectable.

    • setColumnToggleVisible

      public static void setColumnToggleVisible(Grid<?> grid, boolean visible)
      Shows a menu to toggle the visibility of grid columns.

    • isColumnToggleVisible

      public static boolean isColumnToggleVisible(Grid<?> grid)
      Returns whether the menu to toggle the visibility of grid columns is visible.

    • isHidable

      public static <T> boolean isHidable(Grid.Column<T> column)
      Returns whether this column can be hidden by the user. Default is false.
      Returns:
      true if the user can hide the column, false if not.

    • setHidable

      public static <T> Grid.Column<T> setHidable(Grid.Column<T> column, boolean hidable)
      Sets whether this column can be hidden by the user. Hidable columns can be hidden and shown via the sidebar menu.
      Parameters:
      column - the column to be configured
      hidable - true if the column may be hidden by the user via UI interaction
      Returns:
      the column.

    • addColumnToggleListener

      public static <T> Registration addColumnToggleListener(Grid<T> grid, ComponentEventListener<ColumnToggleEvent<T>> listener)
      Adds a listener that is notified when column visibility is modified through the sidebar menu.

    • setHidingToggleCaption

      public static <T> void setHidingToggleCaption(Grid.Column<T> column, String caption)
      Sets the caption of the hiding toggle for this column. Shown in the toggle for this column in the grid's sidebar when the column is hidable.

      If the value is null, the column cannot be hidden via the sidebar menu.

      Parameters:
      column - the column for which the hiding toggle caption is set
      caption - the text to show in the column hiding toggle

    • getHidingToggleCaption

      public static <T> String getHidingToggleCaption(Grid.Column<T> column)
      Returns the caption of the hiding toggle for this column.
      Returns:
      the text shown in the column hiding toggle

    • isMenuToggleColumn

      public static boolean isMenuToggleColumn(Grid.Column<?> column)

    • setEmptyGridLabel

      public static void setEmptyGridLabel(Grid<?> grid, Component component)
      Sets a component that is displayed when the Grid would show an empty data set.

    • getEmptyGridLabel

      public static Component getEmptyGridLabel(Grid<?> grid)
      Returns the component that is displayed when the Grid would show an empty data set.

    • addToolbarFooter

      public static void addToolbarFooter(Grid<?> grid, Component toolBar)

    • getHeader

      @Deprecated public static String getHeader(Grid<?> grid, Grid.Column<?> column)
      Deprecated.

    • getFooter

      @Deprecated public static String getFooter(Grid<?> grid, Grid.Column<?> column)
      Deprecated.

    • setEnhancedSelectionEnabled

      public static final void setEnhancedSelectionEnabled(Grid<?> grid, boolean enabled)
      When enabled, enhances grid row selection support adding support for these combinations: click, arrow up/down, shift+click, shift+arrow up/down, ctrl+click and ctrl+space.
      Parameters:
      grid -
      enabled -

    • isEnhancedSelectionEnabled

      public static boolean isEnhancedSelectionEnabled(Grid<?> grid)
      Returns whether the enhanced selection is enabled.

    • setHeaderVisible

      public static void setHeaderVisible(Grid<?> grid, boolean visible)

    • isHeaderVisible

      public static boolean isHeaderVisible(Grid<?> grid)
      Returns the visibility of the header section.
      Returns:
      true if visible, false otherwise.

    • setFooterVisible

      public static void setFooterVisible(Grid<?> grid, boolean visible)
      Sets the visibility of the footer section.
      Parameters:
      visible - true to show footer section, false to hide

    • isFooterVisible

      public static boolean isFooterVisible(Grid<?> grid)
      Returns the visibility of the footer section.
      Returns:
      true if visible, false otherwise.

    • getHeaderStyles

      public static GridStylesHelper getHeaderStyles(Grid<?> grid, HeaderRow row)

    • getFooterStyles

      public static GridStylesHelper getFooterStyles(Grid<?> grid, FooterRow row)

    • getHeaderStyles

      public static GridStylesHelper getHeaderStyles(Grid<?> grid, HeaderRow.HeaderCell cell)

    • getFooterStyles

      public static GridStylesHelper getFooterStyles(Grid<?> grid, FooterRow.FooterCell cell)

    • setHeightByRows

      public static void setHeightByRows(Grid<?> grid, double rows)
      Sets the number of rows that should be visible in Grid's body, while getHeightMode(Grid) is HeightMode.ROW.

      The algorithm assumes that all data rows have the same height and considers headers, footers, and the horizontal scrollbar when the method is called. However, if data rows, headers, or footers are inserted or removed after the initial calculation, the grid may not automatically adjust the size of the grid to accommodate the changed number of rows.

      Parameters:
      rows - The height in terms of number of rows displayed in Grid's body. If Grid doesn't contain enough rows, white space is displayed instead.
      Throws:
      IllegalArgumentException - if rows is zero or less
      IllegalArgumentException - if rows is infinite
      IllegalArgumentException - if rows is NaN

    • setHeightByRows

      public static void setHeightByRows(Grid<?> grid, int rows)
      Sets the number of rows that should be visible in Grid's body, while getHeightMode(Grid) is HeightMode.ROW.

      If Grid is currently not in HeightMode.ROW, the given value is remembered, and applied once the mode is applied. @See setHeightByRows(Grid, double)

    • getHeightByRows

      public static double getHeightByRows(Grid<?> grid)
      Gets the amount of rows in Grid's body that are shown, while getHeightMode(Grid) is HeightMode.ROW.
      Returns:
      the amount of rows that are being shown in Grid's body
      See Also:

    • setHeightMode

      public static void setHeightMode(Grid<?> grid, HeightMode heightMode)
      Defines the mode in which the Grid's height is calculated.

      If HeightMode.CSS is given, Grid will respect the values given via a setHeight-method, and behave as a traditional Component.

      If HeightMode.ROW is given, Grid will make sure that the body will display as many rows as getHeightByRows(Grid) defines.

      Parameters:
      heightMode - the mode in to which Grid should be set

    • getHeightMode

      public static HeightMode getHeightMode(Grid<?> grid)
      Defines the mode in which the Grid's height is calculated.

      If HeightMode.CSS is given, Grid will respect the CSS height as a traditional Component.

      If HeightMode.ROW is given, Grid will make sure that the body will display as many rows as getHeightByRows(Grid) defines.

      Returns:
      the mode in which the Grid is set

    • responsiveStep

      public static <T> GridResponsiveStep<T> responsiveStep(Grid<T> grid, int minWidth)
      Get or create a responsive steps for the given grid and minimum width.

    • getResponsiveSteps

      public static <T> Collection<GridResponsiveStep<T>> getResponsiveSteps(Grid<T> grid)
      Return the responsive steps of the given grid.

    • addCheckboxColumn

      public static <T> CheckboxColumn<T> addCheckboxColumn(Grid<T> grid, CheckboxColumn.CheckboxColumnConfiguration<T> config)

    • toggleSelectAllCheckbox

      public static <T> void toggleSelectAllCheckbox(Grid<T> grid, boolean visible)
      Toggles select all checkbox visibility in the grid's default header row for the selection column.

      Only works when Grid uses Grid.SelectionMode.MULTI and the data provider supplies a count callback.

      Note: enabling the select all checkbox when grid uses a lazy data source could lead to memory and performance issues.

      Parameters:
      visible - true to show the select all checkbox, false to hide it.
      See Also:
      • LazySelectAllGridHelper

    • showRadioSelectionColumn

      public static <T> GridRadioSelectionColumn showRadioSelectionColumn(Grid<T> grid)