Class EditorSiteDragAndDropServiceImpl

java.lang.Object
org.eclipse.ui.internal.EditorSiteDragAndDropServiceImpl
All Implemented Interfaces:
IDragAndDropService, IDisposable

public class EditorSiteDragAndDropServiceImpl extends Object implements IDragAndDropService, IDisposable

Implementation for the IDragAndDropService to be used from EditorSite's.

Adds a drop target to the given control that merges the site's drop behaviour with that specified by the addMergedDropTarget call.

The current implementation is only defined for EditorSite's and merges the given drop handling with the existing EditorSashContainer's behaviour.

NOTE: There is no cleanup (i.e. 'dispose') handling necessary for merged Drop Targets but the hooks are put into place to maintain the consistency of the implementation pattern.

Since:
3.3
  • Constructor Details

    • EditorSiteDragAndDropServiceImpl

      public EditorSiteDragAndDropServiceImpl()
  • Method Details

    • addMergedDropTarget

      public void addMergedDropTarget(Control control, int ops, Transfer[] transfers, DropTargetListener listener)
      Description copied from interface: IDragAndDropService
      Causes a drop target to be added to the given control that respects the existing site's drop behaviour in addition to the behaviour being specified for the given control.

      If a transfer type specified for the control matches one used by the site then the control's listener is called (the client is overriding the existing site behaviour which will no longer work).

      NOTE: Site authors must use this method to add drop behaviour; directly adding drop targets using SWT onto a site will cause the standard site behaviour (i.e. dragging files / markers into the EditorSite...) to not work when that editor is active.

      Note that this method may be used more than once should the part author wish to register different drop targets for internal controls (i.e. to support internal DnD).

      Specified by:
      addMergedDropTarget in interface IDragAndDropService
      Parameters:
      control - The control to add the drop behaviour to
      ops - The Drop operations used by this target
      transfers - The TransferTypes used by this target
      listener - The listener controlling the target's behaviour
    • removeMergedDropTarget

      public void removeMergedDropTarget(Control control)
      Description copied from interface: IDragAndDropService
      Remove any previously 'merged' drop target for this Control
      Specified by:
      removeMergedDropTarget in interface IDragAndDropService
      Parameters:
      control - The control to remove the drop target for
    • dispose

      public void dispose()
      Description copied from interface: IDisposable
      Disposes of this service. All resources must be freed. All listeners must be detached. Dispose will only be called once during the life cycle of a service.
      Specified by:
      dispose in interface IDisposable