Skip to content

Latest commit

 

History

History
108 lines (84 loc) · 3.6 KB

README.md

File metadata and controls

108 lines (84 loc) · 3.6 KB
Raw

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
EnhancedGrid<Person> grid = new EnhancedGrid<>();
  • Adding a selection predicate to indicate which items can be selected
grid.setSelectionPredicate(p -> p.getAge() > 18);
  • Adding a editable predicate to indicate which items can be edited
grid.setEditablePredicate(p -> p.getAge() > 18);
  • Adding columns
// first name column with filtering button on header
EnhancedColumn<Person> 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<GridSortOrder<Person>> sortByFirstName = new GridSortOrderBuilder<Person>()
	  .thenAsc(firstNameColumn).build();
grid.sort(sortByFirstName);
  • Adding editor and binder to edit items
Binder<Person> binder = new Binder<>(Person.class);
Editor<Person> 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
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