org.apache.batik.gvt.text
Class GlyphLayout

java.lang.Object
  extended by org.apache.batik.gvt.text.GlyphLayout
All Implemented Interfaces:
TextSpanLayout
Direct Known Subclasses:
FlowExtGlyphLayout, FlowGlyphLayout

public class GlyphLayout
extends Object
implements TextSpanLayout

Implementation of TextSpanLayout which uses java.awt.font.GlyphVector.

See Also:
TextSpanLayout

Field Summary
static double eps
           
static AttributedCharacterIterator.Attribute FLOW_EMPTY_PARAGRAPH
           
static AttributedCharacterIterator.Attribute FLOW_LINE_BREAK
           
static AttributedCharacterIterator.Attribute FLOW_PARAGRAPH
           
static AttributedCharacterIterator.Attribute GVT_FONT
           
static AttributedCharacterIterator.Attribute HORIZONTAL_ORIENTATION_ANGLE
           
static AttributedCharacterIterator.Attribute LINE_HEIGHT
           
protected static Set runAtts
           
protected static Set szAtts
           
static AttributedCharacterIterator.Attribute VERTICAL_ORIENTATION
           
static AttributedCharacterIterator.Attribute VERTICAL_ORIENTATION_ANGLE
           
 
Fields inherited from interface org.apache.batik.gvt.text.TextSpanLayout
DECORATION_ALL, DECORATION_OVERLINE, DECORATION_STRIKETHROUGH, DECORATION_UNDERLINE
 
Constructor Summary
GlyphLayout(AttributedCharacterIterator aci, int[] charMap, Point2D offset, FontRenderContext frc)
          Creates the specified text layout using the specified AttributedCharacterIterator and rendering context.
 
Method Summary
static void addPtsToPath(GeneralPath shape, Point2D.Float[] topPts, Point2D.Float[] botPts, int numPts)
           
protected  void adjustTextSpacing()
          Does any spacing adjustments that may have been specified.
protected  void applyStretchTransform(boolean stretchGlyphs)
          Stretches the text so that it becomes the specified length.
protected  void doExplicitGlyphLayout()
          Explicitly lays out each of the glyphs in the glyph vector.
protected  void doPathLayout()
          If this layout is on a text path, positions the characters along the path.
protected  Point2D doSpacing(Float kern, Float letterSpacing, Float wordSpacing)
          Performs any spacing adjustments required and returns the new advance value.
 void draw(Graphics2D g2d)
          Paints the text layout using the specified Graphics2D and rendering context.
static boolean epsEQ(double a, double b)
           
 Point2D getAdvance2D()
          Returns the current text position at the completion of glyph layout.
 Rectangle2D getBounds2D()
          Returns the rectangular bounds of the completed glyph layout.
 int getCharacterCount(int startGlyphIndex, int endGlyphIndex)
          Returns the number of chars represented by the glyphs within the specified range.
 double getComputedOrientationAngle(int index)
          Return the angle value according to the orientation of the character.
 Shape getDecorationOutline(int decorationType)
          Returns the outline of the specified decorations on the glyphs,
protected  GVTFont getFont()
          Returns the GVTFont to use when rendering the specified character iterator.
 Rectangle2D getGeometricBounds()
          Returns the rectangular bounds of the completed glyph layout, inclusive of "decoration" (underline, overline, etc.)
 float[] getGlyphAdvances()
          Returns the advance between each glyph in text progression direction.
 int getGlyphCount()
          Returns the number of glyphs in this layout.
 int getGlyphIndex(int charIndex)
          Returns the index of the first glyph that has the specified char index.
 GVTGlyphMetrics getGlyphMetrics(int glyphIndex)
          Returns the Metrics for a particular glyph.
protected  int getGlyphOrientationAngle()
          Returns the value of the vertical glyph orientation angle.
 GVTGlyphVector getGlyphVector()
          Return the glyph vector asociated to this layout.
 Shape getHighlightShape(int beginCharIndex, int endCharIndex)
          Returns a Shape which encloses the currently selected glyphs as specified by the character indices.
 int getLastGlyphIndex(int charIndex)
          Returns the index of the last glyph that has the specified char index.
 GVTLineMetrics getLineMetrics()
          Returns the Line metrics for this text span.
 Point2D getOffset()
          Returns the current text position at the beginning of glyph layout, before the application of explicit glyph positioning attributes.
 Shape getOutline()
          Returns the outline of the completed glyph layout.
