Do you like the Grid but would want it to appeal more to old Excel jockeys? Then this add-on is for you! GridFastNavigation is a compnent extension for Vaadin Grid, which uses the unbuffered editing mode and alters its keyboard controls to provide a faster editing experience.
Official releases of this add-on are available at Vaadin Directory. For Maven instructions, download and reviews, go to https://vaadin.com/directory/component/gridfastnavigation-add-on
JavaDoc can be found online at
https://vaadin.com/directory/component/gridfastnavigation-add-on/api
git clone https://github.com/thinwire/GridFastNavigation.git mvn clean install cd GridFastNavigation-demo mvn jetty:run
To see the demo, navigate to http://localhost:8080/
For further development of this add-on, the following tool-chain is recommended:
- Eclipse IDE
- m2e wtp plug-in (install it from Eclipse Marketplace)
- Vaadin Eclipse plug-in (install it from Eclipse Marketplace)
- Chrome browser
Choose File > Import... > Existing Maven Projects
Note that Eclipse may give "Plugin execution not covered by lifecycle configuration" errors for pom.xml. Use "Permanently mark goal resources in pom.xml as ignored in Eclipse build" quick-fix to mark these errors as permanently ignored in your project. Do not worry, the project still works fine.
If you have not already compiled the widgetset, do it now by running vaadin:install Maven target for GridFastNavigation-root project.
If you have a JRebel license, it makes on the fly code changes faster. Just add JRebel nature to your GridFastNavigation-demo project by clicking project with right mouse button and choosing JRebel > Add JRebel Nature
To debug project and make code modifications on the fly in the server-side, right-click the GridFastNavigation-demo project and choose Debug As > Debug on Server. Navigate to http://localhost:8080/ to see the application.
Debugging client side code in the GridFastNavigation-demo project:
- run "mvn vaadin:run-codeserver" on a separate console while the application is running
- activate Super Dev Mode in the debug window of the application or by adding ?superdevmode to the URL
- You can access Java-sources and set breakpoints inside Chrome if you enable source maps from inspector settings.
- Adjust timing of the focus and selectAll calls.
- Fix editor column resizing in multiselect mode
- Fixed possible issue when there is empty data set in grid
- Do not change row if Alt Shift or Ctrl pressed (see issue #102)
- Added getKeyCode to EditorOpenEvent (see issue #101)
- Added isUserOriginated to CellFocusEvent and EditorOpenEvent (see issue #99)
- Fixed column sizing issues in when using Frozen columns.
- Fixed NPE in when using Frozen columns.
- Fixed timing issue if editRow(row,col) was called during Grid is updating after dataProvider.refreshAll()
- Added some error handling
- Added method to open Editor at row X in column Y
- Fix: Disabled column styles were not applied dynamically
- Grid froze when last column was not editable, fixes issue #98
- Fixed typo in method name, fixes issue #97
- Fixed hidden column compensation logic, fixes issue #96
- Codebase maintenance
- Add-on also now supports custom editor widgets extending the base set of editors
- Fixed editor cell resizing logic to work also with multiselect mode.
- Added option to enable selected style in Editor on selected row
- Fixed bug in cell focus event not triggered when moving left in multiselect Grid, fixes issue #95
- Fixed missing implementation of CellEditEvent#getOldData(), see issue #91
- Fixed CellFocusEvent#wasRowChanged() and CellFocusEvent#wasColumnChanged() to work correctly
- Added feature: shift+space will select / deselect the row when editor is open, see issue #90
- Fixed bug: In edit events item and row index were not correct or in sync in certain corner cases
- Made OffsetHelper serializable, to address issue #86
- Fixed JavaDocs
- Added support for NativeSelect, ColorPicker and TextArea
- Improved setFocusedCell(..) to address issue #77
- Improvement: issue #82 add helper to deal with custom selection models that change internal column calculation
- Added fault checkign to setFocusedCel due issue #77 and setChangeColumnOnEnter methods
- Improved JavaDocs
- Fix: Grid scroll bar width was not taken into account in Editor resizing
- Further improvement to row validation mode
- Improvement to row validation mode
- Added fix to Editor not resized when browser window is being resized bug. See: vaadin/framework#11148
- Workaround for vaadin/framework#8962
- Workaround for vaadin/framework#7276
- Fixed bug: Problem with sorting, edit event did not return right item (issue #76).
- Improvement: Home/End key behavior can be disabled with setHomeEndEnabled(false) (issue #75)
- New feature: Move focus programmatically with setFocusedCel(row,col) (issue #68)
- Updated demo
- Fixed bug: Client side exception occurred when there were hidden columns (issue #74).
- Added convenience method disableAllColumns() in EditorOpenEvent (issue #27)
- Fixed bug: Editor opening was jammed if there were no editable columns
- Fixed bug: Tabing out of bounds caused client side exception.
- Added preliminary support for hidden columns, fixes issue #71
- Minor improvements in setRowValidation(true) mode
- Updated demo
- Fix bug: Clicking outside Grid when setRowValidation(true) closed editor
- Improvements to full row validation (see issues #69 and #51), with setRowValidation(..) API
- Making possible to have full row validation (see issues #69 and #51)
- Updated demo
- Fixing issue #67: ESC-Click combination froze editor
- Fixed issue #65: Column indeces where off by one with multiselect model, and column disabling did not work
- Changed behavior, FastNavigation will no longer force Editor to be enabled
- Fixed issue #64: RowEditEvent fired after ESC-key
- Fixed issue #63: Numpad input was not filttered properly
- Fixed serialization issue
- Made EditorWidgets.registerHandler(..) public so that it is possible to add your custom editor widget handlers, and added java docs.
- Fix: Selection of the ComboBox textfield was missing
- Fix: Do not fire ClickOutEvent if ComboBox or DateField is open.
- Returned disableColumns(..) to EditorOpenEvent. It can be used to disable additional columns from editing.
- Fix, clickOutListener did not work if FastNavigation was not instantiated with dispatchEditEventOnBlur=true parameter (issue: #54)
- Fix, disabled columns / readonly fields detection logic was flawed (see: issue #55)
- Fixing internal columns handling (see: issue #50)
- Fix, Internal method to get item for events, did NPE with empty DataProvider (see: issue #56)
- Bugfix, cursor up/down did not open ComboBox in IE11
- Fixing issue #52
- Added possibility to add save shortcuts (see: issue #49)
- setSaveWithCtrlS(true) -> CTRL+S does save and close editor
- Solving issue #42: Clarifying setOpenEditorWithSingleClick(true) JavaDoc. Using it will prevent Grid's item click event and selection event getting the click.
- Changed getItem() in selected events to use DataCommunicator, requires Vaadin 8.2+
- Added ClickOutListener
- Changed widgetset.xml filename, Fixed issues #40, #41
- Modified CellFocusEvent and RowFocusEvent to return -1 if focus is in Header/Footer
- Updated JavaDocs
- Added getItem() to RowFocusEvent and CellFocusEvent
- Minor bugfix, there was regression in fix for issue #35
- Added getItem() CellEditEvent and RowEditEvent (experimental)
- Fixed issue #37: Enter now saves the value when closing the editor in the last cell
- Fixed issue #35: Listeners should be able to be used automatically now.
- DeleteButtonRenderer deprecated, it is now maintained in Grid RenderersCollection add-on.
- Updated the demo.
- Added support for closing Editor and dispatching event when clicking outside of Grid.
- DeleteButtonRenderer, made it boolean type, so that property underneath controls whether the button is enabled or not
- Fixed DeleteButtonRenderer: Html content mode support in client side was missing
- Demo updated
- Added DeleteButtonRenderer
- Demo updated
- First version for Vaadin 8
- Features on par with version 0.5.7
- Demo updated
The issues for this add-on are tracked on its github.com page. All bug reports and feature requests are appreciated.
Contributions are welcome, but there are no guarantees that they are accepted as such. Process for contributing is the following:
- Fork this project
- Create an issue to this project about the contribution (bug or feature) if there is no such issue about it already. Try to keep the scope minimal.
- Develop and test the fix or functionality carefully. Only include minimum amount of code needed to fix the issue.
- Refer to the fixed issue in commit
- Send a pull request for the original project
- Comment on the original issue that you have implemented a fix for it
Add-on is distributed under Apache License 2.0. For license terms, see LICENSE.txt.
GridFastNavigation is written by Patrik Lindström, Tatu Lund and Johannes Tuikkala and maintained by the Tatu. Vaadin 8 migration initial work was contributed by Brett Sutton.
Major pieces of development of this add-on has been sponsored by multiple Support and Prime customers of Vaadin. See vaadin.com/support and Development on Demand for more details.