|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TextSpanLayout
Class that performs layout of attributed text strings into
glyph sets paintable by TextPainter instances.
Similar to java.awt.font.TextLayout in function and purpose.
Note that while this utility interface is provided for the convenience of
TextPainter
implementations, conforming TextPainter
s
are not required to use this class.
TextLayout
,
TextPainter
Field Summary | |
---|---|
static int |
DECORATION_ALL
|
static int |
DECORATION_OVERLINE
|
static int |
DECORATION_STRIKETHROUGH
|
static int |
DECORATION_UNDERLINE
|
Method Summary | |
---|---|
void |
draw(Graphics2D g2d)
Paints the specified text layout using the specified Graphics2D and rendering context. |
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 rotation angle applied to the character. |
Shape |
getDecorationOutline(int decorationType)
Returns the outline of the specified decorations on the glyphs, transformed by an AffineTransform. |
Rectangle2D |
getGeometricBounds()
Returns the bounds of the geometry (this is always the bounds of the outline). |
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 glyph index of the glyph that has the specified char index. |
GVTGlyphMetrics |
getGlyphMetrics(int glyphIndex)
Returns the Metrics for a particular glyph. |
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 glyph indices begin and end . |
GVTLineMetrics |
getLineMetrics()
Returns the Line metrics for this text span. |
Point2D |
getOffset()
Returns the current text position at the completion beginning of glyph layout, before the application of explicit glyph positioning attributes. |
Shape |
getOutline()
Returns the outline of the completed glyph layout, transformed by an AffineTransform. |
Point2D |
getTextPathAdvance()
|
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. |
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 |
isReversed()
Return true if this text has been reversed. |
boolean |
isVertical()
Returns true if the advance direction of this text is vertical. |
void |
maybeReverse(boolean mirror)
Reverse (and optionally mirror) glyphs if not already reversed. |
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. |
Field Detail |
---|
static final int DECORATION_UNDERLINE
static final int DECORATION_STRIKETHROUGH
static final int DECORATION_OVERLINE
static final int DECORATION_ALL
Method Detail |
---|
void draw(Graphics2D g2d)
g2d
- the Graphics2D to useShape getDecorationOutline(int decorationType)
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
Rectangle2D getBounds2D()
Rectangle2D getGeometricBounds()
Shape getOutline()
Point2D getAdvance2D()
float[] getGlyphAdvances()
GVTGlyphMetrics getGlyphMetrics(int glyphIndex)
GVTLineMetrics getLineMetrics()
Point2D getTextPathAdvance()
Point2D getOffset()
void setScale(float xScale, float yScale, boolean adjSpacing)
xScale
- Scale factor to apply in X direction.yScale
- Scale factor to apply in Y direction.adjSpacing
- True if only spaces should be adjusted.void setOffset(Point2D offset)
Shape getHighlightShape(int beginCharIndex, int endCharIndex)
begin
and end
.
beginCharIndex
- the index of the first glyph in the contiguous
selection.endCharIndex
- the index of the last glyph in the contiguous
selection.TextHit hitTestChar(float x, float y)
x
- the x coordinate of the point to be tested.y
- the y coordinate of the point to be tested.
boolean isVertical()
boolean isOnATextPath()
int getGlyphCount()
int getCharacterCount(int startGlyphIndex, int endGlyphIndex)
startGlyphIndex
- The index of the first glyph in the range.endGlyphIndex
- The index of the last glyph in the range.
int getGlyphIndex(int charIndex)
charIndex
- The original index of the character in the text node's
text string.
boolean isLeftToRight()
boolean hasCharacterIndex(int index)
index
- index of the character in the ACI.
GVTGlyphVector getGlyphVector()
double getComputedOrientationAngle(int index)
index
- index of the character in the ACI
boolean isAltGlyph()
boolean isReversed()
void maybeReverse(boolean mirror)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |