https://github.com/vaadin-component-factory/enhanced-grid-flow
https://github.com/vaadin-component-factory/enhanced-grid-flow
Last synced: 24 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/vaadin-component-factory/enhanced-grid-flow
- Owner: vaadin-component-factory
- License: apache-2.0
- Created: 2021-03-04T12:19:58.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-01-12T16:07:35.000Z (over 1 year ago)
- Last Synced: 2024-04-17T10:09:40.223Z (about 1 year ago)
- Language: Java
- Homepage: https://incubator.app.fi/enhanced-grid-flow-demo/
- Size: 215 KB
- Stars: 5
- Watchers: 8
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#
## Development instructions
Build the project and install the add-on locally:
```
mvn clean install
```
Starting the demo server:
Go to enhanced-grid-flow-demo and run:
```
mvn jetty:run
```
This deploys demo at http://localhost:8080
## Description
This component is an extended version of Grid that provides support to the following features:
- set a predicate to indicate which rows/items can be selected
- set a predicate to indicate which rows/items can be edited
- check if a item is editable
- edit an item and cancel the edit
- set a flag to indicate if a cancel edit confirmation dialog should be display if user navigates away from current editing row
- set messages through internationalization in the cancel edit confirmation dialog
- each column can define a filter field/dialog
- if a filter field is define, an icon will be displayed in the column header, switching color if a filter is applied
- pre-selection of filters to apply for each column
- pre-selection of sorting direction for each column
## How to use it
Create a new component EnhancedGrid/EnhancedTreeGrid and use it like a Grid/TreeGrid.
## Examples
Here is a simple example on how to try out the EnhancedGrid component:
* Creating the EnhancedGrid
```java
EnhancedGrid grid = new EnhancedGrid<>();
```
* Adding a selection predicate to indicate which items can be selected
```java
grid.setSelectionPredicate(p -> p.getAge() > 18);
```
* Adding a editable predicate to indicate which items can be edited
```java
grid.setEditablePredicate(p -> p.getAge() > 18);
```
* Adding columns
```java
// first name column with filtering button on header
EnhancedColumn firstNameColumn = grid.addColumn(Person::getFirstName).setHeader("First Name", new TextFilterField());
// last name column with filtering button and pre-selected filter by last name = "Allen"
grid.addColumn(Person::getLastName).setHeader("Last Name", new TextFilterField(new TextFieldFilterDto("Allen")));
// simple age column
grid.addColumn(Person::getAge).setHeader("Age");
// add pre-selected ascendent order for firstNameColumn
List> sortByFirstName = new GridSortOrderBuilder()
.thenAsc(firstNameColumn).build();
grid.sort(sortByFirstName);
```
* Adding editor and binder to edit items
```java
Binder binder = new Binder<>(Person.class);
Editor editor = grid.getEditor();
editor.setBinder(binder);
editor.setBuffered(true);
// define editor components for editable column firstNameColumn
TextField firstNameField = new TextField();
binder.bind(firstNameField, Person::getFirstName, Person::setFirstName);
firstNameColumn.setEditorComponent(firstNameField);
```
* Editing an item
```java
grid.addItemDoubleClickListener(event -> {
grid.editItem(event.getItem());
});
```
For more complete examples on EnhancedGrid, see:
com.vaadin.componentfactory.enhancedgrid.SimpleSingleSelectView
com.vaadin.componentfactory.enhancedgrid.SimpleMultiSelectView
com.vaadin.componentfactory.enhancedgrid.LazySingleSelectView
com.vaadin.componentfactory.enhancedgrid.LazyMultiSelectView
For more complete examples on EnhancedTreeGrid, see:
com.vaadin.componentfactory.enhancedgrid.SingleTreeGridView
com.vaadin.componentfactory.enhancedgrid.MultiTreeGridView
com.vaadin.componentfactory.enhancedgrid.LazySingleTreeGridView
com.vaadin.componentfactory.enhancedgrid.LazyMultiTreeGridView
## Demo
You can check the demo here: https://incubator.app.fi/enhanced-grid-flow-demo/
## Missing features or bugs
You can report any issue or missing feature on github: https://github.com/vaadin-component-factory/enhanced-grid-flow