| java.lang.Object
 net.refractions.udig.ui.IDropAction
All known Subclasses: net.refractions.udig.project.ui.internal.dragdrop.MoveProjectElement, net.refractions.udig.project.ui.internal.dragdrop.MoveLayerDropAction, net.refractions.udig.project.ui.internal.actions.SLDDropAction, net.refractions.udig.catalog.internal.ui.actions.CatalogImportDropAction, net.refractions.udig.project.ui.internal.actions.DropMap, net.refractions.udig.project.ui.internal.dragdrop.DropFilterAction, net.refractions.udig.project.ui.internal.dragdrop.MoveLayerDropActionLayer, net.refractions.udig.project.ui.internal.actions.OnProjectDropAction, net.refractions.udig.project.ui.internal.actions.LayerDropAction,
| IDropAction | | abstract public class IDropAction (Code) | | Defines the behaviour when a drag and drop event occurs. The extension declaration combined with the accepts method
determines whether the Action will be ran for a given drag/drop event.
If the enablesFor is a anything other than null or 1 then an array of objects (all the same type)
will be the data returned by getData, otherwise the data be a single object (not an array).
author:
jdeolive
since:
1.0.0 |
| Method Summary | |
| abstract public boolean | accept()
Called if the action seems to be a good candidate for handling the drop event. | | public Object | getData()
Returns the dropped data. | | public Object | getDestination()
Returns the object that the data was dropped on. | | public IConfigurationElement | getElement()
Returns the Configuration element that definates the action in the extension declaration. | | public DropTargetEvent | getEvent()
The drop event. | | public String | getName()
Returns the name of the action. | | public ViewerDropLocation | getViewerLocation()
This does not always make sense for the drop event. | | public void | init(IConfigurationElement element2, DropTargetEvent event2, ViewerDropLocation location2, Object destination2, Object data2)
Called by framework to initialize the action.
Parameters:
element2 - the extension configuration element
Parameters:
event2 - the drop event.
Parameters:
location - wrt the destination. | | abstract public void | perform(IProgressMonitor monitor)
Performs the drop action. |
| element | | IConfigurationElement element(Code) | | the extension info *
|
| accept | | abstract public boolean accept()(Code) | | Called if the action seems to be a good candidate for handling the drop event.
See Also: #getData();
See Also: IDropAction.getData()
See Also: IDropAction.getEvent() true if the action this it should handle the drop event. |
| getData | | public Object getData()(Code) | | Returns the dropped data. If the enablesFor is a anything other than null or 1 then an array of objects (all the same type)
will be the data, otherwise the data will not be in an array.
the dropped data. |
| getDestination | | public Object getDestination()(Code) | | Returns the object that the data was dropped on.
the object that the data was dropped on. |
| getElement | | public IConfigurationElement getElement()(Code) | | Returns the Configuration element that definates the action in the extension declaration.
the Configuration element that definates the action in the extension declaration. |
| getEvent | | public DropTargetEvent getEvent()(Code) | | The drop event.
Returns the drop event. |
| getName | | public String getName()(Code) | | Returns the name of the action.
Returns the name of the action. |
| getViewerLocation | | public ViewerDropLocation getViewerLocation()(Code) | | This does not always make sense for the drop event. But in the case that the component is a jface viewer then this method will indicate the
location where the drop is taking place (before, on or after the destination object).
See Also: ViewerDropAdapter.getCurrentLocation If the component is not a viewer this will always return ViewerDropAdapter.LOCATION_ON otherwise it will be one of the LOCATION_* values. |
| init | | public void init(IConfigurationElement element2, DropTargetEvent event2, ViewerDropLocation location2, Object destination2, Object data2)(Code) | | Called by framework to initialize the action.
Parameters:
element2 - the extension configuration element
Parameters:
event2 - the drop event.
Parameters:
location - wrt the destination.
Parameters:
destination2 - the object that the data was dropped on.
Parameters:
data2 - the data that was dropped. |
| perform | | abstract public void perform(IProgressMonitor monitor)(Code) | | Performs the drop action.
Parameters:
monitor - a progress monitor for showing the progress of the current event. |
|
|