public final class

ImageGraphicAttribute

extends GraphicAttribute
java.lang.Object
   ↳ java.awt.font.GraphicAttribute
     ↳ java.awt.font.ImageGraphicAttribute

Class Overview

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

See Also

Summary

[Expand]
Inherited Constants
From class java.awt.font.GraphicAttribute
Public Constructors
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.
Public Methods
void draw(Graphics2D graphics, float x, float y)
Renders this GraphicAttribute at the specified location.
boolean equals(Object rhs)
Compares this ImageGraphicAttribute to the specified Object.
boolean equals(ImageGraphicAttribute rhs)
Compares this ImageGraphicAttribute to the specified ImageGraphicAttribute.
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.
[Expand]
Inherited Methods
From class java.awt.font.GraphicAttribute
From class java.lang.Object

Public Constructors

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

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 the X coordinate of the point within the Image that appears at the origin of the ImageGraphicAttribute in the text line.
originY the Y coordinate of the point within the Image that appears at the origin of the ImageGraphicAttribute in the text line.

Public Methods

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

Renders this GraphicAttribute at the specified location.

Parameters
graphics the Graphics2D into which to render the graphic
x the user-space X coordinate where the graphic is rendered
y the user-space Y coordinate where the graphic is rendered

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.

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.

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.

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.

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.

public float getDescent ()

Returns the descent of this ImageGraphicAttribute. The descent of an ImageGraphicAttribute is the distance from the origin to the bottom of the image.

Returns
  • the descent of this ImageGraphicAttribute.

public int hashCode ()

Returns a hashcode for this ImageGraphicAttribute.

Returns
  • a hash code value for this object.