diff options
Diffstat (limited to 'bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated')
8 files changed, 86 insertions, 25 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/Clipboard.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/Clipboard.java index 4835e2f125..087bc9da56 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/Clipboard.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/Clipboard.java @@ -245,7 +245,7 @@ public boolean isDisposed () { * * <p>NOTE: On some platforms, the data is immediately copied to the system * clipboard but on other platforms it is provided upon request. As a result, - * if the application modifes the data object it has set on the clipboard, that + * if the application modifies the data object it has set on the clipboard, that * modification may or may not be available when the data is subsequently * requested.</p> * @@ -283,7 +283,7 @@ public boolean isDisposed () { * </ul> * * <p>NOTE: ERROR_CANNOT_SET_CLIPBOARD should be an SWTException, since it is a - * recoverable error, but can not be changed due to backward compatability.</p> + * recoverable error, but can not be changed due to backward compatibility.</p> */ public void setContents(Object[] data, Transfer[] dataTypes) { setContents(data, dataTypes, DND.CLIPBOARD); @@ -297,7 +297,7 @@ public void setContents(Object[] data, Transfer[] dataTypes) { * * <p>NOTE: On some platforms, the data is immediately copied to the specified * clipboard but on other platforms it is provided upon request. As a result, - * if the application modifes the data object it has set on the clipboard, that + * if the application modifies the data object it has set on the clipboard, that * modification may or may not be available when the data is subsequently * requested.</p> * @@ -341,7 +341,7 @@ public void setContents(Object[] data, Transfer[] dataTypes) { * </ul> * * <p>NOTE: ERROR_CANNOT_SET_CLIPBOARD should be an SWTException, since it is a - * recoverable error, but can not be changed due to backward compatability.</p> + * recoverable error, but can not be changed due to backward compatibility.</p> * * @see DND#CLIPBOARD * @see DND#SELECTION_CLIPBOARD diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/DragSource.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/DragSource.java index 1d90cb303e..3824c317d0 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/DragSource.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/DragSource.java @@ -121,7 +121,7 @@ public class DragSource extends Widget { * </ul> * * <p>NOTE: ERROR_CANNOT_INIT_DRAG should be an SWTException, since it is a - * recoverable error, but can not be changed due to backward compatability.</p> + * recoverable error, but can not be changed due to backward compatibility.</p> * * @see Widget#dispose * @see DragSource#checkSubclass @@ -233,7 +233,7 @@ public Control getControl () { /** * Returns the drag effect that is registered for this DragSource. This drag - * effect will be used during a drag and drop event to display the drag source image. + * effect will be used during a drag and drop operation. * * @return the drag effect that is registered for this DragSource * @@ -291,7 +291,7 @@ public void removeDragListener(DragSourceListener listener) { /** * Specifies the drag effect for this DragSource. This drag effect will be - * used during a drag and drop to display the drag source image. + * used during a drag and drop operation. * * @param effect the drag effect that is registered for this DragSource * diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/DropTarget.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/DropTarget.java index 3f4be69397..830faaf08c 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/DropTarget.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/DropTarget.java @@ -98,7 +98,7 @@ public class DropTarget extends Widget { * </ul> * * <p>NOTE: ERROR_CANNOT_INIT_DROP should be an SWTException, since it is a - * recoverable error, but can not be changed due to backward compatability.</p> + * recoverable error, but can not be changed due to backward compatibility.</p> * * @see Widget#dispose * @see DropTarget#checkSubclass @@ -207,11 +207,11 @@ public Control getControl () { } /** - * Specifies the drop effect for this DropTarget. This drop effect will be + * Returns the drop effect for this DropTarget. This drop effect will be * used during a drag and drop to display the drag under effect on the * target widget. * - * @param effect the drop effect that is registered for this DropTarget + * @return the drop effect that is registered for this DropTarget * * @since 3.3 */ diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/TableDragSourceEffect.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/TableDragSourceEffect.java index e2402bf730..416864d6f5 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/TableDragSourceEffect.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/TableDragSourceEffect.java @@ -17,14 +17,14 @@ import org.eclipse.swt.widgets.*; * when a drag is initiated from a <code>Table</code>. * * <p>Classes that wish to provide their own source image for a <code>Table</code> can - * extend the <code>DragSourceAdapter</code> class, override the - * <code>DragSourceAdapter.dragStart</code> method and set the field + * extend the <code>TableDragSourceEffect</code> class, override the + * <code>TableDragSourceEffect.dragStart</code> method and set the field * <code>DragSourceEvent.image</code> with their own image.</p> * * Subclasses that override any methods of this class must call the corresponding * <code>super</code> method to get the default drag source effect implementation. * - * @see DragSourceAdapter + * @see DragSourceEffect * @see DragSourceEvent * * @since 3.3 @@ -35,7 +35,7 @@ public class TableDragSourceEffect extends DragSourceEffect { * from the specified <code>Table</code>. * * @param table the <code>Table</code> that the user clicks on to initiate the drag - **/ + */ public TableDragSourceEffect(Table table) { super(table); } diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/TableDropTargetEffect.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/TableDropTargetEffect.java index ecc2b83bc2..ab075d16b3 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/TableDropTargetEffect.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/TableDropTargetEffect.java @@ -12,6 +12,35 @@ package org.eclipse.swt.dnd; import org.eclipse.swt.widgets.*; +/** + * This class provides a default drag under effect (eg. select, insert and scroll) + * when a drag occurs over a <code>Table</code>. + * + * <p>Classes that wish to provide their own drag under effect for a <code>Table</code> + * can extend the <code>TableDropTargetEffect</code> and override any applicable methods + * in <code>TableDropTargetEffect</code> to display their own drag under effect.</p> + * + * Subclasses that override any methods of this class must call the corresponding + * <code>super</code> method to get the default drag under effect implementation. + * + * <p>The feedback value is either one of the FEEDBACK constants defined in + * class <code>DND</code> which is applicable to instances of this class, + * or it must be built by <em>bitwise OR</em>'ing together + * (that is, using the <code>int</code> "|" operator) two or more + * of those <code>DND</code> effect constants. + * </p> + * <p> + * <dl> + * <dt><b>Feedback:</b></dt> + * <dd>FEEDBACK_SELECT, FEEDBACK_SCROLL</dd> + * </dl> + * </p> + * + * @see DropTargetAdapter + * @see DropTargetEvent + * + * @since 3.3 + */ public class TableDropTargetEffect extends DropTargetEffect { /** * Creates a new <code>TableDropTargetEffect</code> to handle the drag under effect on the specified diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/Transfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/Transfer.java index ad5ffd5835..a21f3aba26 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/Transfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/Transfer.java @@ -50,19 +50,19 @@ abstract public TransferData[] getSupportedTypes(); abstract public boolean isSupportedType(TransferData transferData); /** - * Returns the platform specfic names of the data types that can be converted + * Returns the platform specific names of the data types that can be converted * using this transfer agent. * - * @return the platform specfic names of the data types that can be converted + * @return the platform specific names of the data types that can be converted * using this transfer agent. */ abstract protected String[] getTypeNames(); /** - * Returns the platform specfic ids of the data types that can be converted using + * Returns the platform specific ids of the data types that can be converted using * this transfer agent. * - * @return the platform specfic ids of the data types that can be converted using + * @return the platform specific ids of the data types that can be converted using * this transfer agent */ abstract protected int[] getTypeIds(); @@ -89,7 +89,7 @@ abstract protected int[] getTypeIds(); * </ul></p> * * @param object a java representation of the data to be converted; the type of - * Object that is passed in is dependant on the <code>Transfer</code> subclass. + * Object that is passed in is dependent on the <code>Transfer</code> subclass. * * @param transferData an empty TransferData object; this object will be * filled in on return with the platform specific representation of the data @@ -109,7 +109,7 @@ abstract protected void javaToNative (Object object, TransferData transferData); * @return a java representation of the converted data if the conversion was * successful; otherwise null. If transferData is <code>null</code> then * <code>null</code> is returned. The type of Object that is returned is - * dependant on the <code>Transfer</code> subclass. + * dependent on the <code>Transfer</code> subclass. */ abstract protected Object nativeToJava(TransferData transferData); diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/TreeDragSourceEffect.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/TreeDragSourceEffect.java index d78790cbeb..97cd46f444 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/TreeDragSourceEffect.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/TreeDragSourceEffect.java @@ -16,14 +16,14 @@ import org.eclipse.swt.widgets.*; * This class provides default implementations to display a source image * when a drag is initiated from a <code>Tree</code>. * - * <p>Classes that wish to provide their own source image for a <code>Table</code> can - * extend <code>DragSourceAdapter</code> class and override the <code>DragSourceAdapter.dragStart</code> + * <p>Classes that wish to provide their own source image for a <code>Tree</code> can + * extend <code>TreeDragSourceEffect</code> class and override the <code>TreeDragSourceEffect.dragStart</code> * method and set the field <code>DragSourceEvent.image</code> with their own image.</p> * * Subclasses that override any methods of this class must call the corresponding * <code>super</code> method to get the default drag under effect implementation. * - * @see DragSourceAdapter + * @see DragSourceEffect * @see DragSourceEvent * * @since 3.3 @@ -33,8 +33,8 @@ public class TreeDragSourceEffect extends DragSourceEffect { * Creates a new <code>TreeDragSourceEffect</code> to handle drag effect * from the specified <code>Tree</code>. * - * @param table the <code>Tree</code> that the user clicks on to initiate the drag - **/ + * @param tree the <code>Tree</code> that the user clicks on to initiate the drag + */ public TreeDragSourceEffect(Tree tree) { super(tree); } diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/TreeDropTargetEffect.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/TreeDropTargetEffect.java index 65a7009170..71536f846c 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/TreeDropTargetEffect.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/emulated/org/eclipse/swt/dnd/TreeDropTargetEffect.java @@ -12,6 +12,38 @@ package org.eclipse.swt.dnd; import org.eclipse.swt.widgets.*; +/** + * This class provides a default drag under effect (eg. select, insert, scroll and expand) + * when a drag occurs over a <code>Tree</code>. + * + * <p>Classes that wish to provide their own drag under effect for a <code>Tree</code> + * can extend the <code>TreeDropTargetEffect</code> class and override any applicable methods + * in <code>TreeDropTargetEffect</code> to display their own drag under effect.</p> + * + * Subclasses that override any methods of this class must call the corresponding + * <code>super</code> method to get the default drag under effect implementation. + * + * <p>The feedback value is either one of the FEEDBACK constants defined in + * class <code>DND</code> which is applicable to instances of this class, + * or it must be built by <em>bitwise OR</em>'ing together + * (that is, using the <code>int</code> "|" operator) two or more + * of those <code>DND</code> effect constants. + * </p> + * <p> + * <dl> + * <dt><b>Feedback:</b></dt> + * <dd>FEEDBACK_SELECT, FEEDBACK_INSERT_BEFORE, FEEDBACK_INSERT_AFTER, FEEDBACK_EXPAND, FEEDBACK_SCROLL</dd> + * </dl> + * </p><p> + * Note: Only one of the styles FEEDBACK_SELECT, FEEDBACK_INSERT_BEFORE or + * FEEDBACK_INSERT_AFTER may be specified. + * </p> + * + * @see DropTargetAdapter + * @see DropTargetEvent + * + * @since 3.3 + */ public class TreeDropTargetEffect extends DropTargetEffect { /** * Creates a new <code>TreeDropTargetEffect</code> to handle the drag under effect on the specified |