java.awt.font

Class 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

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

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

draw, getAdvance, getAlignment, getAscent, getBounds, getDescent, getJustificationInfo

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

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 Details

draw

public void draw(Graphics2D g,
                 float x,
                 float y)
Draws the image at the specified location, relative to the origin.
Overrides:
draw in interface GraphicAttribute
Parameters:
g - - the graphics to use to render the image
x - - the x location
y - - the y location

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

equals

public boolean equals(Object obj)
Compares this to the specified Object
Overrides:
equals in interface Object
Parameters:
obj - - the object to compare
Returns:
true if the obj and this are equivalent

getAdvance

public float getAdvance()
Returns distance from the origin to the right edge of the image of this.
Overrides:
getAdvance in interface GraphicAttribute
Returns:
the advance

getAscent

public float getAscent()
Returns the the distance from the top of the image to the origin of this.
Overrides:
getAscent in interface GraphicAttribute
Returns:
the ascent.

getBounds

public Rectangle2D getBounds()
Gets the bounds of the object rendered, relative to the position.
Overrides:
getBounds in interface 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.
Overrides:
getDescent in interface GraphicAttribute
Returns:
the descent

hashCode

public int hashCode()
Gets the hash code for this image.
Overrides:
hashCode in interface Object
Returns:
the hash code

ImageGraphicAttribute.java Copyright (C) 2003 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.