Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Java Platform 1.2
Beta 4

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Class java.awt.font.ShapeGraphicAttribute

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

public final class ShapeGraphicAttribute

extends GraphicAttribute

This is an implementation of GraphicAttribute which 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)
Construct a ShapeGraphicAttribute for the specified Shape.

Method Summary

void	draw(Graphics2D graphics, float x, float y) Draw the graphic at the given location.
boolean	equals(Object rhs) Compares this object to the specified object.
boolean	equals(ShapeGraphicAttribute rhs) Compares this object to the specified ShapeGraphicAttribute.
float	getAdvance() Return the advance of this graphic.
float	getAscent() Return the ascent of this graphic.
Rectangle2D	getBounds() Returns a rectangle which encloses all of the bits drawn by this graphic (relative to the drawing position, of course).
float	getDescent() Return the descent of this graphic.
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)

Construct a ShapeGraphicAttribute for the specified Shape.

Parameters:

shape - the Shape to draw. The Shape will be drawn with its origin at the origin of this ShapeGraphicAttribute in the host TextLayout. object maintains a reference to shape.

alignment - the alignment (one of the alignments from GraphicAttribute).

stroke - true if the Shape should be drawn with strokes; false to fill the Shape.

Method Detail

getAscent

public float getAscent()

Return the ascent of this graphic. The ascent of a ShapeGraphicAttribute is the (positive) distance from the origin of its Shape to the top of its Shape's bounds.

Returns:

the ascent of this graphic

Overrides:

getAscent in class GraphicAttribute

getDescent

public float getDescent()

Return the descent of this graphic. The descent of a ShapeGraphicAttribute is the distance from the origin of its Shape to the bottom of the Shape's bounds.

Returns:

the descent of this graphic

Overrides:

getDescent in class GraphicAttribute

getAdvance

public float getAdvance()

Return the advance of this graphic. The advance of a ShapeGraphicAttribute is the distance from the origin of its Shape to the right side of its Shape's bounds.

Returns:

the advance of this graphic

Overrides:

getAdvance in class GraphicAttribute

draw

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

Draw 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 - the x-coordinate (in user space) where the graphic is drawn

y - the y-coordinate (in user space) where the graphic is drawn

Overrides:

draw in class GraphicAttribute

getBounds

public Rectangle2D getBounds()

Returns a rectangle which encloses all of the bits drawn by this graphic (relative to the drawing position, of course). A graphic may draw beyond its origin, ascent, descent, or advance; but if it does, this method's implementation should indicate where the graphic draws.

Returns:

a Rectangle2D which encloses all of the bits drawn by this graphic.

Overrides:

getBounds in class GraphicAttribute

hashCode

public int hashCode()

Returns a hashcode for this ShapeGraphicAttribute.

Returns:

a hash code value for this object

Overrides:

hashCode in class Object

equals

public boolean equals(Object rhs)

Compares this object to the specified object.

Parameters:

rhs - the object to compare for equality

Returns:

true if this equals rhs

Overrides:

equals in class Object

equals

public boolean equals(ShapeGraphicAttribute rhs)

Compares this object to the specified ShapeGraphicAttribute.

Parameters:

rhs - the ShapeGraphicAttribute to compare for equality

Returns:

true if this equals rhs