Home » openjdk-7 » java » awt » font » [javadoc | source]

java.awt.font
abstract public class: GraphicAttribute [javadoc | source]

java.lang.Object
   java.awt.font.GraphicAttribute

Direct Known Subclasses:
    ShapeGraphicAttribute, ImageGraphicAttribute

This class is used with the CHAR_REPLACEMENT attribute.

The GraphicAttribute class represents a graphic embedded in text. Clients subclass this class to implement their own char replacement graphics. Clients wishing to embed shapes and images in text need not subclass this class. Instead, clients can use the ShapeGraphicAttribute and ImageGraphicAttribute classes.

Subclasses must ensure that their objects are immutable once they are constructed. Mutating a GraphicAttribute that is used in a TextLayout results in undefined behavior from the TextLayout.

Field Summary
public static final  int	TOP_ALIGNMENT	Aligns top of graphic to top of line.
public static final  int	BOTTOM_ALIGNMENT	Aligns bottom of graphic to bottom of line.
public static final  int	ROMAN_BASELINE	Aligns origin of graphic to roman baseline of line.
public static final  int	CENTER_BASELINE	Aligns origin of graphic to center baseline of line.
public static final  int	HANGING_BASELINE	Aligns origin of graphic to hanging baseline of line.

Constructor:

protected GraphicAttribute(int alignment) { if (alignment < BOTTOM_ALIGNMENT || alignment > HANGING_BASELINE) { throw new IllegalArgumentException("bad alignment"); } fAlignment = alignment; } Constructs a GraphicAttribute. Subclasses use this to define the alignment of the graphic. Parameters: alignment - an int representing one of the GraphicAttribute alignment fields Throws: IllegalArgumentException - if alignment is not one of the five defined values.

Method from java.awt.font.GraphicAttribute Summary:
draw,   getAdvance,   getAlignment,   getAscent,   getBounds,   getDescent,   getJustificationInfo,   getOutline

Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait

Method from java.awt.font.GraphicAttribute Detail:
abstract public void draw(Graphics2D graphics, float x, float y) Renders this GraphicAttribute at the specified location.
abstract public float getAdvance() Returns the advance of this GraphicAttribute. The GraphicAttribute object's advance is the distance from the point at which the graphic is rendered and the point where the next character or graphic is rendered. A graphic can be rendered beyond its advance
public final int getAlignment() { return fAlignment; } Returns the alignment of this GraphicAttribute. Alignment can be to a particular baseline, or to the absolute top or bottom of a line.
abstract public float getAscent() Returns the ascent of this GraphicAttribute. A graphic can be rendered above its ascent.
public Rectangle2D getBounds() { float ascent = getAscent(); return new Rectangle2D.Float(0, -ascent, getAdvance(), ascent+getDescent()); } Returns a Rectangle2D that encloses all of the bits drawn by this GraphicAttribute relative to the rendering position. A graphic may be rendered beyond its origin, ascent, descent, or advance; but if it is, this method's implementation must indicate where the graphic is rendered. Default bounds is the rectangle (0, -ascent, advance, ascent+descent).
abstract public float getDescent() Returns the descent of this GraphicAttribute. A graphic can be rendered below its descent.
public GlyphJustificationInfo getJustificationInfo() { // should we cache this? float advance = getAdvance(); return new GlyphJustificationInfo( advance, // weight false, // growAbsorb 2, // growPriority advance/3, // growLeftLimit advance/3, // growRightLimit false, // shrinkAbsorb 1, // shrinkPriority 0, // shrinkLeftLimit 0); // shrinkRightLimit } Returns the justification information for this GraphicAttribute. Subclasses can override this method to provide different justification information.
public Shape getOutline(AffineTransform tx) { Shape b = getBounds(); if (tx != null) { b = tx.createTransformedShape(b); } return b; } Return a java.awt.Shape that represents the region that this GraphicAttribute renders. This is used when a TextLayout is requested to return the outline of the text. The (untransformed) shape must not extend outside the rectangular bounds returned by getBounds. The default implementation returns the rectangle returned by #getBounds , transformed by the provided AffineTransform if present.