We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.component.gridpro.
Class GridPro<E>
- java.lang.Object
-
- com.vaadin.flow.component.Component
-
- com.vaadin.flow.component.grid.Grid<E>
-
- com.vaadin.flow.component.gridpro.GridPro<E>
-
All Implemented Interfaces:
AttachNotifier, BlurNotifier<Grid<E>>, DetachNotifier, Focusable<Grid<E>>, FocusNotifier<Grid<E>>, HasElement, HasEnabled, HasSize, HasStyle, HasTheme, HasDataProvider<E>, HasItems<E>, SortEvent.SortNotifier<Grid<E>,GridSortOrder<E>>, HasDataGenerators<E>, Serializable
@Tag(value="vaadin-grid-pro") @NpmPackage(value="@vaadin/vaadin-grid-pro", version="2.1.1") @JsModule(value="@vaadin/vaadin-grid-pro/src/vaadin-grid-pro.js") @JsModule(value="@vaadin/vaadin-grid-pro/src/vaadin-grid-pro-edit-column.js") @JsModule(value="./gridProConnector.js") public class GridPro<E> extends Grid<E>See Also:
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static classGridPro.CellEditStartedEvent<E>Event fired when the user starts to edit an existing item.
static classGridPro.EditColumn<T>Server-side component for the
<vaadin-grid-edit-column>element.static classGridPro.ItemPropertyChangedEvent<E>Event fired when the user has edited an existing item.
-
Nested classes/interfaces inherited from class com.vaadin.flow.component.grid.Grid
Grid.AbstractGridExtension<T>, Grid.Column<T>, Grid.DataCommunicatorBuilder<T,U extends ArrayUpdater>, Grid.SelectionMode, Grid.UpdateQueue
-
Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier
BlurNotifier.BlurEvent<C extends Component>
-
Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier
FocusNotifier.FocusEvent<C extends Component>
-
-
Constructor Summary
Constructors Constructor and Description GridPro()Creates a new instance, with page size of 50.
GridPro(Class<E> beanType)Instantiates a new CrudGrid for the supplied bean type.
GridPro(int pageSize)Creates a new instance, with the specified page size.
-
Method Summary
All Methods Modifier and Type Method and Description RegistrationaddCellEditStartedListener(ComponentEventListener<GridPro.CellEditStartedEvent<E>> listener)Registers a listener to be notified when the user starts to edit an existing item.
EditColumnConfigurator<E>addEditColumn(String propertyName)Adds a new edit column for the given property name.
EditColumnConfigurator<E>addEditColumn(ValueProvider<E,?> valueProvider)Adds a new edit column to this
GridProwith a value provider.EditColumnConfigurator<E>addEditColumn(ValueProvider<E,?> valueProvider, Renderer<E> renderer)Adds a new edit column to this
GridProwith 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>>
EditColumnConfigurator<E>addEditColumn(ValueProvider<E,V> valueProvider, String... sortingProperties)Adds a new edit column to this
GridProwith a value provider and sorting properties.RegistrationaddItemPropertyChangedListener(ComponentEventListener<GridPro.ItemPropertyChangedEvent<E>> listener)Registers a listener to be notified when the user has edited an existing item.
protected GridPro.EditColumn<E>createEditColumn(Renderer<E> renderer, String columnId)Creates a new edit column instance for this
GridProinstance.booleangetEnterNextRow()Gets the value of the webcomponent's property enterNextRow.
booleangetSingleCellEdit()Gets the value of the webcomponent's property singleCellEdit.
voidonEnabledStateChanged(boolean enabled)Handle component enable state when the enabled state changes.
voidsetEnterNextRow(boolean enterNextRow)Sets the value of the webcomponent's property enterNextRow.
voidsetSingleCellEdit(boolean singleCellEdit)Sets the value of the webcomponent's property singleCellEdit.
-
Methods inherited from class com.vaadin.flow.component.grid.Grid
addColumn, addColumn, 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, createColumn, createColumnId, createDefaultArrayUpdater, createEditor, createSortingComparator, deselect, deselectAll, getArrayUpdater, getBeanType, getClassNameGenerator, getColumnByKey, getColumnLayers, getColumns, getDataCommunicator, getDataProvider, getDefaultColumnFactory, getDefaultHeaderRow, getDragFilter, getDropFilter, getDropMode, getEditor, getFooterRows, getHeaderRows, getPageSize, getPropertySet, getSelectedItems, getSelectionModel, getSortOrder, getUniqueKeyProperty, getUniqueKeyProvider, initConnector, insertColumnLayer, isColumnReorderingAllowed, isDetailsVisible, isDetailsVisibleOnClick, isHeightByRows, isMultiSort, isRowsDraggable, isVerticalScrollingEnabled, onAttach, onDataProviderChange, onDetach, prependFooterRow, prependHeaderRow, recalculateColumnWidths, removeAllColumns, removeColumn, removeColumnByKey, removeColumnLayer, removeColumns, removeThemeVariants, scrollToEnd, scrollToIndex, scrollToStart, select, setClassNameGenerator, setColumnKey, setColumnOrder, setColumnOrder, setColumnReorderingAllowed, setColumns, setDataProvider, setDetailsVisible, setDetailsVisibleOnClick, setDragDataGenerator, setDragFilter, setDropFilter, setDropMode, setHeightByRows, setItemDetailsRenderer, setMultiSort, setPageSize, setRowsDraggable, setSelectionDragDetails, setSelectionMode, setSelectionModel, setSortableColumns, setUniqueKeyProperty, setUniqueKeyProvider, setVerticalScrollingEnabled, sort, updateSelectionModeOnClient
-
Methods inherited from class com.vaadin.flow.component.Component
addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getUI, hasListener, isTemplateMapped, isVisible, 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.data.binder.HasDataProvider
setItems
-
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.HasSize
getHeight, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, setHeight, setHeightFull, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidthFull
-
Methods inherited from interface com.vaadin.flow.component.Focusable
addFocusShortcut, blur, focus, getTabIndex, setTabIndex
-
Methods inherited from interface com.vaadin.flow.component.BlurNotifier
addBlurListener
-
Methods inherited from interface com.vaadin.flow.component.FocusNotifier
addFocusListener
-
Methods inherited from interface com.vaadin.flow.component.HasEnabled
isEnabled, setEnabled
-
Methods inherited from interface com.vaadin.flow.component.HasElement
getElement
-
Methods inherited from interface com.vaadin.flow.component.HasTheme
addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName
-
Methods inherited from interface com.vaadin.flow.component.AttachNotifier
addAttachListener
-
Methods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListener
-
-
-
-
Constructor Detail
-
GridPro
public GridPro(Class<E> beanType)Instantiates a new CrudGrid for the supplied bean type.
Parameters:
beanType- the beanType for the item
-
GridPro
public GridPro()Creates a new instance, with page size of 50.
-
GridPro
public GridPro(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.
-
-
Method Detail
-
onEnabledStateChanged
public void onEnabledStateChanged(boolean enabled)Description copied from class:
ComponentHandle component enable state when the enabled state changes.
By default this sets or removes the 'disabled' attribute from the element. This can be overridden to have custom handling.
Overrides:
onEnabledStateChangedin classGrid<E>Parameters:
enabled- the new enabled state of the component
-
addEditColumn
public EditColumnConfigurator<E> addEditColumn(ValueProvider<E,?> valueProvider)Adds a new edit column to this
GridProwith a value provider.Parameters:
valueProvider- the value providerReturns:
an edit column configurer for configuring the column editor
See Also:
Grid.addColumn(ValueProvider),EditColumnConfigurator.text(ItemUpdater),EditColumnConfigurator.checkbox(ItemUpdater),EditColumnConfigurator.select(ItemUpdater, List),Grid.removeColumn(Column)
-
addEditColumn
public EditColumnConfigurator<E> addEditColumn(ValueProvider<E,?> valueProvider, Renderer<E> renderer)Adds a new edit column to this
GridProwith 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 providerrenderer- the rendererReturns:
an edit column configurer for configuring the column editor
See Also:
Grid.addColumn(Renderer),EditColumnConfigurator.text(ItemUpdater),EditColumnConfigurator.checkbox(ItemUpdater),EditColumnConfigurator.select(ItemUpdater, List),Grid.removeColumn(Column)
-
addEditColumn
public <V extends Comparable<? super V>> EditColumnConfigurator<E> addEditColumn(ValueProvider<E,V> valueProvider, String... sortingProperties)Adds a new edit column to this
GridProwith a value provider and sorting properties.Parameters:
valueProvider- the value providersortingProperties- the sorting properties to use for this columnReturns:
an edit column configurer for configuring the column editor
See Also:
Grid.addColumn(ValueProvider, String[]),Column#setComparator(ValueProvider),Column#setSortProperty(String...),EditColumnConfigurator.text(ItemUpdater),EditColumnConfigurator.checkbox(ItemUpdater),EditColumnConfigurator.select(ItemUpdater, List),Grid.removeColumn(Column)
-
addEditColumn
public EditColumnConfigurator<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
GridPro(Class).Parameters:
propertyName- the property name of the new column, notnullReturns:
and edit column configurer for configuring the column editor
See Also:
Grid.addColumn(String),EditColumnConfigurator.text(ItemUpdater),EditColumnConfigurator.checkbox(ItemUpdater),EditColumnConfigurator.select(ItemUpdater, List),Grid.removeColumn(Column)
-
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- whentrue, 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(value="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- whentrue, after moving to next or previous editable cell using Tab / Shift+Tab, it will be focused without edit mode
-
getSingleCellEdit
@Synchronize(value="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
-
createEditColumn
protected GridPro.EditColumn<E> createEditColumn(Renderer<E> renderer, String columnId)Creates a new edit column instance for this
GridProinstance.This method must not return
null.Parameters:
renderer- the renderer used to create the grid cell structurecolumnId- internal column idReturns:
edit column instance
See Also:
-
addCellEditStartedListener
public Registration addCellEditStartedListener(ComponentEventListener<GridPro.CellEditStartedEvent<E>> listener)Registers a listener to be notified when the user starts to edit an existing item.
Parameters:
listener- a listener to be notifiedReturns:
a handle that can be used to unregister the listener
-
addItemPropertyChangedListener
public Registration addItemPropertyChangedListener(ComponentEventListener<GridPro.ItemPropertyChangedEvent<E>> listener)Registers a listener to be notified when the user has edited an existing item.
Parameters:
listener- a listener to be notifiedReturns:
a handle that can be used to unregister the listener
-
-