Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.jface.viewers
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.jface.viewers.DecorationOverlayIcon

public class DecorationOverlayIcon
extends 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 ( Image baseImage, ImageDescriptor[] overlaysArray)
          Create the decoration overlay for the base image using the array of provided overlays.
DecorationOverlayIcon ( Image baseImage, ImageDescriptor[] overlaysArray, Point sizeValue)
          Create the decoration overlay for the base image using the array of provided overlays.
DecorationOverlayIcon ( Image baseImage, 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)
          Draw the composite images.
 boolean equals ( Object o)
           
protected   Point getSize ()
          Return the size of this composite image.
protected  int getTransparentPixel ()
          Return the transparent pixel for the receiver.
 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(
Image baseImage,
                             
ImageDescriptor[] overlaysArray,
                             
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 and IDecoration.UNDERLAY).

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

DecorationOverlayIcon

public DecorationOverlayIcon(
Image baseImage,
                             
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(
Image baseImage,
                             
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(
Object o)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

drawCompositeImage

protected void drawCompositeImage(int width,
                                  int height)
Description copied from class: CompositeImageDescriptor
Draw the composite images.

Subclasses must implement this framework method to paint images within the given bounds using one or more calls to the drawImage framework method.

Specified by:
drawCompositeImage in class CompositeImageDescriptor
Parameters:
width - the width
height - the height

getSize

protected 
Point getSize()
Description copied from class: CompositeImageDescriptor
Return the size of this composite image.

Subclasses must implement this framework method.

Specified by:
getSize in class CompositeImageDescriptor
Returns:
the x and y size of the image expressed as a point object

getTransparentPixel

protected int getTransparentPixel()
Description copied from class: CompositeImageDescriptor
Return the transparent pixel for the receiver. NOTE This value is not currently in use in the default implementation.

Overrides:
getTransparentPixel in class CompositeImageDescriptor
Returns:
int

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire