DragSourceContext.java 11.1 KB
Newer Older
Tom Tromey committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
/* DragSourceContext.java --
   Copyright (C) 2002 Free Software Foundation

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */


package java.awt.dnd;

import java.awt.Component;
import java.awt.Cursor;
import java.awt.Image;
import java.awt.Point;
import java.awt.datatransfer.Transferable;
import java.awt.dnd.peer.DragSourceContextPeer;
import java.io.Serializable;
import java.util.TooManyListenersException;

/**
 * @since 1.2
 */
public class DragSourceContext
  implements DragSourceListener, DragSourceMotionListener, Serializable
{
  /**
   * Compatible with JDK 1.2+
   */
  static final long serialVersionUID = -115407898692194719L;

  protected static final int DEFAULT = 0;
  protected static final int ENTER = 1;
  protected static final int OVER = 2;
  protected static final int CHANGED = 3;

  private DragSourceContextPeer peer;
  private Cursor cursor;
  private Transferable transferable;
  private DragGestureEvent trigger;
  private DragSourceListener dragSourceListener;
71 72
  private boolean useCustomCursor;
  private int sourceActions;
Tom Tromey committed
73 74
  private Image image;
  private Point offset;
75

Tom Tromey committed
76 77 78 79 80 81 82
  /**
   * Initializes a drag source context.
   *
   * @exception IllegalArgumentException If Component or DragSource of trigger
   * are null, the drag action for the trigger event is DnDConstants.ACTION_NONE
   * or if the source actions for the DragGestureRecognizer associated with the
   * trigger event are equal to DnDConstants.ACTION_NONE.
83
   * @exception NullPointerException If peer, trans or trigger is null or if the
84
   * image is not null but the offset is.
Tom Tromey committed
85 86 87 88 89
   */
  public DragSourceContext (DragSourceContextPeer peer,
                            DragGestureEvent trigger, Cursor cursor,
                            Image image, Point offset, Transferable trans,
                            DragSourceListener dsl)
90
  {
Tom Tromey committed
91
    if (peer == null
92 93
        || trigger == null || trans == null
        || (image != null && offset == null))
Tom Tromey committed
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
      throw new NullPointerException ();

    if (trigger.getComponent () == null
        || trigger.getDragSource () == null
        || trigger.getDragAction () == DnDConstants.ACTION_NONE
        || trigger.getSourceAsDragGestureRecognizer ()
              .getSourceActions () == DnDConstants.ACTION_NONE)
      throw new IllegalArgumentException ();

    this.peer = peer;
    this.trigger = trigger;
    this.cursor = cursor;
    this.image = image;
    this.offset = offset;
    this.transferable = trans;
    this.dragSourceListener = dsl;
110
    this.sourceActions = trigger.getSourceAsDragGestureRecognizer().getSourceActions();
111

112 113
    setCursor(cursor);
    updateCurrentCursor(trigger.getDragAction(), sourceActions, DEFAULT);
Tom Tromey committed
114 115
  }

116 117 118
  /**
   * Returns the DragSource object associated with the
   * DragGestureEvent.
119
   *
120 121
   * @return the DragSource associated with the trigger.
   */
Tom Tromey committed
122 123 124 125 126
  public DragSource getDragSource()
  {
    return trigger.getDragSource ();
  }

127 128
  /**
   * Returns the component associated with this.
129
   *
130 131
   * @return the component associated with the trigger.
   */
Tom Tromey committed
132 133 134 135 136
  public Component getComponent()
  {
    return trigger.getComponent ();
  }

137 138
  /**
   * Gets the trigger associated with this.
139
   *
140 141
   * @return the trigger.
   */
Tom Tromey committed
142 143 144 145 146
  public DragGestureEvent getTrigger()
  {
    return trigger;
  }

147 148
  /**
   * Returns the source actions for the DragGestureRecognizer.
149
   *
150 151
   * @return the source actions for DragGestureRecognizer.
   */
Tom Tromey committed
152 153
  public int getSourceActions()
  {
154 155 156
    if (sourceActions == 0)
      sourceActions = trigger.getSourceAsDragGestureRecognizer().getSourceActions();
    return sourceActions;
Tom Tromey committed
157 158
  }

159 160
  /**
   * Sets the cursor for this drag operation to the specified cursor.
161
   *
162 163 164 165
   * @param cursor c - the Cursor to use, or null to use the default drag
   *          cursor.
   */
  public void setCursor(Cursor cursor)
Tom Tromey committed
166
  {
167 168 169 170
    if (cursor == null)
      useCustomCursor = false;
    else
      useCustomCursor = true;
Tom Tromey committed
171
    this.cursor = cursor;
172
    peer.setCursor(cursor);
Tom Tromey committed
173 174
  }

175 176 177
  /**
   * Returns the current cursor or null if the default
   * drag cursor is used.
178
   *
179 180
   * @return the current cursor or null.
   */
Tom Tromey committed
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
  public Cursor getCursor()
  {
    return cursor;
  }

  /**
   * Adds a <code>DragSourceListener</code>.
   *
   * @exception TooManyListenersException If a <code>DragSourceListener</code>
   * has already been added.
   */
  public void addDragSourceListener (DragSourceListener dsl)
    throws TooManyListenersException
  {
    if (dragSourceListener != null)
      throw new TooManyListenersException ();

    dragSourceListener = dsl;
  }

  public void removeDragSourceListener (DragSourceListener dsl)
  {
    if (dragSourceListener == dsl)
      dragSourceListener = null;
  }

207 208 209
  /**
   * This function tells the peer that the DataFlavors have been modified.
   */
Tom Tromey committed
210 211
  public void transferablesFlavorsChanged()
  {
212
    peer.transferablesFlavorsChanged();
Tom Tromey committed
213 214
  }

215 216 217
  /**
   * Calls dragEnter on the listeners registered with this
   * and with the DragSource.
218
   *
219 220
   * @param e - the DragSourceDragEvent
   */
Tom Tromey committed
221 222
  public void dragEnter(DragSourceDragEvent e)
  {
223 224
    if (dragSourceListener != null)
      dragSourceListener.dragEnter(e);
225

226 227 228 229
    DragSource ds = getDragSource();
    DragSourceListener[] dsl = ds.getDragSourceListeners();
    for (int i = 0; i < dsl.length; i++)
      dsl[i].dragEnter(e);
230

231
    updateCurrentCursor(e.getDropAction(), e.getTargetActions(), ENTER);
Tom Tromey committed
232 233
  }

234 235 236
  /**
   * Calls dragOver on the listeners registered with this
   * and with the DragSource.
237
   *
238 239
   * @param e - the DragSourceDragEvent
   */
Tom Tromey committed
240 241
  public void dragOver(DragSourceDragEvent e)
  {
242 243
    if (dragSourceListener != null)
      dragSourceListener.dragOver(e);
244

245 246 247 248
    DragSource ds = getDragSource();
    DragSourceListener[] dsl = ds.getDragSourceListeners();
    for (int i = 0; i < dsl.length; i++)
      dsl[i].dragOver(e);
249

250
    updateCurrentCursor(e.getDropAction(), e.getTargetActions(), OVER);
Tom Tromey committed
251
  }
252

253 254 255
  /**
   * Calls dragExit on the listeners registered with this
   * and with the DragSource.
256
   *
257 258
   * @param e - the DragSourceEvent
   */
Tom Tromey committed
259 260
  public void dragExit(DragSourceEvent e)
  {
261 262
    if (dragSourceListener != null)
      dragSourceListener.dragExit(e);
263

264 265 266 267
    DragSource ds = getDragSource();
    DragSourceListener[] dsl = ds.getDragSourceListeners();
    for (int i = 0; i < dsl.length; i++)
      dsl[i].dragExit(e);
268

269 270
    updateCurrentCursor(DnDConstants.ACTION_NONE, DnDConstants.ACTION_NONE,
                        DEFAULT);
Tom Tromey committed
271 272
  }

273 274 275
  /**
   * Calls dropActionChanged on the listeners registered with this
   * and with the DragSource.
276
   *
277 278
   * @param e - the DragSourceDragEvent
   */
Tom Tromey committed
279 280
  public void dropActionChanged(DragSourceDragEvent e)
  {
281 282
    if (dragSourceListener != null)
      dragSourceListener.dropActionChanged(e);
283

284 285 286 287
    DragSource ds = getDragSource();
    DragSourceListener[] dsl = ds.getDragSourceListeners();
    for (int i = 0; i < dsl.length; i++)
      dsl[i].dropActionChanged(e);
288

289
    updateCurrentCursor(e.getDropAction(), e.getTargetActions(), CHANGED);
Tom Tromey committed
290 291
  }

292 293 294
  /**
   * Calls dragDropEnd on the listeners registered with this
   * and with the DragSource.
295
   *
296 297
   * @param e - the DragSourceDropEvent
   */
Tom Tromey committed
298 299
  public void dragDropEnd(DragSourceDropEvent e)
  {
300 301
    if (dragSourceListener != null)
      dragSourceListener.dragDropEnd(e);
302

303 304 305 306
    DragSource ds = getDragSource();
    DragSourceListener[] dsl = ds.getDragSourceListeners();
    for (int i = 0; i < dsl.length; i++)
      dsl[i].dragDropEnd(e);
Tom Tromey committed
307 308
  }

309 310
  /**
   * Calls dragMouseMoved on the listeners registered with the DragSource.
311
   *
312 313
   * @param e - the DragSourceDragEvent
   */
Tom Tromey committed
314 315
  public void dragMouseMoved(DragSourceDragEvent e)
  {
316 317 318 319
    DragSource ds = getDragSource();
    DragSourceMotionListener[] dsml = ds.getDragSourceMotionListeners();
    for (int i = 0; i < dsml.length; i++)
      dsml[i].dragMouseMoved(e);
Tom Tromey committed
320 321
  }

322 323
  /**
   * Returns the Transferable set with this object.
324
   *
325 326
   * @return the transferable.
   */
Tom Tromey committed
327 328 329 330 331
  public Transferable getTransferable()
  {
    return transferable;
  }

332 333 334 335
  /**
   * This function sets the drag cursor for the specified operation, actions and
   * status if the default drag cursor is active. Otherwise, the cursor is not
   * updated in any way.
336
   *
337 338 339 340
   * @param dropOp - the current operation.
   * @param targetAct - the supported actions.
   * @param status - the status of the cursor (constant).
   */
Tom Tromey committed
341 342
  protected void updateCurrentCursor(int dropOp, int targetAct, int status)
  {
343
    if (! useCustomCursor)
344
      {
345
        Cursor newCursor = null;
346 347
        switch (status)
          {
348 349
          default:
            targetAct = DnDConstants.ACTION_NONE;
350 351 352
          case ENTER:
          case CHANGED:
          case OVER:
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
            int action = dropOp & targetAct;
            if (action == DnDConstants.ACTION_NONE)
              {
                if ((dropOp & DnDConstants.ACTION_LINK) != 0)
                  newCursor = DragSource.DefaultLinkNoDrop;
                else if ((dropOp & DnDConstants.ACTION_MOVE) != 0)
                  newCursor = DragSource.DefaultMoveNoDrop;
                else
                  newCursor = DragSource.DefaultCopyNoDrop;
              }
            else
              {
                if ((dropOp & DnDConstants.ACTION_LINK) != 0)
                  newCursor = DragSource.DefaultLinkDrop;
                else if ((dropOp & DnDConstants.ACTION_MOVE) != 0)
                  newCursor = DragSource.DefaultMoveDrop;
                else
                  newCursor = DragSource.DefaultCopyDrop;
              }
372
          }
373

374 375 376 377 378 379 380
        if (cursor == null || ! cursor.equals(newCursor))
          {
            cursor = newCursor;
            DragSourceContextPeer p = peer;
            if (p != null)
              p.setCursor(cursor);
          }
381
      }
Tom Tromey committed
382 383
  }
} // class DragSourceContext