*******************************************************************************/
package net.sourceforge.phpdt.ui;
-
-import org.eclipse.swt.graphics.ImageData;
-import org.eclipse.swt.graphics.Point;
+import net.sourceforge.phpdt.internal.ui.PHPUiImages;
import org.eclipse.jface.resource.CompositeImageDescriptor;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.jface.util.Assert;
-
-import net.sourceforge.phpdt.internal.ui.PHPUiImages;
+import org.eclipse.swt.graphics.ImageData;
+import org.eclipse.swt.graphics.Point;
/**
- * A JavaImageDescriptor consists of a base image and several adornments. The adornments
- * are computed according to the flags either passed during creation or set via the method
- * <code>setAdornments</code>.
+ * A JavaImageDescriptor consists of a base image and several adornments. The
+ * adornments are computed according to the flags either passed during creation
+ * or set via the method <code>setAdornments</code>.
*
* <p>
* This class may be instantiated; it is not intended to be subclassed.
* </p>
- *
- * @since 2.0
+ *
+ * @since 2.0
*/
public class JavaElementImageDescriptor extends CompositeImageDescriptor {
-
+
/** Flag to render the abstract adornment */
- public final static int ABSTRACT= 0x001;
-
+ public final static int ABSTRACT = 0x001;
+
/** Flag to render the final adornment */
- public final static int FINAL= 0x002;
-
+ public final static int FINAL = 0x002;
+
/** Flag to render the synchronized adornment */
- public final static int SYNCHRONIZED= 0x004;
-
+ public final static int SYNCHRONIZED = 0x004;
+
/** Flag to render the static adornment */
- public final static int STATIC= 0x008;
-
+ public final static int STATIC = 0x008;
+
/** Flag to render the runnable adornment */
- public final static int RUNNABLE= 0x010;
-
+ public final static int RUNNABLE = 0x010;
+
/** Flag to render the waring adornment */
- public final static int WARNING= 0x020;
-
+ public final static int WARNING = 0x020;
+
/** Flag to render the error adornment */
- public final static int ERROR= 0x040;
-
+ public final static int ERROR = 0x040;
+
/** Flag to render the 'override' adornment */
- public final static int OVERRIDES= 0x080;
-
+ public final static int OVERRIDES = 0x080;
+
/** Flag to render the 'implements' adornment */
- public final static int IMPLEMENTS= 0x100;
-
+ public final static int IMPLEMENTS = 0x100;
+
/** Flag to render the 'constructor' adornment */
- public final static int CONSTRUCTOR= 0x200;
+ public final static int CONSTRUCTOR = 0x200;
private ImageDescriptor fBaseImage;
+
private int fFlags;
+
private Point fSize;
/**
* Creates a new JavaElementImageDescriptor.
*
- * @param baseImage an image descriptor used as the base image
- * @param flags flags indicating which adornments are to be rendered. See <code>setAdornments</code>
- * for valid values.
- * @param size the size of the resulting image
+ * @param baseImage
+ * an image descriptor used as the base image
+ * @param flags
+ * flags indicating which adornments are to be rendered. See
+ * <code>setAdornments</code> for valid values.
+ * @param size
+ * the size of the resulting image
* @see #setAdornments(int)
*/
- public JavaElementImageDescriptor(ImageDescriptor baseImage, int flags, Point size) {
- fBaseImage= baseImage;
+ public JavaElementImageDescriptor(ImageDescriptor baseImage, int flags,
+ Point size) {
+ fBaseImage = baseImage;
Assert.isNotNull(fBaseImage);
- fFlags= flags;
+ fFlags = flags;
Assert.isTrue(fFlags >= 0);
- fSize= size;
+ fSize = size;
Assert.isNotNull(fSize);
}
-
+
/**
- * Sets the descriptors adornments. Valid values are: <code>ABSTRACT</code>, <code>FINAL</code>,
- * <code>SYNCHRONIZED</code>, </code>STATIC<code>, </code>RUNNABLE<code>, </code>WARNING<code>,
- * </code>ERROR<code>, </code>OVERRIDDES<code>, <code>IMPLEMENTS</code>, <code>CONSTRUCTOR</code>,
- * or any combination of those.
+ * Sets the descriptors adornments. Valid values are: <code>ABSTRACT</code>,
+ * <code>FINAL</code>, <code>SYNCHRONIZED</code>, </code>STATIC<code>,
+ * </code>RUNNABLE<code>, </code>WARNING<code>, </code>ERROR<code>,
+ * </code>OVERRIDDES<code>, <code>IMPLEMENTS</code>,
+ * <code>CONSTRUCTOR</code>, or any combination of those.
*
- * @param adornments the image descritpors adornments
+ * @param adornments
+ * the image descritpors adornments
*/
public void setAdornments(int adornments) {
Assert.isTrue(adornments >= 0);
- fFlags= adornments;
+ fFlags = adornments;
}
/**
/**
* Sets the size of the image created by calling <code>createImage()</code>.
*
- * @param size the size of the image returned from calling <code>createImage()</code>
+ * @param size
+ * the size of the image returned from calling
+ * <code>createImage()</code>
* @see ImageDescriptor#createImage()
*/
public void setImageSize(Point size) {
Assert.isNotNull(size);
Assert.isTrue(size.x >= 0 && size.y >= 0);
- fSize= size;
+ fSize = size;
}
-
+
/**
- * Returns the size of the image created by calling <code>createImage()</code>.
+ * Returns the size of the image created by calling
+ * <code>createImage()</code>.
*
- * @return the size of the image created by calling <code>createImage()</code>
+ * @return the size of the image created by calling
+ * <code>createImage()</code>
* @see ImageDescriptor#createImage()
*/
public Point getImageSize() {
return new Point(fSize.x, fSize.y);
}
-
- /* (non-Javadoc)
- * Method declared in CompositeImageDescriptor
+
+ /*
+ * (non-Javadoc) Method declared in CompositeImageDescriptor
*/
protected Point getSize() {
return fSize;
}
-
- /* (non-Javadoc)
- * Method declared on Object.
+
+ /*
+ * (non-Javadoc) Method declared on Object.
*/
public boolean equals(Object object) {
- if (object == null || !JavaElementImageDescriptor.class.equals(object.getClass()))
+ if (object == null
+ || !JavaElementImageDescriptor.class.equals(object.getClass()))
return false;
-
- JavaElementImageDescriptor other= (JavaElementImageDescriptor)object;
- return (fBaseImage.equals(other.fBaseImage) && fFlags == other.fFlags && fSize.equals(other.fSize));
+
+ JavaElementImageDescriptor other = (JavaElementImageDescriptor) object;
+ return (fBaseImage.equals(other.fBaseImage) && fFlags == other.fFlags && fSize
+ .equals(other.fSize));
}
-
- /* (non-Javadoc)
- * Method declared on Object.
+
+ /*
+ * (non-Javadoc) Method declared on Object.
*/
public int hashCode() {
return fBaseImage.hashCode() | fFlags | fSize.hashCode();
}
-
- /* (non-Javadoc)
- * Method declared in CompositeImageDescriptor
+
+ /*
+ * (non-Javadoc) Method declared in CompositeImageDescriptor
*/
protected void drawCompositeImage(int width, int height) {
ImageData bg;
- if ((bg= fBaseImage.getImageData()) == null)
- bg= DEFAULT_IMAGE_DATA;
-
+ if ((bg = fBaseImage.getImageData()) == null)
+ bg = DEFAULT_IMAGE_DATA;
+
drawImage(bg, 0, 0);
drawTopRight();
drawBottomRight();
drawBottomLeft();
- }
-
- private void drawTopRight() {
- int x= getSize().x;
- ImageData data= null;
+ }
+
+ private void drawTopRight() {
+ int x = getSize().x;
+ ImageData data = null;
if ((fFlags & ABSTRACT) != 0) {
- data= PHPUiImages.DESC_OVR_ABSTRACT.getImageData();
- x-= data.width;
+ data = PHPUiImages.DESC_OVR_ABSTRACT.getImageData();
+ x -= data.width;
drawImage(data, x, 0);
}
if ((fFlags & CONSTRUCTOR) != 0) {
- data= PHPUiImages.DESC_OVR_CONSTRUCTOR.getImageData();
- x-= data.width;
+ data = PHPUiImages.DESC_OVR_CONSTRUCTOR.getImageData();
+ x -= data.width;
drawImage(data, x, 0);
}
if ((fFlags & FINAL) != 0) {
- data= PHPUiImages.DESC_OVR_FINAL.getImageData();
- x-= data.width;
+ data = PHPUiImages.DESC_OVR_FINAL.getImageData();
+ x -= data.width;
drawImage(data, x, 0);
}
if ((fFlags & STATIC) != 0) {
- data= PHPUiImages.DESC_OVR_STATIC.getImageData();
- x-= data.width;
+ data = PHPUiImages.DESC_OVR_STATIC.getImageData();
+ x -= data.width;
drawImage(data, x, 0);
}
- }
-
+ }
+
private void drawBottomRight() {
- Point size= getSize();
- int x= size.x;
- ImageData data= null;
+ Point size = getSize();
+ int x = size.x;
+ ImageData data = null;
if ((fFlags & OVERRIDES) != 0) {
- data= PHPUiImages.DESC_OVR_OVERRIDES.getImageData();
- x-= data.width;
+ data = PHPUiImages.DESC_OVR_OVERRIDES.getImageData();
+ x -= data.width;
drawImage(data, x, size.y - data.height);
}
if ((fFlags & IMPLEMENTS) != 0) {
- data= PHPUiImages.DESC_OVR_IMPLEMENTS.getImageData();
- x-= data.width;
+ data = PHPUiImages.DESC_OVR_IMPLEMENTS.getImageData();
+ x -= data.width;
drawImage(data, x, size.y - data.height);
- }
+ }
if ((fFlags & SYNCHRONIZED) != 0) {
- data= PHPUiImages.DESC_OVR_SYNCH.getImageData();
- x-= data.width;
+ data = PHPUiImages.DESC_OVR_SYNCH.getImageData();
+ x -= data.width;
drawImage(data, x, size.y - data.height);
}
if ((fFlags & RUNNABLE) != 0) {
- data= PHPUiImages.DESC_OVR_RUN.getImageData();
- x-= data.width;
+ data = PHPUiImages.DESC_OVR_RUN.getImageData();
+ x -= data.width;
drawImage(data, x, size.y - data.height);
}
- }
-
+ }
+
private void drawBottomLeft() {
- Point size= getSize();
- int x= 0;
- ImageData data= null;
+ Point size = getSize();
+ int x = 0;
+ ImageData data = null;
if ((fFlags & ERROR) != 0) {
- data= PHPUiImages.DESC_OVR_ERROR.getImageData();
+ data = PHPUiImages.DESC_OVR_ERROR.getImageData();
drawImage(data, x, size.y - data.height);
- x+= data.width;
+ x += data.width;
}
if ((fFlags & WARNING) != 0) {
- data= PHPUiImages.DESC_OVR_WARNING.getImageData();
+ data = PHPUiImages.DESC_OVR_WARNING.getImageData();
drawImage(data, x, size.y - data.height);
- x+= data.width;
+ x += data.width;
}
- }
+ }
}