< prev index next >
src/java.desktop/share/classes/java/awt/font/ImageGraphicAttribute.java
Print this page
@@ -43,11 +43,11 @@
import java.awt.Image;
import java.awt.Graphics2D;
import java.awt.geom.Rectangle2D;
/**
- * The <code>ImageGraphicAttribute</code> class is an implementation of
+ * The {@code ImageGraphicAttribute} class is an implementation of
* {@link GraphicAttribute} which draws images in
* a {@link TextLayout}.
* @see GraphicAttribute
*/
@@ -56,40 +56,40 @@
private Image fImage;
private float fImageWidth, fImageHeight;
private float fOriginX, fOriginY;
/**
- * Constructs an <code>ImageGraphicAttribute</code> from the specified
+ * Constructs an {@code ImageGraphicAttribute} from the specified
* {@link Image}. The origin is at (0, 0).
- * @param image the <code>Image</code> rendered by this
- * <code>ImageGraphicAttribute</code>.
- * This object keeps a reference to <code>image</code>.
+ * @param image the {@code Image} rendered by this
+ * {@code ImageGraphicAttribute}.
+ * This object keeps a reference to {@code image}.
* @param alignment one of the alignments from this
- * <code>ImageGraphicAttribute</code>
+ * {@code ImageGraphicAttribute}
*/
public ImageGraphicAttribute(Image image, int alignment) {
this(image, alignment, 0, 0);
}
/**
- * Constructs an <code>ImageGraphicAttribute</code> from the specified
- * <code>Image</code>. The point
- * (<code>originX</code>, <code>originY</code>) in the
- * <code>Image</code> appears at the origin of the
- * <code>ImageGraphicAttribute</code> within the text.
- * @param image the <code>Image</code> rendered by this
- * <code>ImageGraphicAttribute</code>.
- * This object keeps a reference to <code>image</code>.
+ * Constructs an {@code ImageGraphicAttribute} from the specified
+ * {@code Image}. The point
+ * ({@code originX}, {@code originY}) in the
+ * {@code Image} appears at the origin of the
+ * {@code ImageGraphicAttribute} within the text.
+ * @param image the {@code Image} rendered by this
+ * {@code ImageGraphicAttribute}.
+ * This object keeps a reference to {@code image}.
* @param alignment one of the alignments from this
- * <code>ImageGraphicAttribute</code>
+ * {@code ImageGraphicAttribute}
* @param originX the X coordinate of the point within
- * the <code>Image</code> that appears at the origin of the
- * <code>ImageGraphicAttribute</code> in the text line.
+ * the {@code Image} that appears at the origin of the
+ * {@code ImageGraphicAttribute} in the text line.
* @param originY the Y coordinate of the point within
- * the <code>Image</code> that appears at the origin of the
- * <code>ImageGraphicAttribute</code> in the text line.
+ * the {@code Image} that appears at the origin of the
+ * {@code ImageGraphicAttribute} in the text line.
*/
public ImageGraphicAttribute(Image image,
int alignment,
float originX,
float originY) {
@@ -107,50 +107,50 @@
fOriginX = originX;
fOriginY = originY;
}
/**
- * Returns the ascent of this <code>ImageGraphicAttribute</code>. The
- * ascent of an <code>ImageGraphicAttribute</code> is the distance
+ * Returns the ascent of this {@code ImageGraphicAttribute}. The
+ * ascent of an {@code ImageGraphicAttribute} is the distance
* from the top of the image to the origin.
- * @return the ascent of this <code>ImageGraphicAttribute</code>.
+ * @return the ascent of this {@code ImageGraphicAttribute}.
*/
public float getAscent() {
return Math.max(0, fOriginY);
}
/**
- * Returns the descent of this <code>ImageGraphicAttribute</code>.
- * The descent of an <code>ImageGraphicAttribute</code> is the
+ * Returns the descent of this {@code ImageGraphicAttribute}.
+ * The descent of an {@code ImageGraphicAttribute} is the
* distance from the origin to the bottom of the image.
- * @return the descent of this <code>ImageGraphicAttribute</code>.
+ * @return the descent of this {@code ImageGraphicAttribute}.
*/
public float getDescent() {
return Math.max(0, fImageHeight-fOriginY);
}
/**
- * Returns the advance of this <code>ImageGraphicAttribute</code>.
- * The advance of an <code>ImageGraphicAttribute</code> is the
+ * Returns the advance of this {@code ImageGraphicAttribute}.
+ * The advance of an {@code ImageGraphicAttribute} is the
* distance from the origin to the right edge of the image.
- * @return the advance of this <code>ImageGraphicAttribute</code>.
+ * @return the advance of this {@code ImageGraphicAttribute}.
*/
public float getAdvance() {
return Math.max(0, fImageWidth-fOriginX);
}
/**
* Returns a {@link Rectangle2D} that encloses all of the
- * bits rendered by this <code>ImageGraphicAttribute</code>, relative
+ * bits rendered by this {@code ImageGraphicAttribute}, relative
* to the rendering position. A graphic can be rendered beyond its
* origin, ascent, descent, or advance; but if it is, this
* method's implementation must indicate where the graphic is rendered.
- * @return a <code>Rectangle2D</code> that encloses all of the bits
- * rendered by this <code>ImageGraphicAttribute</code>.
+ * @return a {@code Rectangle2D} that encloses all of the bits
+ * rendered by this {@code ImageGraphicAttribute}.
*/
public Rectangle2D getBounds() {
return new Rectangle2D.Float(
-fOriginX, -fOriginY, fImageWidth, fImageHeight);
@@ -163,25 +163,25 @@
graphics.drawImage(fImage, (int) (x-fOriginX), (int) (y-fOriginY), null);
}
/**
- * Returns a hashcode for this <code>ImageGraphicAttribute</code>.
+ * Returns a hashcode for this {@code ImageGraphicAttribute}.
* @return a hash code value for this object.
*/
public int hashCode() {
return fImage.hashCode();
}
/**
- * Compares this <code>ImageGraphicAttribute</code> to the specified
+ * Compares this {@code ImageGraphicAttribute} to the specified
* {@link Object}.
- * @param rhs the <code>Object</code> to compare for equality
- * @return <code>true</code> if this
- * <code>ImageGraphicAttribute</code> equals <code>rhs</code>;
- * <code>false</code> otherwise.
+ * @param rhs the {@code Object} to compare for equality
+ * @return {@code true} if this
+ * {@code ImageGraphicAttribute} equals {@code rhs};
+ * {@code false} otherwise.
*/
public boolean equals(Object rhs) {
try {
return equals((ImageGraphicAttribute) rhs);
@@ -190,17 +190,17 @@
return false;
}
}
/**
- * Compares this <code>ImageGraphicAttribute</code> to the specified
- * <code>ImageGraphicAttribute</code>.
- * @param rhs the <code>ImageGraphicAttribute</code> to compare for
+ * Compares this {@code ImageGraphicAttribute} to the specified
+ * {@code ImageGraphicAttribute}.
+ * @param rhs the {@code ImageGraphicAttribute} to compare for
* equality
- * @return <code>true</code> if this
- * <code>ImageGraphicAttribute</code> equals <code>rhs</code>;
- * <code>false</code> otherwise.
+ * @return {@code true} if this
+ * {@code ImageGraphicAttribute} equals {@code rhs};
+ * {@code false} otherwise.
*/
public boolean equals(ImageGraphicAttribute rhs) {
if (rhs == null) {
return false;
< prev index next >