protected  Shape getOverlineShape()
          Returns a shape describing the overline decoration for a given ACI.
protected  Shape getStrikethroughShape()
          Returns a shape describing the strikethrough line for a given ACI.
 Point2D getTextPathAdvance()
          Returns the position to used when drawing a text run after this one.
protected  Shape getUnderlineShape()
          Returns a shape describing the undeline decoration for a given ACI.
 boolean hasCharacterIndex(int index)
          Return true is the character index is represented by glyphs in this layout.
 TextHit hitTestChar(float x, float y)
          Perform hit testing for coordinate at x, y.
 boolean isAltGlyph()
          Return true if this text run represents an alt glyph.
protected  boolean isGlyphOrientationAuto()
          Returns whether or not the vertical glyph orientation value is "auto".
protected  boolean isLatinChar(char c)
          Returns true if the specified character is within one of the Latin unicode character blocks.
 boolean isLeftToRight()
          Returns true if the text direction in this layout is from left to right.
 boolean isOnATextPath()
          Returns true if this layout in on a text path.
 boolean isVertical()
          Returns true if the advance direction of this text is vertical.
static int makeConvexHull(Point2D.Float[] pts, int numPts)
           
static void mergeAreas(GeneralPath shape, Area[] shapes, int nShapes)
           
 void setOffset(Point2D offset)
          Sets the text position used for the implicit origin of glyph layout.
 void setScale(float xScale, float yScale, boolean adjSpacing)
          Sets the scaling factor to use for string.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

FLOW_LINE_BREAK

public static final AttributedCharacterIterator.Attribute FLOW_LINE_BREAK

FLOW_PARAGRAPH

public static final AttributedCharacterIterator.Attribute FLOW_PARAGRAPH

FLOW_EMPTY_PARAGRAPH

public static final AttributedCharacterIterator.Attribute FLOW_EMPTY_PARAGRAPH

LINE_HEIGHT

public static final AttributedCharacterIterator.Attribute LINE_HEIGHT

VERTICAL_ORIENTATION

public static final AttributedCharacterIterator.Attribute VERTICAL_ORIENTATION

VERTICAL_ORIENTATION_ANGLE

public static final AttributedCharacterIterator.Attribute VERTICAL_ORIENTATION_ANGLE

HORIZONTAL_ORIENTATION_ANGLE

public static final AttributedCharacterIterator.Attribute HORIZONTAL_ORIENTATION_ANGLE

GVT_FONT

public static final AttributedCharacterIterator.Attribute GVT_FONT

runAtts

protected static Set runAtts

szAtts

protected static Set szAtts

eps

public static final double eps
See Also:
Constant Field Values
Constructor Detail

GlyphLayout

public GlyphLayout(AttributedCharacterIterator aci,
                   int[] charMap,
                   Point2D offset,
                   FontRenderContext frc)
Creates the specified text layout using the specified AttributedCharacterIterator and rendering context.

Parameters:
aci - the AttributedCharacterIterator whose text is to be laid out
charMap - Indicates how chars in aci map to original text char array.
offset - The offset position of this text layout
frc - the FontRenderContext to use for generating glyphs.
Method Detail

getGlyphVector

public GVTGlyphVector getGlyphVector()
Description copied from interface: TextSpanLayout
Return the glyph vector asociated to this layout.

Specified by:
getGlyphVector in interface TextSpanLayout
Returns:
glyph vector

getOffset

public Point2D getOffset()
Returns the current text position at the beginning of glyph layout, before the application of explicit glyph positioning attributes.

Specified by:
getOffset in interface TextSpanLayout

setScale

public void setScale(float xScale,
                     float yScale,
                     boolean adjSpacing)
Sets the scaling factor to use for string. if ajdSpacing is true then only the spacing between glyphs will be adjusted otherwise the glyphs and the spaces between them will be adjusted. Only the scale factor in the progression direction is used (x for horizontal text, y for vertical text ).

