org.eclipse.ocl.examples.modelregistry.ui.icons
Class DecorationOverlayIcon

java.lang.Object
  extended by org.eclipse.jface.resource.DeviceResourceDescriptor
      extended by org.eclipse.jface.resource.ImageDescriptor
          extended by org.eclipse.jface.resource.CompositeImageDescriptor
              extended by org.eclipse.ocl.examples.modelregistry.ui.icons.DecorationOverlayIcon

public class DecorationOverlayIcon
extends org.eclipse.jface.resource.CompositeImageDescriptor

A DecorationOverlayIcon 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 IDecoration.TOP_LEFT, IDecoration.TOP_RIGHT, IDecoration.BOTTOM_LEFT and IDecoration.BOTTOM_RIGHT. Additionally, the overlay can be used to provide an underlay corresponding to IDecoration.UNDERLAY.

Since:
3.3
See Also:
IDecoration

Field Summary
 
Fields inherited from class org.eclipse.jface.resource.ImageDescriptor
DEFAULT_IMAGE_DATA
 
Constructor Summary
DecorationOverlayIcon(org.eclipse.swt.graphics.Image baseImage, org.eclipse.jface.resource.ImageDescriptor[] overlaysArray)
          Create the decoration overlay for the base image using the array of provided overlays.
DecorationOverlayIcon(org.eclipse.swt.graphics.Image baseImage, org.eclipse.jface.resource.ImageDescriptor[] overlaysArray, org.eclipse.swt.graphics.Point sizeValue)
          Create the decoration overlay for the base image using the array of provided overlays.
DecorationOverlayIcon(org.eclipse.swt.graphics.Image baseImage, org.eclipse.jface.resource.ImageDescriptor overlayImage, int quadrant)
          Create a decoration overlay icon that will place the given overlay icon in the given quadrant of the base image.
 
Method Summary
protected  void drawCompositeImage(int width, int height)
           
 boolean equals(java.lang.Object o)
           
protected  org.eclipse.swt.graphics.Point getSize()
           
protected  int getTransparentPixel()
           
 int hashCode()
           
 
Methods inherited from class org.eclipse.jface.resource.CompositeImageDescriptor
drawImage, getImageData, setImageData
 
Methods inherited from class org.eclipse.jface.resource.ImageDescriptor
createFromFile, createFromImage, createFromImage, createFromImageData, createFromURL, createImage, createImage, createImage, createImage, createResource, createWithFlags, destroyResource, getMissingImageDescriptor
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DecorationOverlayIcon

public DecorationOverlayIcon(org.eclipse.swt.graphics.Image baseImage,
                             org.eclipse.jface.resource.ImageDescriptor[] overlaysArray,
                             org.eclipse.swt.graphics.Point 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 IDecoration (IDecoration.TOP_LEFT, IDecoration.TOP_RIGHT, IDecoration.BOTTOM_LEFT, IDecoration.BOTTOM_RIGHT andIDecoration.UNDERLAY).

Parameters:
baseImage - the base image
overlaysArray - the overlay images
sizeValue - the size of the resulting image

DecorationOverlayIcon

public DecorationOverlayIcon(org.eclipse.swt.graphics.Image baseImage,
                             org.eclipse.jface.resource.ImageDescriptor[] overlaysArray)
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 IDecoration (IDecoration.TOP_LEFT, IDecoration.TOP_RIGHT, IDecoration.BOTTOM_LEFT, IDecoration.BOTTOM_RIGHT and IDecoration.UNDERLAY).

Parameters:
baseImage - the base image
overlaysArray - the overlay images

DecorationOverlayIcon

public DecorationOverlayIcon(org.eclipse.swt.graphics.Image baseImage,
                             org.eclipse.jface.resource.ImageDescriptor overlayImage,
                             int quadrant)
Create a decoration overlay icon that will place the given overlay icon in the given quadrant of the base image.

Parameters:
baseImage - the base image
overlayImage - the overlay image
quadrant - the quadrant (one of IDecoration (IDecoration.TOP_LEFT, IDecoration.TOP_RIGHT, IDecoration.BOTTOM_LEFT, IDecoration.BOTTOM_RIGHT or IDecoration.UNDERLAY)
Method Detail

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

drawCompositeImage

protected void drawCompositeImage(int width,
                                  int height)
Specified by:
drawCompositeImage in class org.eclipse.jface.resource.CompositeImageDescriptor

getSize

protected org.eclipse.swt.graphics.Point getSize()
Specified by:
getSize in class org.eclipse.jface.resource.CompositeImageDescriptor

getTransparentPixel

protected int getTransparentPixel()
Overrides:
getTransparentPixel in class org.eclipse.jface.resource.CompositeImageDescriptor