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
Field Summary
Fields declared in class java.awt.font.GraphicAttribute
BOTTOM_ALIGNMENT, CENTER_BASELINE, HANGING_BASELINE, ROMAN_BASELINE, TOP_ALIGNMENT
Constructor Summary
Constructor | Description |
---|---|
ImageGraphicAttribute(Image image,
int alignment) | Constructs an |
ImageGraphicAttribute(Image image,
int alignment,
float originX,
float originY) | Constructs an |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
boolean | equals(ImageGraphicAttribute rhs) | Compares this |
boolean | equals(Object rhs) | Compares this |
float | getAdvance() | Returns the advance of this |
float | getAscent() | Returns the ascent of this |
Rectangle2D | getBounds() | Returns a |
float | getDescent() | Returns the descent of this |
int | hashCode() | Returns a hashcode for this |
Methods declared in class java.awt.font.GraphicAttribute
draw, getAlignment, getJustificationInfo, getOutline
Methods declared in class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Constructor Detail
ImageGraphicAttribute
public ImageGraphicAttribute(Image image, int alignment)
Constructs an ImageGraphicAttribute
from the specified Image
. The origin is at (0, 0).
- Parameters:
-
image
- theImage
rendered by thisImageGraphicAttribute
. This object keeps a reference toimage
. -
alignment
- one of the alignments from thisImageGraphicAttribute
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
- theImage
rendered by thisImageGraphicAttribute
. This object keeps a reference toimage
. -
alignment
- one of the alignments from thisImageGraphicAttribute
-
originX
- the X coordinate of the point within theImage
that appears at the origin of theImageGraphicAttribute
in the text line. -
originY
- the Y coordinate of the point within theImage
that appears at the origin of theImageGraphicAttribute
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.
- Specified by:
-
getAscent
in classGraphicAttribute
- Returns:
- the ascent of this
ImageGraphicAttribute
. - See Also:
GraphicAttribute.getBounds()
getDescent
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.
- Specified by:
-
getDescent
in classGraphicAttribute
- Returns:
- the descent of this
ImageGraphicAttribute
. - See Also:
GraphicAttribute.getBounds()
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.
- Specified by:
-
getAdvance
in classGraphicAttribute
- Returns:
- the advance of this
ImageGraphicAttribute
. - See Also:
GraphicAttribute.getBounds()
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.
- Overrides:
-
getBounds
in classGraphicAttribute
- Returns:
- a
Rectangle2D
that encloses all of the bits rendered by thisImageGraphicAttribute
.
hashCode
public int hashCode()
Returns a hashcode for this ImageGraphicAttribute
.
- Overrides:
-
hashCode
in classObject
- Returns:
- a hash code value for this object.
- See Also:
-
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
equals
public boolean equals(Object rhs)
Compares this ImageGraphicAttribute
to the specified Object
.
- Overrides:
-
equals
in classObject
- Parameters:
-
rhs
- theObject
to compare for equality - Returns:
-
true
if thisImageGraphicAttribute
equalsrhs
;false
otherwise. - See Also:
-
Object.hashCode()
,HashMap
equals
public boolean equals(ImageGraphicAttribute rhs)
Compares this ImageGraphicAttribute
to the specified ImageGraphicAttribute
.
- Parameters:
-
rhs
- theImageGraphicAttribute
to compare for equality - Returns:
-
true
if thisImageGraphicAttribute
equalsrhs
;false
otherwise.