Specified by:
setScale in interface TextSpanLayout
Parameters:
xScale - Scale factor to apply in X direction.
yScale - Scale factor to apply in Y direction.
adjSpacing - True if only spaces should be adjusted.

setOffset

public void setOffset(Point2D offset)
Sets the text position used for the implicit origin of glyph layout. Ignored if multiple explicit glyph positioning attributes are present in ACI (e.g. if the aci has multiple X or Y values).

Specified by:
setOffset in interface TextSpanLayout

getGlyphMetrics

public GVTGlyphMetrics getGlyphMetrics(int glyphIndex)
Description copied from interface: TextSpanLayout
Returns the Metrics for a particular glyph.

Specified by:
getGlyphMetrics in interface TextSpanLayout

getLineMetrics

public GVTLineMetrics getLineMetrics()
Description copied from interface: TextSpanLayout
Returns the Line metrics for this text span.

Specified by:
getLineMetrics in interface TextSpanLayout

isVertical

public boolean isVertical()
Returns true if the advance direction of this text is vertical.

Specified by:
isVertical in interface TextSpanLayout

isOnATextPath

public boolean isOnATextPath()
Returns true if this layout in on a text path.

Specified by:
isOnATextPath in interface TextSpanLayout

getGlyphCount

public int getGlyphCount()
Returns the number of glyphs in this layout.

Specified by:
getGlyphCount in interface TextSpanLayout

getCharacterCount

public int getCharacterCount(int startGlyphIndex,
                             int endGlyphIndex)
Returns the number of chars represented by the glyphs within the specified range.

Specified by:
getCharacterCount in interface TextSpanLayout
Parameters:
startGlyphIndex - The index of the first glyph in the range.
endGlyphIndex - The index of the last glyph in the range.
Returns:
The number of chars.

isLeftToRight

public boolean isLeftToRight()
Returns true if the text direction in this layout is from left to right.

Specified by:
isLeftToRight in interface TextSpanLayout

draw

public void draw(Graphics2D g2d)
Paints the text layout using the specified Graphics2D and rendering context.

Specified by:
draw in interface TextSpanLayout
Parameters:
g2d - the Graphics2D to use

getAdvance2D

public Point2D getAdvance2D()
Returns the current text position at the completion of glyph layout.

Specified by:
getAdvance2D in interface TextSpanLayout

getOutline

public Shape getOutline()
Returns the outline of the completed glyph layout.

Specified by:
getOutline in interface TextSpanLayout

getGlyphAdvances

public float[] getGlyphAdvances()
Description copied from interface: TextSpanLayout
Returns the advance between each glyph in text progression direction.

Specified by:
getGlyphAdvances in interface TextSpanLayout

getDecorationOutline

public Shape getDecorationOutline(int decorationType)
Returns the outline of the specified decorations on the glyphs,

Specified by:
getDecorationOutline in interface TextSpanLayout
Parameters:
decorationType - an integer indicating the type(s) of decorations included in this shape. May be the result of "OR-ing" several values together: e.g. DECORATION_UNDERLINE | DECORATION_STRIKETHROUGH

getBounds2D

public Rectangle2D getBounds2D()
Returns the rectangular bounds of the completed glyph layout.

Specified by:
getBounds2D in interface TextSpanLayout

getGeometricBounds

public Rectangle2D getGeometricBounds()
Returns the rectangular bounds of the completed glyph layout, inclusive of "decoration" (underline, overline, etc.)

Specified by:
getGeometricBounds in interface TextSpanLayout

getTextPathAdvance

public Point2D getTextPathAdvance()
Returns the position to used when drawing a text run after this one. It takes into account the text path layout if there is one.

Specified by:
getTextPathAdvance in interface TextSpanLayout

getGlyphIndex

public int getGlyphIndex(int charIndex)
Returns the index of the first glyph that has the specified char index.

Specified by:
getGlyphIndex in interface TextSpanLayout
Parameters:
charIndex - The original index of the character in the text node's text string.
Returns:
The index of the matching glyph in this layout's glyph vector, or -1 if a matching glyph could not be found.

getLastGlyphIndex

public int getLastGlyphIndex(int charIndex)
Returns the index of the last glyph that has the specified char index.

