Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: com :: sun :: star :: datatransfer :: dnd ::

interface XDropTarget
Description
This interface is implemented by a view or window that supports drop operations.

Differently to Java, the association between view and interface is fixed and cannot be changed. Otherwise, the AWT messaging would have to be implemented for any window supporting Drag and Drop operations, which would be a performance issue.


Methods' Summary
addDropTargetListener Add a DropTargetListener.  
removeDropTargetListener Remove a drop target listener.  
isActive Indicates either a drop target object is active or not.  
setActive Sets the drop target object active or inactive.  
getDefaultActions Determine the actions supported by a drop target.  
setDefaultActions Sets the default acceptable actions for this drop target.  
Methods' Details
addDropTargetListener
[oneway] void
addDropTargetListener( [in] XDropTargetListener  dtl );

Description
Add a DropTargetListener.

The listener will be queried for the XAutoscroll interface to see if it supports autoscrolling.

Parameter dtl
The listener to add to the notification list.
removeDropTargetListener
[oneway] void
removeDropTargetListener( [in] XDropTargetListener  dtl );

Description
Remove a drop target listener.
Parameter dtl
The listener to remove from notification list.
isActive
boolean
isActive();

Description
Indicates either a drop target object is active or not.
Returns
A boolean indicating whether or not this drop target object is currently active, that is ready to accept drops.
setActive
void
setActive( [in] boolean  active );

Description
Sets the drop target object active or inactive.
Parameter active
A value of true sets the drop target object active.

A value of false sets the drop target object inactive.

getDefaultActions
byte
getDefaultActions();

Description
Determine the actions supported by a drop target.
Returns
The current action or actions supported by this drop target.

By default this will include all drag and drop actions.

See also
DNDConstants
setDefaultActions
[oneway] void
setDefaultActions( [in] byte  actions );

Description
Sets the default acceptable actions for this drop target.

This method is a way to reduce the number of Drag and Drop events by blocking events for actions not supported by this target.

By default the listener will receive notifications for all actions.

Parameter actions
The actions.
See also
DNDConstants
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.