Mercurial > projects > dwt2
view org.eclipse.jface/src/org/eclipse/jface/viewers/DecorationOverlayIcon.d @ 12:bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
author | Frank Benoit <benoit@tionex.de> |
---|---|
date | Sat, 14 Mar 2009 18:23:29 +0100 |
parents | |
children |
line wrap: on
line source
/******************************************************************************* * Copyright (c) 2006, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * IBM Corporation - initial API and implementation * Port to the D programming language: * Frank Benoit <benoit@tionex.de> *******************************************************************************/ module org.eclipse.jface.viewers.DecorationOverlayIcon; import org.eclipse.jface.viewers.IDecoration; import org.eclipse.jface.util.Util; // import tango.util.Arrays; import org.eclipse.swt.graphics.Image; import org.eclipse.swt.graphics.ImageData; import org.eclipse.swt.graphics.Point; import org.eclipse.jface.resource.CompositeImageDescriptor; import org.eclipse.jface.resource.ImageDescriptor; import java.lang.all; import java.util.Arrays; /** * A <code>DecorationOverlayIcon</code> is an image descriptor that can be used * to overlay decoration images on to the 4 corner quadrants of a base image. * The four quadrants are {@link IDecoration#TOP_LEFT}, {@link IDecoration#TOP_RIGHT}, * {@link IDecoration#BOTTOM_LEFT} and {@link IDecoration#BOTTOM_RIGHT}. Additionally, * the overlay can be used to provide an underlay corresponding to {@link IDecoration#UNDERLAY}. * * @since 3.3 * @see IDecoration */ public class DecorationOverlayIcon : CompositeImageDescriptor { // the base image private Image base; // the overlay images private ImageDescriptor[] overlays; // the size private Point size; /** * Create the decoration overlay for the base image using the array of * provided overlays. The indices of the array correspond to the values * of the 5 overlay constants defined on {@link IDecoration} * ({@link IDecoration#TOP_LEFT}, {@link IDecoration#TOP_RIGHT}, * {@link IDecoration#BOTTOM_LEFT}, {@link IDecoration#BOTTOM_RIGHT} * and{@link IDecoration#UNDERLAY}). * * @param baseImage the base image * @param overlaysArray the overlay images * @param sizeValue the size of the resulting image */ public this(Image baseImage, ImageDescriptor[] overlaysArray, Point sizeValue) { this.base = baseImage; this.overlays = overlaysArray; this.size = sizeValue; } /** * Create the decoration overlay for the base image using the array of * provided overlays. The indices of the array correspond to the values * of the 5 overlay constants defined on {@link IDecoration} * ({@link IDecoration#TOP_LEFT}, {@link IDecoration#TOP_RIGHT}, * {@link IDecoration#BOTTOM_LEFT}, {@link IDecoration#BOTTOM_RIGHT} * and {@link IDecoration#UNDERLAY}). * * @param baseImage the base image * @param overlaysArray the overlay images */ public this(Image baseImage, ImageDescriptor[] overlaysArray) { this(baseImage, overlaysArray, new Point(baseImage.getBounds().width, baseImage.getBounds().height)); } /** * Create a decoration overlay icon that will place the given overlay icon in * the given quadrant of the base image. * @param baseImage the base image * @param overlayImage the overlay image * @param quadrant the quadrant (one of {@link IDecoration} * ({@link IDecoration#TOP_LEFT}, {@link IDecoration#TOP_RIGHT}, * {@link IDecoration#BOTTOM_LEFT}, {@link IDecoration#BOTTOM_RIGHT} * or {@link IDecoration#UNDERLAY}) */ public this(Image baseImage, ImageDescriptor overlayImage, int quadrant) { this(baseImage, createArrayFrom(overlayImage, quadrant)); } /** * Convert the given image and quadrant into the proper input array. * @param overlayImage the overlay image * @param quadrant the quadrant * @return an array with the given image in the proper quadrant */ private static ImageDescriptor[] createArrayFrom( ImageDescriptor overlayImage, int quadrant) { ImageDescriptor[] descs = [ cast(ImageDescriptor) null, null, null, null, null ]; descs[quadrant] = overlayImage; return descs; } /** * Draw the overlays for the receiver. * @param overlaysArray */ private void drawOverlays(ImageDescriptor[] overlaysArray) { for (int i = 0; i < overlays.length; i++) { ImageDescriptor overlay = overlaysArray[i]; if (overlay is null) { continue; } ImageData overlayData = overlay.getImageData(); //Use the missing descriptor if it is not there. if (overlayData is null) { overlayData = ImageDescriptor.getMissingImageDescriptor() .getImageData(); } switch (i) { case IDecoration.TOP_LEFT: drawImage(overlayData, 0, 0); break; case IDecoration.TOP_RIGHT: drawImage(overlayData, size.x - overlayData.width, 0); break; case IDecoration.BOTTOM_LEFT: drawImage(overlayData, 0, size.y - overlayData.height); break; case IDecoration.BOTTOM_RIGHT: drawImage(overlayData, size.x - overlayData.width, size.y - overlayData.height); break; default: } } } /* (non-Javadoc) * @see java.lang.Object#equals(java.lang.Object) */ public override int opEquals(Object o) { if (!( cast(DecorationOverlayIcon)o )) { return false; } DecorationOverlayIcon other = cast(DecorationOverlayIcon) o; return base.opEquals(other.base) && Util.opEquals(overlays, other.overlays); } /* (non-Javadoc) * @see java.lang.Object#hashCode() */ public override hash_t toHash() { int code = System.identityHashCode(base); for (int i = 0; i < overlays.length; i++) { if (overlays[i] !is null) { code ^= overlays[i].toHash(); } } return code; } /* (non-Javadoc) * @see org.eclipse.jface.resource.CompositeImageDescriptor#drawCompositeImage(int, int) */ protected override void drawCompositeImage(int width, int height) { if (overlays.length > IDecoration.UNDERLAY) { ImageDescriptor underlay = overlays[IDecoration.UNDERLAY]; if (underlay !is null) { drawImage(underlay.getImageData(), 0, 0); } } if (overlays.length > IDecoration.REPLACE && overlays[IDecoration.REPLACE] !is null) { drawImage(overlays[IDecoration.REPLACE].getImageData(), 0, 0); } else { drawImage(base.getImageData(), 0, 0); } drawOverlays(overlays); } /* (non-Javadoc) * @see org.eclipse.jface.resource.CompositeImageDescriptor#getSize() */ protected override Point getSize() { return size; } /* (non-Javadoc) * @see org.eclipse.jface.resource.CompositeImageDescriptor#getTransparentPixel() */ protected override int getTransparentPixel() { return base.getImageData().transparentPixel; } }