Parameters:
charIndex - The original index of the character in the text node's text string.
Returns:
The index of the matching glyph in this layout's glyph vector, or -1 if a matching glyph could not be found.

getComputedOrientationAngle

public double getComputedOrientationAngle(int index)
Return the angle value according to the orientation of the character.

Specified by:
getComputedOrientationAngle in interface TextSpanLayout
Parameters:
index - index of the character in the ACI
Returns:
rotation angle

getHighlightShape

public Shape getHighlightShape(int beginCharIndex,
                               int endCharIndex)
Returns a Shape which encloses the currently selected glyphs as specified by the character indices.

Specified by:
getHighlightShape in interface TextSpanLayout
Parameters:
beginCharIndex - the index of the first char in the contiguous selection.
endCharIndex - the index of the last char in the contiguous selection.
Returns:
The highlight shape or null if the spacified char range does not overlap with the chars in this layout.

epsEQ

public static boolean epsEQ(double a,
                            double b)

makeConvexHull

public static int makeConvexHull(Point2D.Float[] pts,
                                 int numPts)

addPtsToPath

public static void addPtsToPath(GeneralPath shape,
                                Point2D.Float[] topPts,
                                Point2D.Float[] botPts,
                                int numPts)

mergeAreas

public static void mergeAreas(GeneralPath shape,
                              Area[] shapes,
                              int nShapes)

hitTestChar

public TextHit hitTestChar(float x,
                           float y)
Perform hit testing for coordinate at x, y.

Specified by:
hitTestChar in interface TextSpanLayout
Parameters:
x - the x coordinate of the point to be tested.
y - the y coordinate of the point to be tested.
Returns:
a TextHit object encapsulating the character index for successful hits and whether the hit is on the character leading edge.

getFont

protected GVTFont getFont()
Returns the GVTFont to use when rendering the specified character iterator. This should already be set as an attribute on the aci.

Returns:
The GVTFont to use.

getOverlineShape

protected Shape getOverlineShape()
Returns a shape describing the overline decoration for a given ACI.


getUnderlineShape

protected Shape getUnderlineShape()
Returns a shape describing the undeline decoration for a given ACI.


getStrikethroughShape

protected Shape getStrikethroughShape()
Returns a shape describing the strikethrough line for a given ACI.


doExplicitGlyphLayout

protected void doExplicitGlyphLayout()
Explicitly lays out each of the glyphs in the glyph vector. This will handle any glyph position adjustments such as dx, dy and baseline offsets. It will also handle vertical layouts.


adjustTextSpacing

protected void adjustTextSpacing()
Does any spacing adjustments that may have been specified.


doSpacing

protected Point2D doSpacing(Float kern,
                            Float letterSpacing,
                            Float wordSpacing)
Performs any spacing adjustments required and returns the new advance value.

Parameters:
kern - The kerning adjustment to apply to the space between each char.
letterSpacing - The amount of spacing required between each char.
wordSpacing - The amount of spacing required between each word.

applyStretchTransform

protected void applyStretchTransform(boolean stretchGlyphs)
Stretches the text so that it becomes the specified length.

Parameters:
stretchGlyphs - if true xScale, yScale will be applied to each glyphs transform.

doPathLayout

protected void doPathLayout()
If this layout is on a text path, positions the characters along the path.


isLatinChar

protected boolean isLatinChar(char c)
Returns true if the specified character is within one of the Latin unicode character blocks.

Parameters:
c - The char to test.
Returns:
True if c is latin.

isGlyphOrientationAuto

protected boolean isGlyphOrientationAuto()
Returns whether or not the vertical glyph orientation value is "auto".


getGlyphOrientationAngle

protected int getGlyphOrientationAngle()
Returns the value of the vertical glyph orientation angle. This will be one of 0, 90, 180 or 270.


hasCharacterIndex

public boolean hasCharacterIndex(int index)
Return true is the character index is represented by glyphs in this layout.

Specified by:
hasCharacterIndex in interface TextSpanLayout
Parameters:
index - index of the character in the ACI.
Returns:
true if the layout represents that character.

isAltGlyph

public boolean isAltGlyph()
Return true if this text run represents an alt glyph.

Specified by:
isAltGlyph in interface TextSpanLayout


Copyright © 2008 Apache Software Foundation. All Rights Reserved.