java.awt.font
Class ShapeGraphicAttribute

java.lang.Object
  |
  +--java.awt.font.GraphicAttribute
        |
        +--java.awt.font.ShapeGraphicAttribute

public final class ShapeGraphicAttribute

extends GraphicAttribute

The ShapeGraphicAttribute class is an implementation of GraphicAttribute that draws shapes in a TextLayout.

See Also:

GraphicAttribute

Field Summary

static boolean	FILL A key indicating the shape should be filled.
static boolean	STROKE A key indicating the shape should be stroked with a 1-pixel wide stroke.

Fields inherited from class java.awt.font.GraphicAttribute

BOTTOM_ALIGNMENT, CENTER_BASELINE, HANGING_BASELINE, ROMAN_BASELINE, TOP_ALIGNMENT

Constructor Summary

ShapeGraphicAttribute(Shape shape, int alignment, boolean stroke)
Constructs a ShapeGraphicAttribute for the specified Shape.

Method Summary

void	draw(Graphics2D graphics, float x, float y) Draws the graphic at the given location.
boolean	equals(Object rhs) Compares this ShapeGraphicAttribute to the specified Object.
boolean	equals(ShapeGraphicAttribute rhs) Compares this ShapeGraphicAttribute to the specified ShapeGraphicAttribute.
float	getAdvance() Returns the advance of this ShapeGraphicAttribute.
float	getAscent() Returns the ascent of this ShapeGraphicAttribute.
Rectangle2D	getBounds() Returns a Rectangle2D that encloses all of the bits drawn by this ShapeGraphicAttribute relative to the rendering position.
float	getDescent() Returns the descent of this ShapeGraphicAttribute.
int	hashCode() Returns a hashcode for this ShapeGraphicAttribute.

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

Field Detail

STROKE

public static final boolean STROKE

A key indicating the shape should be stroked with a 1-pixel wide stroke.

FILL

public static final boolean FILL

A key indicating the shape should be filled.

Constructor Detail

ShapeGraphicAttribute

public ShapeGraphicAttribute(Shape shape,
                             int alignment,
                             boolean stroke)

Constructs a ShapeGraphicAttribute for the specified Shape.

Parameters:

shape - the Shape to render. The Shape is rendered with its origin at the origin of this ShapeGraphicAttribute in the host TextLayout. This object maintains a reference to shape.

alignment - one of the alignments from this ShapeGraphicAttribute.

stroke - true if the Shape should be stroked; false if the Shape should be filled.

Method Detail

getAscent

public float getAscent()

Returns the ascent of this ShapeGraphicAttribute. The ascent of a ShapeGraphicAttribute is the positive distance from the origin of its Shape to the top of bounds of its Shape.

Returns:

the ascent of this ShapeGraphicAttribute.

Overrides:

getAscent in class GraphicAttribute

getDescent

public float getDescent()

Returns the descent of this ShapeGraphicAttribute. The descent of a ShapeGraphicAttribute is the distance from the origin of its Shape to the bottom of the bounds of its Shape.

Returns:

the descent of this ShapeGraphicAttribute.

Overrides:

getDescent in class GraphicAttribute

getAdvance

public float getAdvance()

Returns the advance of this ShapeGraphicAttribute. The advance of a ShapeGraphicAttribute is the distance from the origin of its Shape to the right side of the bounds of its Shape.

Returns:

the advance of this ShapeGraphicAttribute.

Overrides:

getAdvance in class GraphicAttribute

draw

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

Draws the graphic at the given location. The Shape is drawn with its origin at (x, y).

Parameters:

graphics - the Graphics2D into which to draw the graphic

x, y - the user space coordinates where the graphic is drawn

Overrides:

draw in class GraphicAttribute

getBounds

public Rectangle2D getBounds()

Returns a Rectangle2D that encloses all of the bits drawn by this ShapeGraphicAttribute relative to the rendering position. A graphic can be rendered beyond its origin, ascent, descent, or advance; but if it does, this method's implementation should indicate where the graphic is rendered.

Returns:

a Rectangle2D that encloses all of the bits rendered by this ShapeGraphicAttribute.

Overrides:

getBounds in class GraphicAttribute

hashCode

public int hashCode()

Returns a hashcode for this ShapeGraphicAttribute.

Returns:

a hash code value for this ShapeGraphicAttribute.

Overrides:

hashCode in class Object

equals

public boolean equals(Object rhs)

Compares this ShapeGraphicAttribute to the specified Object.

Parameters:

rhs - the Object to compare for equality

Returns:

true if this ShapeGraphicAttribute equals rhs; false otherwise.

Overrides:

equals in class Object

equals

public boolean equals(ShapeGraphicAttribute rhs)

Compares this ShapeGraphicAttribute to the specified ShapeGraphicAttribute.

Parameters:

rhs - the ShapeGraphicAttribute to compare for equality

Returns:

true if this ShapeGraphicAttribute equals rhs; false otherwise.