org.eclipse.nebula.widgets.grid.GridDragSourceEffect Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nebula-grid Show documentation
Fork of Eclipse Nebula grid widget
The newest version!
package org.eclipse.nebula.widgets.grid;

import java.util.ArrayList;
import java.util.List;

import org.eclipse.swt.dnd.DragSourceAdapter;
import org.eclipse.swt.dnd.DragSourceEffect;
import org.eclipse.swt.dnd.DragSourceEvent;
import org.eclipse.swt.graphics.GC;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.graphics.Rectangle;
import org.eclipse.swt.widgets.Display;


/**
 * This class provides default implementations to display a source image
 * when a drag is initiated from a Grid.
 *
 * Classes that wish to provide their own source image for a Grid can
 * extend DragSourceAdapter class and override the DragSourceAdapter.dragStart
 * method and set the field DragSourceEvent.image with their own image.
 *
 * Subclasses that override any methods of this class must call the corresponding
 * super method to get the default drag under effect implementation.
 *
 * @see DragSourceAdapter
 * @see DragSourceEvent
 *
 * @since 3.3
 * @author mark-oliver.reiser
 */
public class GridDragSourceEffect extends DragSourceEffect {

	Image dragSourceImage = null;

	/**
	 *
	 * @param grid
	 */
	public GridDragSourceEffect(Grid grid) {
		super(grid);
	}

	/**
	 * This implementation of dragFinished disposes the image
	 * that was created in GridDragSourceEffect.dragStart.
	 *
	 * Subclasses that override this method should call super.dragFinished(event)
	 * to dispose the image in the default implementation.
	 *
	 * @param event the information associated with the drag finished event
	 */
	@Override
	public void dragFinished(DragSourceEvent event) {
		if (dragSourceImage != null) dragSourceImage.dispose();
		dragSourceImage = null;
	}

	/**
	 * This implementation of dragStart will create a default
	 * image that will be used during the drag. The image should be disposed
	 * when the drag is completed in the GridDragSourceEffect.dragFinished
	 * method.
	 *
	 * Subclasses that override this method should call super.dragStart(event)
	 * to use the image from the default implementation.
	 *
	 * @param event the information associated with the drag start event
	 */
	@Override
	public void dragStart(DragSourceEvent event) {
		event.image = getDragSourceImage(event);
	}

	Image getDragSourceImage(DragSourceEvent event) {
		if (dragSourceImage != null) dragSourceImage.dispose();
		dragSourceImage = null;
		Grid grid = (Grid) getControl();
		Display display = grid.getDisplay();
		Rectangle empty = new Rectangle(0,0,0,0);

		// Collect the currently selected items.
		Point[] selection;
		if(grid.getCellSelectionEnabled()){
			selection = grid.getCellSelection();
		} else {
			List l = new ArrayList<>();
			GridItem[] selItems = grid.getSelection();
			for (int i = 0; i < selItems.length; i++){
				for (int j = 0; j < grid.getColumnCount() ; j++){
					if(grid.getColumn(j).isVisible()){
						l.add(new Point(j,selItems[i].getRowIndex()));
					}
				}
			}
			selection = l.toArray(new Point[l.size()]);
		}
		if (selection.length == 0) return null;

		Rectangle bounds=null;
		for (int i = 0; i < selection.length; i++) {
			GridItem item = grid.getItem(selection[i].y);
			Rectangle currBounds = item.getBounds(selection[i].x);

			if(empty.equals(currBounds)){
				selection[i]=null;
			}else {
				if(bounds==null){
					bounds = currBounds;
				}else {
					bounds = bounds.union(currBounds);
				}
			}
		}
		if(bounds==null) return null;
		if (bounds.width <= 0 || bounds.height <= 0) return null;

		dragSourceImage = new Image(display,bounds.width,bounds.height);
		GC gc = new GC(dragSourceImage);
		for (int i = 0; i < selection.length; i++) {
			if(selection[i]==null) continue;
			GridItem item = grid.getItem(selection[i].y);
			GridColumn column = grid.getColumn(selection[i].x);
			Rectangle currBounds = item.getBounds(selection[i].x);
			GridCellRenderer r = column.getCellRenderer();
			r.setBounds(currBounds.x-bounds.x, currBounds.y-bounds.y, currBounds.width, currBounds.height);
            gc.setClipping(currBounds.x-bounds.x-1, currBounds.y-bounds.y-1, currBounds.width+2, currBounds.height+2);
			r.setColumn(selection[i].x);
            r.setSelected(false);
            r.setFocus(false);
            r.setRowFocus(false);
            r.setCellFocus(false);
            r.setRowHover(false);
            r.setColumnHover(false);
            r.setCellSelected(false);
            r.setHoverDetail("");
            r.setDragging(true);
            r.paint(gc, item);
            gc.setClipping((Rectangle)null);
		}
		gc.dispose();

		return dragSourceImage;
	}
}