Package io.jmix.groupgridflowui.kit.vaadin.grid

Class Grid.DetailsManager

java.lang.Object
io.jmix.groupgridflowui.kit.vaadin.grid.Grid.AbstractGridExtension<T>
io.jmix.groupgridflowui.kit.vaadin.grid.Grid.DetailsManager
All Implemented Interfaces:
com.vaadin.flow.data.provider.DataGenerator<T>, Serializable
Direct Known Subclasses:
JmixGroupGrid.JmixDetailsManager
Enclosing class:
Grid<T>
protected class Grid.DetailsManager extends Grid.AbstractGridExtension<T>
Class for managing visible details rows.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    DetailsManager(Grid<T> grid)
    Constructs a new details manager for the given grid.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    destroyAllData()
    Remove the displayed details but keep the items from list of details
    void
    destroyData(T item)
    Remove the displayed details but keep the item in the list of details, so that the details stay open when the item is rendered again (for example after collapsing and expanding its parent row, or scrolling the item out of and back into view).
    void
    generateData(T item, tools.jackson.databind.node.ObjectNode jsonObject)
     
    boolean
    isDetailsVisible(T item)
    Returns the visibility of the details component for the given item.
    void
    refreshData(T item)
     
    void
    setDetailsVisible(T item, boolean visible)
    Sets the visibility of details for given item.
    void
    setRenderer(com.vaadin.flow.data.renderer.Renderer<T> renderer)
    Sets the renderer to use for displaying the item details rows.

    Methods inherited from class io.jmix.groupgridflowui.kit.vaadin.grid.Grid.AbstractGridExtension

    extend, getGrid, refresh, remove

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • DetailsManager

      public DetailsManager(Grid<T> grid)
      Constructs a new details manager for the given grid.
      Parameters:
      grid - the grid whose details are to be managed

  • Method Details

    • setRenderer

      public void setRenderer(com.vaadin.flow.data.renderer.Renderer<T> renderer)
      Sets the renderer to use for displaying the item details rows.
      Parameters:
      renderer - the renderer to use for displaying item details rows, null to remove the current renderer

    • setDetailsVisible

      public void setDetailsVisible(T item, boolean visible)
      Sets the visibility of details for given item.
      Parameters:
      item - the item to show details for
      visible - true if details component should be visible; false if it should be hidden

    • isDetailsVisible

      public boolean isDetailsVisible(T item)
      Returns the visibility of the details component for the given item.
      Parameters:
      item - the item to check
      Returns:
      true if details component should be visible; false if it should be hidden

    • generateData

      public void generateData(T item, tools.jackson.databind.node.ObjectNode jsonObject)

    • destroyData

      public void destroyData(T item)
      Remove the displayed details but keep the item in the list of details, so that the details stay open when the item is rendered again (for example after collapsing and expanding its parent row, or scrolling the item out of and back into view). Consistent with destroyAllData().
      Parameters:
      item - item to removed

    • destroyAllData

      public void destroyAllData()
      Remove the displayed details but keep the items from list of details

    • refreshData

      public void refreshData(T item)