Package org.vaadin.firitin.components.grid

Class VGrid<T>

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.grid.Grid<T>
org.vaadin.firitin.components.grid.VGrid<T>
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<com.vaadin.flow.component.grid.Grid<T>>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<com.vaadin.flow.component.grid.Grid<T>>, com.vaadin.flow.component.FocusNotifier<com.vaadin.flow.component.grid.Grid<T>>, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, com.vaadin.flow.data.event.SortEvent.SortNotifier<com.vaadin.flow.component.grid.Grid<T>,com.vaadin.flow.component.grid.GridSortOrder<T>>, com.vaadin.flow.data.provider.HasDataGenerators<T>, com.vaadin.flow.data.provider.HasDataView<T,Void,com.vaadin.flow.component.grid.dataview.GridDataView<T>>, com.vaadin.flow.data.provider.HasLazyDataView<T,Void,com.vaadin.flow.component.grid.dataview.GridLazyDataView<T>>, com.vaadin.flow.data.provider.HasListDataView<T,com.vaadin.flow.component.grid.dataview.GridListDataView<T>>, Serializable, FluentAttachNotifier<VGrid<T>>, FluentBlurNotifier<com.vaadin.flow.component.grid.Grid<T>,VGrid<T>>, FluentComponent<VGrid<T>>, FluentDetachNotifier<VGrid<T>>, FluentFocusable<com.vaadin.flow.component.grid.Grid<T>,VGrid<T>>, FluentFocusNotifier<com.vaadin.flow.component.grid.Grid<T>,VGrid<T>>, FluentHasSize<VGrid<T>>, FluentHasStyle<VGrid<T>>, FluentHasTheme<VGrid<T>>
Direct Known Subclasses:
GridMultiSelect, GridSelect, PagingGrid, TreeTable
public class VGrid<T> extends com.vaadin.flow.component.grid.Grid<T> implements FluentComponent<VGrid<T>>, FluentHasStyle<VGrid<T>>, FluentHasSize<VGrid<T>>, FluentFocusable<com.vaadin.flow.component.grid.Grid<T>,VGrid<T>>, FluentHasTheme<VGrid<T>>
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static interface 
    VGrid.CellFormatter<T>
    An interface to configure formatting of all data cells in the Grid.
    static interface 
    VGrid.RowStyler<T>
    Used to assign Style rules to row cells.
    static class 
    VGrid.VColumn<T>
     

    Nested classes/interfaces inherited from class com.vaadin.flow.component.grid.Grid

    com.vaadin.flow.component.grid.Grid.AbstractGridExtension<T extends Object>, com.vaadin.flow.component.grid.Grid.Column<T extends Object>, com.vaadin.flow.component.grid.Grid.DataCommunicatorBuilder<T extends Object,U extends com.vaadin.flow.data.provider.ArrayUpdater>, com.vaadin.flow.component.grid.Grid.MultiSortPriority, com.vaadin.flow.component.grid.Grid.NestedNullBehavior, com.vaadin.flow.component.grid.Grid.SelectionMode, com.vaadin.flow.component.grid.Grid.UpdateQueue

    Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier

    com.vaadin.flow.component.BlurNotifier.BlurEvent<C extends com.vaadin.flow.component.Component>

    Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier

    com.vaadin.flow.component.FocusNotifier.FocusEvent<C extends com.vaadin.flow.component.Component>

  • Constructor Summary

    Constructors
    Constructor
    Description
    VGrid()
     
    VGrid(int pageSize)
     
    VGrid(Class<T> beanType)
     
    VGrid(Class<T> beanType, boolean autoCreateColumns)
    Creates a new Grid with given bean type.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected <C extends com.vaadin.flow.component.grid.Grid.Column<T>>
    C
    addColumn(com.vaadin.flow.function.ValueProvider<T,?> valueProvider, BiFunction<com.vaadin.flow.data.renderer.Renderer<T>,String,C> columnFactory)
     
    com.vaadin.flow.component.grid.Grid.Column<T>
    addColumn(String propertyName)
     
    void
    focus()
     
    protected List<com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition>
    getBeanPropertyDefinitions()
     
    protected List<String>
    getBeanPropertyNames()
     
    protected BiFunction<com.vaadin.flow.data.renderer.Renderer<T>,String,com.vaadin.flow.component.grid.Grid.Column<T>>
    getDefaultColumnFactory()
     
    VGrid<T>
    hideProperties(String... propertyNamesToHide)
    Hides given columns.
    void
    scrollToItem(T item)
    Deprecated.
    Note, with lazy loaded content, calling this method may cause performance issues
    void
    setColumns(String... propertyNames)
     
    VGrid<T>
    setDataProvider(com.vaadin.flow.data.provider.CallbackDataProvider.FetchCallback<T,Void> fetchCallback, com.vaadin.flow.data.provider.CallbackDataProvider.CountCallback<T,Void> countCallback)
     
    VGrid<T>
    withCellFormatter(VGrid.CellFormatter<T> formatter)
    Defines a formatter used for all basic data columns.
    VGrid<T>
    withColumnSelector()
    Adds a Vaadin 3,4,5,6,7,8 style column selector.
    VGrid<T>
    withItems(Collection<T> items)
     
    VGrid<T>
    withItems(T... items)
     
    VGrid<T>
    withProperties(String... propertyNames)
     
    VGrid<T>
    withRowStyler(VGrid.RowStyler<T> rowStyler)
    Adds a strategy to style cells based on rows.
    VGrid<T>
    withSelectionMode(com.vaadin.flow.component.grid.Grid.SelectionMode selectionMode)
     
    VGrid<T>
    withSelectionModel(com.vaadin.flow.component.grid.GridSelectionModel<T> selectionModel, com.vaadin.flow.component.grid.Grid.SelectionMode selectionMode)
     
    VGrid<T>
    withThemeVariants(com.vaadin.flow.component.grid.GridVariant... variants)
     

    Methods inherited from class com.vaadin.flow.component.grid.Grid

    addCellFocusListener, addColumn, addColumn, addColumn, addColumn, addColumn, addColumnReorderListener, addColumnResizeListener, addColumns, addComponentColumn, addContextMenu, addDataGenerator, addDragEndListener, addDragStartListener, addDropListener, addFirstHeaderRow, addItemClickListener, addItemDoubleClickListener, addSelectionListener, addSortListener, addThemeVariants, addValueProvider, appendFooterRow, appendHeaderRow, asMultiSelect, asSingleSelect, compareMaybeComparables, configureBeanType, createColumn, createColumnId, createDefaultArrayUpdater, createEditor, createSortingComparator, deselect, deselectAll, getAriaLabel, getArrayUpdater, getBeanType, getClassNameGenerator, getColumnByKey, getColumnLayers, getColumnRendering, getColumns, getDataCommunicator, getDataProvider, getDefaultHeaderRow, getDragFilter, getDropFilter, getDropMode, getEditor, getEmptyStateComponent, getEmptyStateText, getFooterRows, getGenericDataView, getHeaderRows, getLazyDataView, getListDataView, getNestedNullBehavior, getPageSize, getPartNameGenerator, getPropertySet, getSelectedItems, getSelectionMode, getSelectionModel, getSelectionPreservationMode, getSortOrder, getUniqueKeyProperty, getUniqueKeyProvider, initConnector, insertColumnLayer, isAllRowsVisible, isColumnReorderingAllowed, isDetailsVisible, isDetailsVisibleOnClick, isMultiSort, isRowsDraggable, onAttach, onDataProviderChange, onDetach, onEnabledStateChanged, prependFooterRow, prependHeaderRow, recalculateColumnWidths, removeAllColumns, removeAllFooterRows, removeAllHeaderRows, removeColumn, removeColumnByKey, removeColumnLayer, removeColumns, removeFooterRow, removeHeaderRow, removeThemeVariants, scrollToEnd, scrollToIndex, scrollToStart, select, setAllRowsVisible, setAriaLabel, setClassNameGenerator, setColumnKey, setColumnOrder, setColumnOrder, setColumnRendering, setColumnReorderingAllowed, setDataProvider, setDefaultMultiSortPriority, setDetailsVisible, setDetailsVisibleOnClick, setDragDataGenerator, setDragFilter, setDropFilter, setDropMode, setEmptyStateComponent, setEmptyStateText, setItemDetailsRenderer, setItems, setItems, setItems, setItems, setItemSelectableProvider, setMultiSort, setMultiSort, setMultiSort, setMultiSort, setNestedNullBehavior, setPageSize, setPartNameGenerator, setRowsDraggable, setSelectionDragDetails, setSelectionMode, setSelectionModel, setSelectionPreservationMode, setSortableColumns, setTooltipGenerator, setUniqueKeyProperty, setUniqueKeyProvider, sort, updateSelectionModeOnClient

    Methods inherited from class com.vaadin.flow.component.Component

    addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.vaadin.flow.component.AttachNotifier

    addAttachListener

    Methods inherited from interface com.vaadin.flow.component.BlurNotifier

    addBlurListener

    Methods inherited from interface com.vaadin.flow.component.DetachNotifier

    addDetachListener

    Methods inherited from interface org.vaadin.firitin.fluency.ui.FluentAttachNotifier

    withAttachListener

    Methods inherited from interface org.vaadin.firitin.fluency.ui.FluentBlurNotifier

    withBlurListener

    Methods inherited from interface org.vaadin.firitin.fluency.ui.FluentComponent

    navigate, setId, setVisible, withId, withVisible

    Methods inherited from interface org.vaadin.firitin.fluency.ui.FluentDetachNotifier

    withDetachListener

    Methods inherited from interface org.vaadin.firitin.fluency.ui.FluentFocusable

    withTabIndex

    Methods inherited from interface org.vaadin.firitin.fluency.ui.FluentFocusNotifier

    withFocusListener

    Methods inherited from interface org.vaadin.firitin.fluency.ui.FluentHasSize

    addResizeListener, withFullHeight, withFullWidth, withHeight, withMaxHeight, withMaxSize, withMaxWidth, withMinHeight, withMinSize, withMinWidth, withSize, withSizeFull, withSizeUndefined, withWidth

    Methods inherited from interface org.vaadin.firitin.fluency.ui.FluentHasStyle

    withAddedClassName, withClassName, withStyle

    Methods inherited from interface org.vaadin.firitin.fluency.ui.FluentHasTheme

    withThemeNames

    Methods inherited from interface com.vaadin.flow.component.Focusable

    addFocusShortcut, blur, getTabIndex, setTabIndex

    Methods inherited from interface com.vaadin.flow.component.FocusNotifier

    addFocusListener

    Methods inherited from interface com.vaadin.flow.component.HasElement

    getElement

    Methods inherited from interface com.vaadin.flow.component.HasEnabled

    isEnabled, setEnabled

    Methods inherited from interface com.vaadin.flow.data.provider.HasLazyDataView

    setItems, setItems

    Methods inherited from interface com.vaadin.flow.data.provider.HasListDataView

    setItems, setItems

    Methods inherited from interface com.vaadin.flow.component.HasSize

    getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

    Methods inherited from interface com.vaadin.flow.component.HasStyle

    addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

    Methods inherited from interface com.vaadin.flow.component.HasTheme

    addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

  • Constructor Details

    • VGrid

      public VGrid()

    • VGrid

      public VGrid(int pageSize)

    • VGrid

      public VGrid(Class<T> beanType)

    • VGrid

      public VGrid(Class<T> beanType, boolean autoCreateColumns)
      Creates a new Grid with given bean type.
      Parameters:
      beanType - the bean/record type
      autoCreateColumns - if true, columns are created automatically for all introspected properties

  • Method Details

    • getBeanPropertyDefinitions

      protected List<com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition> getBeanPropertyDefinitions()

    • getBeanPropertyNames

      protected List<String> getBeanPropertyNames()

    • focus

      public void focus()
      Specified by:
      focus in interface com.vaadin.flow.component.Focusable<T>

    • getDefaultColumnFactory

      protected BiFunction<com.vaadin.flow.data.renderer.Renderer<T>,String,com.vaadin.flow.component.grid.Grid.Column<T>> getDefaultColumnFactory()
      Overrides:
      getDefaultColumnFactory in class com.vaadin.flow.component.grid.Grid<T>

    • withSelectionMode

      public VGrid<T> withSelectionMode(com.vaadin.flow.component.grid.Grid.SelectionMode selectionMode)

    • withSelectionModel

      public VGrid<T> withSelectionModel(com.vaadin.flow.component.grid.GridSelectionModel<T> selectionModel, com.vaadin.flow.component.grid.Grid.SelectionMode selectionMode)

    • withProperties

      public VGrid<T> withProperties(String... propertyNames)

    • hideProperties

      public VGrid<T> hideProperties(String... propertyNamesToHide)
      Hides given columns.
      Parameters:
      propertyNamesToHide - the property names/column keys to hide
      Returns:
      the grid for further configuration

    • setColumns

      public void setColumns(String... propertyNames)
      Overrides:
      setColumns in class com.vaadin.flow.component.grid.Grid<T>

    • addColumn

      public com.vaadin.flow.component.grid.Grid.Column<T> addColumn(String propertyName)
      Overrides:
      addColumn in class com.vaadin.flow.component.grid.Grid<T>

    • withThemeVariants

      public VGrid<T> withThemeVariants(com.vaadin.flow.component.grid.GridVariant... variants)

    • setDataProvider

      public VGrid<T> setDataProvider(com.vaadin.flow.data.provider.CallbackDataProvider.FetchCallback<T,Void> fetchCallback, com.vaadin.flow.data.provider.CallbackDataProvider.CountCallback<T,Void> countCallback)

    • withItems

      public VGrid<T> withItems(Collection<T> items)

    • withItems

      public VGrid<T> withItems(T... items)

    • scrollToItem

      @Deprecated public void scrollToItem(T item)
      Deprecated.
      Note, with lazy loaded content, calling this method may cause performance issues
      Scrolls to the row presenting the given item.
      Overrides:
      scrollToItem in class com.vaadin.flow.component.grid.Grid<T>
      Parameters:
      item - the item to scroll to

    • withColumnSelector

      public VGrid<T> withColumnSelector()
      Adds a Vaadin 3,4,5,6,7,8 style column selector.
      Returns:
      the grid with column selector

    • addColumn

      protected <C extends com.vaadin.flow.component.grid.Grid.Column<T>> C addColumn(com.vaadin.flow.function.ValueProvider<T,?> valueProvider, BiFunction<com.vaadin.flow.data.renderer.Renderer<T>,String,C> columnFactory)
      Overrides:
      addColumn in class com.vaadin.flow.component.grid.Grid<T>

    • withCellFormatter

      public VGrid<T> withCellFormatter(VGrid.CellFormatter<T> formatter)
      Defines a formatter used for all basic data columns.
      Parameters:
      formatter - the formatter
      Returns:
      the VGrid for further configuration

    • withRowStyler

      public VGrid<T> withRowStyler(VGrid.RowStyler<T> rowStyler)
      Adds a strategy to style cells based on rows.
      Parameters:
      rowStyler - the RowStyler