Package com.levigo.jadice.web.client.tools.dnd

Interface ImportHandler

All Known Implementing Classes:
AbstractServerBasedImportHandler, DOCPVImportHandler, JWTImportHandler, PageSortImportHandler
public interface ImportHandler
ImportHandler can be used to handle drag and drop events onto the ThumbnailView. They can be registered in the SelectPageTool.

See also: SelectPageTool.getImportHandlers() ExportHandler

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    adjustDropEffect(DnDParameter parameter)
    Mainly used to make fix adjustments to the DataTransfer.DropEffect of the event.
    boolean
    canImport(DnDParameter parameter)
    This method is called right before either an import is dispatched (DropEvent), or when a DragOverEvent takes place.
    void
    dropDone(DnDParameter parameter, ImportHandler usedHandler)
    This method is used to cleanup data after a drop was completed.
    void
    importDrop(DnDParameter parameter)
    The method is responsible for handling the drop and the given data.

  • Method Details

    • canImport

      boolean canImport(DnDParameter parameter)
      This method is called right before either an import is dispatched (DropEvent), or when a DragOverEvent takes place. Here can the in the parameters contained values be used to check if this handler can successfully handle a drop. From the registered ImportHandler only one should return true.
      Parameters:
      parameter - The parameter containing the event.
      Returns:
      Return true if this handler can handle the given event and contained types, false otherwise.

    • importDrop

      void importDrop(DnDParameter parameter)
      The method is responsible for handling the drop and the given data. It is called on a DropEvent.
      Parameters:
      parameter - The parameter containing the event.

    • adjustDropEffect

      void adjustDropEffect(DnDParameter parameter)
      Mainly used to make fix adjustments to the DataTransfer.DropEffect of the event. Normally the dropEffect is controlled by pressing the ctrl or shift key. But maybe some handler require a fix setting of the effect. It is called on every DragOverEvent if this handler can import the given event. The dropEffect is used to control the feedback to the origin of the drag/drop-event
      Parameters:
      parameter - The parameter containing the event.

    • dropDone

      void dropDone(DnDParameter parameter, ImportHandler usedHandler)
      This method is used to cleanup data after a drop was completed.
      Parameters:
      parameter - The parameter containing the event. In this case the event is still the DropEvent
      usedHandler - The handler that was used to import the given drop.