Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| JavaTM 2 Platform Std. Ed. v1.3.1
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## java.awt.font
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`

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 `ImageGraphicAttribute` from the specified `Image`.
`ImageGraphicAttribute(Image image, int alignment, float originX, float originY)` Constructs an `ImageGraphicAttribute` from the specified `Image`.

Method Summary
`void` | `draw(Graphics2D graphics, float x, float y)` Renders the graphic at the specified location.
`boolean` | `equals(ImageGraphicAttribute rhs)` Compares this `ImageGraphicAttribute` to the specified `ImageGraphicAttribute`.
`boolean` | `equals(Object rhs)` Compares this `ImageGraphicAttribute` to the specified `Object`.
`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`.

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 `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`

### 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, originY` - the coordinates of the point within the `Image` that appears at the origin of the `ImageGraphicAttribute` 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.
  Overrides:
    `getAscent` in class `GraphicAttribute`
  Returns:
    the ascent of this `ImageGraphicAttribute`.

### getDescent

    public float getDescent()

  Returns the descent of this `ImageGraphicAttributeImageGraphicAttribute` is the distance from the origin to the bottom of the image.
  Overrides:
    `getDescent` in class `GraphicAttribute`
  Returns:
    the descent of this `ImageGraphicAttribute`.

### 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.
  Overrides:
    `getAdvance` in class `GraphicAttribute`
  Returns:
    the advance of this `ImageGraphicAttribute`.

### 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 class `GraphicAttribute`
  Returns:
    a `Rectangle2D` that encloses all of the bits rendered by this `ImageGraphicAttribute`.

### draw

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

  Renders the graphic at the specified location.
  Overrides:
    `draw` in class `GraphicAttribute`
  Parameters:
    `graphics` - the `Graphics2D` into which to render the graphic
    `x` - the user-space coordinates where the graphic is rendered

### hashCode

    public int hashCode()

  Returns a hashcode for this `ImageGraphicAttribute`.
  Overrides:
    `hashCode` in class `Object`
  Returns:
    a hash code value for this object.

### equals

    public boolean equals(Object rhs)

  Compares this `ImageGraphicAttribute` to the specified `Object`.
  Overrides:
    `equals` in class `Object`
  Parameters:
    `rhs` - the `Object` to compare for equality
  Returns:
    `true` if this `ImageGraphicAttribute` equals `rhs`; `false` otherwise.

### equals

    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.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| JavaTM 2 Platform Std. Ed. v1.3.1
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Java, Java 2D, and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2001 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.