java.awt.font
Class ImageGraphicAttribute

java.lang.Object
  |
  +--java.awt.font.GraphicAttribute
        |
        +--java.awt.font.ImageGraphicAttribute

public final class ImageGraphicAttribute

extends GraphicAttribute

The ImageGraphicAttribute class is an implementation of GraphicAttribute which draws images in a TextLayout.

See Also:

GraphicAttribute

Fields inherited from class java.awt.font.GraphicAttribute

BOTTOM_ALIGNMENT, CENTER_BASELINE, HANGING_BASELINE, ROMAN_BASELINE, TOP_ALIGNMENT

Constructor Summary

ImageGraphicAttribute(Image image, int alignment)
Constucts an ImageGraphicAttribute from the specified Image.

ImageGraphicAttribute(Image image, int alignment, float originX, float originY)
Constructs an ImageGraphicAttribute from the specified Image.

Method Summary

void	draw(Graphics2D graphics, float x, float y) Renders the graphic at the specified location.
boolean	equals(ImageGraphicAttribute rhs) Compares this ImageGraphicAttribute to the specified ImageGraphicAttribute.
boolean	equals(Object rhs) Compares this ImageGraphicAttribute to the specified Object.
float	getAdvance() Returns the advance of this ImageGraphicAttribute.
float	getAscent() Returns the ascent of this ImageGraphicAttribute.
Rectangle2D	getBounds() Returns a Rectangle2D that encloses all of the bits rendered by this ImageGraphicAttribute, relative to the rendering position.
float	getDescent() Returns the descent of this ImageGraphicAttribute
int	hashCode() Returns a hashcode for this ImageGraphicAttribute.

Methods inherited from class java.awt.font.GraphicAttribute

getAlignment, getJustificationInfo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImageGraphicAttribute

public ImageGraphicAttribute(Image image,
                             int alignment)

Constucts an ImageGraphicAttribute from the specified Image. The origin is at (0, 0).

Parameters:

image - the Image rendered by this ImageGraphicAttribute. This object keeps a reference to image.

alignment - one of the alignments from this ImageGraphicAttribute

ImageGraphicAttribute

public ImageGraphicAttribute(Image image,
                             int alignment,
                             float originX,
                             float originY)

Constructs an ImageGraphicAttribute from the specified Image. The point (originX, originY) in the Image appears at the origin of the ImageGraphicAttribute within the text.

Parameters:

image - the Image rendered by this ImageGraphicAttribute. This object keeps a reference to image.

alignment - one of the alignments from this ImageGraphicAttribute

originX, originY - the coordinates of the point within the Image that appears at the origin of the ImageGraphicAttribute in the text line.

Method Detail

getAscent

public float getAscent()

Returns the ascent of this ImageGraphicAttribute. The ascent of an ImageGraphicAttribute is the distance from the top of the image to the origin.

Returns:

the ascent of this ImageGraphicAttribute.

Overrides:

getAscent in class GraphicAttribute

getDescent

public float getDescent()

Returns the descent of this ImageGraphicAttributeImageGraphicAttribute is the distance from the origin to the bottom of the image.

Returns:

the descent of this ImageGraphicAttribute.

Overrides:

getDescent in class GraphicAttribute

getAdvance

public float getAdvance()

Returns the advance of this ImageGraphicAttribute. The advance of an ImageGraphicAttribute is the distance from the origin to the right edge of the image.

Returns:

the advance of this ImageGraphicAttribute.

Overrides:

getAdvance in class GraphicAttribute

getBounds

public Rectangle2D getBounds()

Returns a Rectangle2D that encloses all of the bits rendered by this 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.

Returns:

a Rectangle2D that encloses all of the bits rendered by this ImageGraphicAttribute.

Overrides:

getBounds in class GraphicAttribute

draw

public void draw(Graphics2D graphics,
                 float x,
                 float y)

Renders the graphic at the specified location.

Parameters:

graphics - the Graphics2D into which to render the graphic

x - the user-space coordinates where the graphic is rendered

Overrides:

draw in class GraphicAttribute

hashCode

public int hashCode()

Returns a hashcode for this ImageGraphicAttribute.

Returns:

a hash code value for this object.

Overrides:

hashCode in class Object

equals

public boolean equals(Object rhs)

Compares this ImageGraphicAttribute to the specified Object.

Parameters:

rhs - the Object to compare for equality

Returns:

true if this ImageGraphicAttribute equals rhs; false otherwise.

Overrides:

equals in class Object

equals

public boolean equals(ImageGraphicAttribute rhs)

Compares this ImageGraphicAttribute to the specified ImageGraphicAttribute.

Parameters:

rhs - the ImageGraphicAttribute to compare for equality

Returns:

true if this ImageGraphicAttribute equals rhs; false otherwise.