java.awt.font

Class ImageGraphicAttribute

java.lang.Object

java.awt.font.GraphicAttribute

java.awt.font.ImageGraphicAttribute

public final class ImageGraphicAttribute
extends GraphicAttribute

This is an implementation of GraphicAttribute which draws images in a TextLayout.

Field Summary

Fields inherited from class java.awt.font.GraphicAttribute

BOTTOM_ALIGNMENT, CENTER_BASELINE, HANGING_BASELINE, ROMAN_BASELINE, TOP_ALIGNMENT

Constructor Summary

Constructors

Constructor and Description
ImageGraphicAttribute(Image image, int alignment) Constucts an instance from the specified Image.
ImageGraphicAttribute(Image image, int alignment, float originX, float originY) Constucts an instance from the specified Image.

Method Summary

Methods

Modifier and Type	Method and Description
void	draw(Graphics2D g, float x, float y) Draws the image at the specified location, relative to the origin.
boolean	equals(ImageGraphicAttribute rhs) Compares this to the ImageGraphicAttribute given, by comparing all fields and values.
boolean	equals(Object obj) Compares this to the specified Object
float	getAdvance() Returns distance from the origin to the right edge of the image of this.
float	getAscent() Returns the the distance from the top of the image to the origin of this.
Rectangle2D	getBounds() Gets the bounds of the object rendered, relative to the position.
float	getDescent() Returns the distance from the origin to the bottom of the image.
int	hashCode() Gets the hash code for this image.

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 instance from the specified Image. The origin is at (0, 0).

Parameters:

image - - image to construct from.

alignment - - the alignment

ImageGraphicAttribute

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

Constucts an instance from the specified Image. The origin is at (originX, originY).

Parameters:

image - - image to construct from

alignment - - the alignment

originX - - x point of origin

originY - - y point of origin

Method Detail

draw

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

Draws the image at the specified location, relative to the origin.

Specified by:

draw in class GraphicAttribute

Parameters:

g - - the graphics to use to render the image

x - - the x location

y - - the y location

equals

public boolean equals(Object obj)

Compares this to the specified Object

Overrides:

equals in class Object

Parameters:

obj - - the object to compare

Returns:

true if the obj and this are equivalent

See Also:

Object.hashCode()

equals

public boolean equals(ImageGraphicAttribute rhs)

Compares this to the ImageGraphicAttribute given, by comparing all fields and values.

Parameters:

rhs - - the ImageGraphicAttribute to compare

Returns:

true if the object given is equivalent to this

getAdvance

public float getAdvance()

Returns distance from the origin to the right edge of the image of this.

Specified by:

getAdvance in class GraphicAttribute

Returns:

the advance

getAscent

public float getAscent()

Returns the the distance from the top of the image to the origin of this.

Specified by:

getAscent in class GraphicAttribute

Returns:

the ascent.

getBounds

public Rectangle2D getBounds()

Gets the bounds of the object rendered, relative to the position.

Overrides:

getBounds in class GraphicAttribute

Returns:

the bounds of the object rendered, relative to the position.

getDescent

public float getDescent()

Returns the distance from the origin to the bottom of the image.

Specified by:

getDescent in class GraphicAttribute

Returns:

the descent

hashCode

public int hashCode()

Gets the hash code for this image.

Overrides:

hashCode in class Object

Returns:

the hash code

See Also:

Object.equals(Object), System.identityHashCode(Object)