Skip to content

FileDropTargetAndSelector is a UI component extension for Vaadin 8.1+

License

Notifications You must be signed in to change notification settings

gerald24/FileDropTargetAndSelector

Repository files navigation

FileDropTarget-And-Selector Add-on for Vaadin 8 (8.9+)

FileDropTargetAndSelector is a UI component extension for Vaadin 8.9+. It extends Vaadin's FileDropTarget (since 8.1) extension with file selector capability and uses the same api to transfer the selected file(s) to the server.

This extension simple uses following approach to get the selected file or files, and passes the FileList to Vaadin's FileDropTargetConnector: Using files from web applications

See also javadoc.

Download release

Official releases of this add-on are available at Vaadin Directory. For Maven instructions, download and reviews, go to http://vaadin.com/addon/filedroptarget-and-selector

Building and running demo

git clone https://github.com/gerald24/FileDropTargetAndSelector.git mvn clean install cd filedroptarget-and-selector-demo mvn jetty:run

To see the demo, navigate to http://localhost:8080/

Development with Eclipse IDE

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)
  • JRebel Eclipse plug-in (install it from Eclipse Marketplace)
  • Chrome browser

Importing project

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.

Debugging server-side

If you have not already compiled the widgetset, do it now by running vaadin:install Maven target for filedroptarget-and-selector-root project.

If you have a JRebel license, it makes on the fly code changes faster. Just add JRebel nature to your filedroptarget-and-selector-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 filedroptarget-and-selector-demo project and choose Debug As > Debug on Server. Navigate to http://localhost:8080/filedroptarget-and-selector-demo/ to see the application.

Debugging client-side

Debugging client side code in the filedroptarget-and-selector-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.

Release notes

Version 1.0

  • tested file selector FF, Chrome, Safari, IE 11, IE Edge

Version 1.0.3

  • fixed reset of input field

Version 1.0.7

  • fixes drop state (fixes client side exception which prevents sending file immediately to server. Mouse move or other action was needed in order transfer was processed)

Issue tracking

The issues for this add-on are tracked on its github.com page. All bug reports and feature requests are appreciated.

Contributions

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

License & Author

Add-on is distributed under Apache License 2.0. For license terms, see LICENSE.txt.

FileDropTargetAndSelector and it's Demo UI is written by Gerald Leeb.

Developer Guide

Getting started

Here is a simple example on how to try out the add-on component:

new FileDropTargetAndSelector<>(dropArea1, clickableLayout, event -> ...)

Note: clickable component (button-role) can be set/changed during runtime.

For a more comprehensive example, see src/test/java/org/vaadin/template/demo/DemoUI.java

API

See Javadoc of FileDropTargetAndSelector.

Known Issues

See vaadin/framework#9974 for known issues on Windows 10. Workaround UI.setMobileHtml5DndEnabled(true); seems to fix this issue on Windows 10

About

FileDropTargetAndSelector is a UI component extension for Vaadin 8.1+

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published