You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

DropEvent.java 2.4KB

HTML5 Drag and Drop Support (#8264) * Add DragSource Extension (#8169) * Add DropTarget Extension (#8170) * Add DragStart Event to DragSource Extension (#8171) * Make DataTransfer.dropEffect configurable (#8174) * Make DragSource.dataTransfer data configurable (#8172) * Add server-side Event for drop (#8177) * Added license headers * Extract handler methods, move DropEvent and DropListener to new file, move enums to top * Replaced LinkedHashMap with Map and added List to preserve order of data * Add API for adding a JS acceptance criteria for dragover and drop (#8178, #8179) * Make DragSource Extension extendable (#8175) * Make DropTarget Extension extendable (#8176) * Added javadoc to protected methods * Moved EffectAllowed to shared so that it could be used in shared state directly * Moved DropEffect to separate file, some review fixes and javadoc * Added list to DropTargetRpc to preserve order of data * Remove event listeners on unregister * Changed method names set/getData() to more descriptive set/getTransferData() * Add server side dragStart event (#8171) * Add style to prevent text selection to allow drag * Remove target indicator style on drop * Add client side dragend event listener for drag source * Add server side dragend listener. Attach client side listener only when server side listener added. * Add drag source information to server side dragstart and dragend events. * Fixed some issues addressed in review * Trigger server side dragstart only when there is a listener attached * Criteria script can be set as null to clear * Use Js Interop instead of JSNI for handling event listeners * Use elemental package instead of Js Interop for handling event listeners * Add missing javadoc for public methods * Add default value "uninitialized" to effectAllowed parameter * Simple test UI for HTML5 DnD functionality (#8395) * Add javadoc and other minor changes
7 years ago
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. /*
  2. * Copyright 2000-2016 Vaadin Ltd.
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License"); you may not
  5. * use this file except in compliance with the License. You may obtain a copy of
  6. * the License at
  7. *
  8. * http://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  12. * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  13. * License for the specific language governing permissions and limitations under
  14. * the License.
  15. */
  16. package com.vaadin.event.dnd;
  17. import java.util.LinkedHashMap;
  18. import java.util.List;
  19. import java.util.Map;
  20. import com.vaadin.shared.ui.dnd.DropEffect;
  21. import com.vaadin.ui.Component;
  22. /**
  23. * Server side drop event. Fired when an HTML5 drop happens.
  24. *
  25. * @see DropTargetExtension#addDropListener(DropListener)
  26. */
  27. public class DropEvent extends Component.Event {
  28. private final Map<String, String> data;
  29. private final DropEffect dropEffect;
  30. /**
  31. * Creates a new server side drop event.
  32. *
  33. * @param source
  34. * Drop target component.
  35. * @param types
  36. * List of data types from {@code DataTransfer.types}.
  37. * @param data
  38. * Map of all data from {@code DataTransfer}.
  39. * @param dropEffect
  40. * Parameter from {@code DataTransfer.dropEffect}.
  41. */
  42. public DropEvent(Component source, List<String> types,
  43. Map<String, String> data, DropEffect dropEffect) {
  44. super(source);
  45. // Create a linked map that preserves the order of types
  46. this.data = new LinkedHashMap<>();
  47. types.forEach(type -> this.data.put(type, data.get(type)));
  48. this.dropEffect = dropEffect;
  49. }
  50. /**
  51. * Get data from the client side {@code DataTransfer} object.
  52. *
  53. * @param format
  54. * Data format, e.g. {@code text/plain} or {@code text/uri-list}.
  55. * @return Data for the given format if exists in the client side {@code
  56. * DataTransfer}, otherwise {@code null}.
  57. */
  58. public String getTransferData(String format) {
  59. return data != null ? data.get(format) : null;
  60. }
  61. /**
  62. * Get drop effect set for the current drop target.
  63. *
  64. * @return {@code dropEffect} parameter set for the current drop target.
  65. */
  66. public DropEffect getDropEffect() {
  67. return dropEffect;
  68. }
  69. }