- java.lang.Object
-
- java.awt.font.GraphicAttribute
-
- java.awt.font.ImageGraphicAttribute
-
public final class ImageGraphicAttribute extends GraphicAttribute
TheImageGraphicAttribute
class is an implementation ofGraphicAttribute
which draws images in aTextLayout
.- See Also:
GraphicAttribute
-
-
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 anImageGraphicAttribute
from the specifiedImage
.ImageGraphicAttribute(Image image, int alignment, float originX, float originY)
Constructs anImageGraphicAttribute
from the specifiedImage
.
-
Method Summary
Methods Modifier and Type Method and Description void
draw(Graphics2D graphics, float x, float y)
Renders thisGraphicAttribute
at the specified location.boolean
equals(ImageGraphicAttribute rhs)
Compares thisImageGraphicAttribute
to the specifiedImageGraphicAttribute
.boolean
equals(Object rhs)
Compares thisImageGraphicAttribute
to the specifiedObject
.float
getAdvance()
Returns the advance of thisImageGraphicAttribute
.float
getAscent()
Returns the ascent of thisImageGraphicAttribute
.Rectangle2D
getBounds()
Returns aRectangle2D
that encloses all of the bits rendered by thisImageGraphicAttribute
, relative to the rendering position.float
getDescent()
Returns the descent of thisImageGraphicAttribute
.int
hashCode()
Returns a hashcode for thisImageGraphicAttribute
.-
Methods inherited from class java.awt.font.GraphicAttribute
getAlignment, getJustificationInfo, getOutline
-
-
-
-
Constructor Detail
-
ImageGraphicAttribute
public ImageGraphicAttribute(Image image, int alignment)
Constucts anImageGraphicAttribute
from the specifiedImage
. 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 anImageGraphicAttribute
from the specifiedImage
. The point (originX
,originY
) in theImage
appears at the origin of theImageGraphicAttribute
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 thisImageGraphicAttribute
. The ascent of anImageGraphicAttribute
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 thisImageGraphicAttribute
. The descent of anImageGraphicAttribute
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 thisImageGraphicAttribute
. The advance of anImageGraphicAttribute
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 aRectangle2D
that encloses all of the bits rendered by thisImageGraphicAttribute
, 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
.
-
draw
public void draw(Graphics2D graphics, float x, float y)
Renders thisGraphicAttribute
at the specified location.- Specified by:
draw
in classGraphicAttribute
- Parameters:
graphics
- theGraphics2D
into which to render the graphicx
- the user-space X coordinate where the graphic is renderedy
- the user-space Y coordinate where the graphic is rendered
-
hashCode
public int hashCode()
Returns a hashcode for thisImageGraphicAttribute
.- 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 thisImageGraphicAttribute
to the specifiedObject
.- 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 thisImageGraphicAttribute
to the specifiedImageGraphicAttribute
.- Parameters:
rhs
- theImageGraphicAttribute
to compare for equality- Returns:
true
if thisImageGraphicAttribute
equalsrhs
;false
otherwise.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/awt/font/imagegraphicattribute.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.