Package com.vaadin.flow.component.gridpro

Class AbstractGridPro<E>

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.grid.Grid<E>
com.vaadin.flow.component.gridpro.AbstractGridPro<E>
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<com.vaadin.flow.component.grid.Grid<E>>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<com.vaadin.flow.component.grid.Grid<E>>, com.vaadin.flow.component.FocusNotifier<com.vaadin.flow.component.grid.Grid<E>>, 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<E>,com.vaadin.flow.component.grid.GridSortOrder<E>>, com.vaadin.flow.data.provider.HasDataGenerators<E>, com.vaadin.flow.data.provider.HasDataView<E,Void,com.vaadin.flow.component.grid.dataview.GridDataView<E>>, com.vaadin.flow.data.provider.HasLazyDataView<E,Void,com.vaadin.flow.component.grid.dataview.GridLazyDataView<E>>, com.vaadin.flow.data.provider.HasListDataView<E,com.vaadin.flow.component.grid.dataview.GridListDataView<E>>, Serializable
Direct Known Subclasses:
TreeGridPro
@Tag("vaadin-grid-pro") @NpmPackage(value="@vaadin/grid-pro", version="25.0.0") @JsModule("@vaadin/grid-pro/src/vaadin-grid-pro.js") @JsModule("@vaadin/grid-pro/src/vaadin-grid-pro-edit-column.js") @JsModule("./gridProConnector.js") public class AbstractGridPro<E> extends com.vaadin.flow.component.grid.Grid<E>
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    AbstractGridPro.CellEditStartedEvent<E>
    Event fired when the user starts to edit an existing item.
    static class 
    AbstractGridPro.EditColumn<T>
    Server-side component for the <vaadin-grid-edit-column> element.
    static class 
    AbstractGridPro.ItemPropertyChangedEvent<E>
    Event fired when the user has edited an existing item.

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

    com.vaadin.flow.component.grid.Grid.AbstractGridExtension<T>, com.vaadin.flow.component.grid.Grid.Column<T>, com.vaadin.flow.component.grid.Grid.DataCommunicatorBuilder<T,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.SpringData, 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
    Modifier
    Constructor
    Description
     
    AbstractGridPro()
    Creates a new instance, with page size of 50.
     
    AbstractGridPro(int pageSize)
    Creates a new instance, with the specified page size.
     
    AbstractGridPro(int pageSize, TreeGridPro.TreeDataCommunicatorBuilder<E> dataCommunicatorBuilder)
    Creates a new instance, with the specified page size and data communicator.
     
    AbstractGridPro(Class<E> beanType)
    Instantiates a new CrudGrid for the supplied bean type.
    protected
    AbstractGridPro(Class<E> beanType, TreeGridPro.TreeDataCommunicatorBuilder<E> dataCommunicatorBuilder)
    Creates a new grid with an initial set of columns for each of the bean's properties.
    protected
    AbstractGridPro(Class<E> beanType, TreeGridPro.TreeDataCommunicatorBuilder<E> dataCommunicatorBuilder, boolean autoCreateColumns)
    Creates a new grid with an initial set of columns for each of the bean's properties.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.vaadin.flow.shared.Registration
    addCellEditStartedListener(com.vaadin.flow.component.ComponentEventListener<AbstractGridPro.CellEditStartedEvent<E>> listener)
    Registers a listener to be notified when the user starts to edit an existing item.
    EditColumnConfigurer<E>
    addEditColumn(com.vaadin.flow.function.ValueProvider<E,?> valueProvider)
    Adds a new edit column to this GridPro with a value provider.
    EditColumnConfigurer<E>
    addEditColumn(com.vaadin.flow.function.ValueProvider<E,?> valueProvider, com.vaadin.flow.data.renderer.Renderer<E> renderer)
    Adds a new edit column to this GridPro with a value provider and renderer which is used to display the content when the cell is not in the edit mode.
    <V extends Comparable<? super V>>
    EditColumnConfigurer<E>
    addEditColumn(com.vaadin.flow.function.ValueProvider<E,V> valueProvider, String... sortingProperties)
    Adds a new edit column to this GridPro with a value provider and sorting properties.
    EditColumnConfigurer<E>
    addEditColumn(String propertyName)
    Adds a new edit column for the given property name.
    com.vaadin.flow.shared.Registration
    addItemPropertyChangedListener(com.vaadin.flow.component.ComponentEventListener<AbstractGridPro.ItemPropertyChangedEvent<E>> listener)
    Registers a listener to be notified when the user has edited an existing item.
    void
    addThemeVariants(com.vaadin.flow.component.gridpro.GridProVariant... variants)
    Adds theme variants to the component.
    protected AbstractGridPro.EditColumn<E>
    createEditColumn(com.vaadin.flow.data.renderer.Renderer<E> renderer, String columnId)
    Creates a new edit column instance for this GridPro instance.
    boolean
    getEditOnClick()
    Gets the value of the webcomponent's property editOnClick.
    boolean
    getEnterNextRow()
    Gets the value of the webcomponent's property enterNextRow.
    boolean
    getSingleCellEdit()
    Gets the value of the webcomponent's property singleCellEdit.
    void
    onEnabledStateChanged(boolean enabled)
     
    void
    removeThemeVariants(com.vaadin.flow.component.gridpro.GridProVariant... variants)
    Removes theme variants from the component.
    void
    setEditOnClick(boolean editOnClick)
    Sets the value of the webcomponent's property editOnClick.
    void
    setEnterNextRow(boolean enterNextRow)
    Sets the value of the webcomponent's property enterNextRow.
    void
    setSingleCellEdit(boolean singleCellEdit)
    Sets the value of the webcomponent's property singleCellEdit.

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

    addCellFocusListener, addColumn, addColumn, 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, getColumnByInternalId, getColumnByKey, getColumnLayers, getColumnRendering, getColumns, getDataCommunicator, getDataProvider, getDefaultColumnFactory, getDefaultHeaderRow, getDragFilter, getDropFilter, getDropMode, getEditor, getEmptyStateComponent, getEmptyStateText, getFooterRows, getGenericDataView, getHeaderRows, getLazyDataView, getListDataView, getNestedNullBehavior, getPageSize, getPartNameGenerator, getPropertySet, getSelectedItems, getSelectionMode, getSelectionModel, getSelectionPreservationMode, getSortOrder, getTooltipPosition, getUniqueKeyProperty, getUniqueKeyProvider, initConnector, insertColumnLayer, isAllRowsVisible, isColumnReorderingAllowed, isDetailsVisible, isDetailsVisibleOnClick, isMultiSort, isRowsDraggable, isTooltipMarkdownEnabled, onAttach, onDataProviderChange, onDetach, prependFooterRow, prependHeaderRow, recalculateColumnWidths, removeAllColumns, removeAllFooterRows, removeAllHeaderRows, removeColumn, removeColumnByKey, removeColumnLayer, removeColumns, removeFooterRow, removeHeaderRow, removeThemeVariants, scrollToEnd, scrollToIndex, scrollToItem, scrollToStart, select, setAllRowsVisible, setAriaLabel, setColumnKey, setColumnOrder, setColumnOrder, setColumnRendering, setColumnReorderingAllowed, setColumns, setDataProvider, setDefaultMultiSortPriority, setDetailsVisible, setDetailsVisibleOnClick, setDragDataGenerator, setDragFilter, setDropFilter, setDropMode, setEmptyStateComponent, setEmptyStateText, setItemDetailsRenderer, setItems, setItems, setItems, setItems, setItemSelectableProvider, setItemsPageable, setItemsPageable, setMultiSort, setMultiSort, setMultiSort, setMultiSort, setNestedNullBehavior, setPageSize, setPartNameGenerator, setRowsDraggable, setSelectionDragDetails, setSelectionMode, setSelectionModel, setSelectionPreservationMode, setSortableColumns, setTooltipGenerator, setTooltipMarkdownEnabled, setTooltipPosition, 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 com.vaadin.flow.component.Focusable

    addFocusShortcut, blur, focus, focus, 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

    • AbstractGridPro

      public AbstractGridPro(Class<E> beanType)
      Instantiates a new CrudGrid for the supplied bean type.
      Parameters:
      beanType - the beanType for the item

    • AbstractGridPro

      public AbstractGridPro()
      Creates a new instance, with page size of 50.

    • AbstractGridPro

      public AbstractGridPro(int pageSize)
      Creates a new instance, with the specified page size.

      The page size influences the Query.getLimit() sent by the client, but it's up to the webcomponent to determine the actual query limit, based on the height of the component and scroll position. Usually the limit is 3 times the page size (e.g. 150 items with a page size of 50).

      Parameters:
      pageSize - the page size. Must be greater than zero.

    • AbstractGridPro

      public AbstractGridPro(int pageSize, TreeGridPro.TreeDataCommunicatorBuilder<E> dataCommunicatorBuilder)
      Creates a new instance, with the specified page size and data communicator.

      The page size influences the Query.getLimit() sent by the client, but it's up to the webcomponent to determine the actual query limit, based on the height of the component and scroll position. Usually the limit is 3 times the page size (e.g. 150 items with a page size of 50).

      Type Parameters:
      U - the GridArrayUpdater type
      B - the data communicator builder type
      Parameters:
      pageSize - the page size. Must be greater than zero.
      dataCommunicatorBuilder - Builder for DataCommunicator implementation this Grid uses to handle all data communication.

    • AbstractGridPro

      protected AbstractGridPro(Class<E> beanType, TreeGridPro.TreeDataCommunicatorBuilder<E> dataCommunicatorBuilder)
      Creates a new grid with an initial set of columns for each of the bean's properties. The property-values of the bean will be converted to Strings. Full names of the properties will be used as the column keys and the property captions will be used as the column headers.

      You can add columns for nested properties of the bean with Grid.addColumn(String).

      Type Parameters:
      U - the GridArrayUpdater type
      B - the data communicator builder type
      Parameters:
      beanType - the bean type to use, not null
      dataCommunicatorBuilder - Builder for DataCommunicator implementation this Grid uses to handle all data communication.

    • AbstractGridPro

      protected AbstractGridPro(Class<E> beanType, TreeGridPro.TreeDataCommunicatorBuilder<E> dataCommunicatorBuilder, boolean autoCreateColumns)
      Creates a new grid with an initial set of columns for each of the bean's properties. The property-values of the bean will be converted to Strings. Full names of the properties will be used as the column keys and the property captions will be used as the column headers.

      When autoCreateColumns is true, only the direct properties of the bean are included and they will be in alphabetical order. Use Grid.setColumns(String...) to define which properties to include and in which order. You can also add a column for an individual property with Grid.addColumn(String). Both of these methods support also sub-properties with dot-notation, eg. "property.nestedProperty".

      Type Parameters:
      U - the GridArrayUpdater type
      B - the data communicator builder type
      Parameters:
      beanType - the bean type to use, not null
      dataCommunicatorBuilder - Builder for DataCommunicator implementation this Grid uses to handle all data communication.
      autoCreateColumns - when true, columns are created automatically for the properties of the beanType

  • Method Details

    • onEnabledStateChanged

      public void onEnabledStateChanged(boolean enabled)
      Overrides:
      onEnabledStateChanged in class com.vaadin.flow.component.grid.Grid<E>

    • addEditColumn

      public EditColumnConfigurer<E> addEditColumn(com.vaadin.flow.function.ValueProvider<E,?> valueProvider)
      Adds a new edit column to this GridPro with a value provider.
      Parameters:
      valueProvider - the value provider
      Returns:
      an edit column configurer for configuring the column editor
      See Also:

    • addEditColumn

      public EditColumnConfigurer<E> addEditColumn(com.vaadin.flow.function.ValueProvider<E,?> valueProvider, com.vaadin.flow.data.renderer.Renderer<E> renderer)
      Adds a new edit column to this GridPro with a value provider and renderer which is used to display the content when the cell is not in the edit mode.
      Parameters:
      valueProvider - the value provider
      renderer - the renderer
      Returns:
      an edit column configurer for configuring the column editor
      See Also:

    • addEditColumn

      public <V extends Comparable<? super V>> EditColumnConfigurer<E> addEditColumn(com.vaadin.flow.function.ValueProvider<E,V> valueProvider, String... sortingProperties)
      Adds a new edit column to this GridPro with a value provider and sorting properties.
      Parameters:
      valueProvider - the value provider
      sortingProperties - the sorting properties to use for this column
      Returns:
      an edit column configurer for configuring the column editor
      See Also:

    • addEditColumn

      public EditColumnConfigurer<E> addEditColumn(String propertyName)
      Adds a new edit column for the given property name.

      Note: This method can only be used for a Grid created from a bean type with

      invalid reference 
      #GridPro(Class)
      .
      Parameters:
      propertyName - the property name of the new column, not null
      Returns:
      and edit column configurer for configuring the column editor
      See Also:

    • setEnterNextRow

      public void setEnterNextRow(boolean enterNextRow)
      Sets the value of the webcomponent's property enterNextRow. Default values is false. When true, pressing Enter while in cell edit mode will move focus to the editable cell in the next row (Shift + Enter - same, but for previous row).
      Parameters:
      enterNextRow - when true, pressing Enter while in cell edit mode will move focus to the editable cell in the next row (Shift + Enter - same, but for previous row)

    • getEnterNextRow

      @Synchronize("enter-next-row-changed") public boolean getEnterNextRow()
      Gets the value of the webcomponent's property enterNextRow. Default values is false. When true, pressing Enter while in cell edit mode will move focus to the editable cell in the next row (Shift + Enter - same, but for previous row).
      Returns:
      enterNextRow value

    • setSingleCellEdit

      public void setSingleCellEdit(boolean singleCellEdit)
      Sets the value of the webcomponent's property singleCellEdit. Default values is false. When true, after moving to next or previous editable cell using Tab / Shift+Tab, it will be focused without edit mode.
      Parameters:
      singleCellEdit - when true, after moving to next or previous editable cell using Tab / Shift+Tab, it will be focused without edit mode

    • getSingleCellEdit

      @Synchronize("single-cell-edit-changed") public boolean getSingleCellEdit()
      Gets the value of the webcomponent's property singleCellEdit. Default values is false. When true, after moving to next or previous editable cell using Tab / Shift+Tab, it will be focused without edit mode.
      Returns:
      singleCellEdit value

    • setEditOnClick

      public void setEditOnClick(boolean editOnClick)
      Sets the value of the webcomponent's property editOnClick. Default values is false. When true, cell edit mode gets activated on a single click instead of the default double click.
      Parameters:
      editOnClick - when true, cell edit mode gets activated on a single click instead of the default double click

    • getEditOnClick

      @Synchronize("edit-on-click-changed") public boolean getEditOnClick()
      Gets the value of the webcomponent's property editOnClick. Default values is false. When true, cell edit mode gets activated on a single click instead of the default double click.
      Returns:
      editOnClick value

    • createEditColumn

      protected AbstractGridPro.EditColumn<E> createEditColumn(com.vaadin.flow.data.renderer.Renderer<E> renderer, String columnId)
      Creates a new edit column instance for this GridPro instance.

      This method must not return null.

      Parameters:
      renderer - the renderer used to create the grid cell structure
      columnId - internal column id
      Returns:
      edit column instance
      See Also:
      • Renderer

    • addCellEditStartedListener

      public com.vaadin.flow.shared.Registration addCellEditStartedListener(com.vaadin.flow.component.ComponentEventListener<AbstractGridPro.CellEditStartedEvent<E>> listener)
      Registers a listener to be notified when the user starts to edit an existing item.
      Parameters:
      listener - a listener to be notified
      Returns:
      a handle that can be used to unregister the listener

    • addItemPropertyChangedListener

      public com.vaadin.flow.shared.Registration addItemPropertyChangedListener(com.vaadin.flow.component.ComponentEventListener<AbstractGridPro.ItemPropertyChangedEvent<E>> listener)
      Registers a listener to be notified when the user has edited an existing item.
      Parameters:
      listener - a listener to be notified
      Returns:
      a handle that can be used to unregister the listener

    • addThemeVariants

      public void addThemeVariants(com.vaadin.flow.component.gridpro.GridProVariant... variants)
      Adds theme variants to the component.
      Parameters:
      variants - theme variants to add

    • removeThemeVariants

      public void removeThemeVariants(com.vaadin.flow.component.gridpro.GridProVariant... variants)
      Removes theme variants from the component.
      Parameters:
      variants - theme variants to remove