Package com.metsci.glimpse.core.support.font

Class SimpleTextLayout

java.lang.Object

com.metsci.glimpse.core.support.font.SimpleTextLayout

Direct Known Subclasses:

SimpleTextLayoutCenter

public class SimpleTextLayout
extends Object

Performs simple text layout so text can be wrapped in small areas or broken on words or newlines. This implementation currently makes the following assumptions which are valid for latin text:

• mapping chars to glyphs is 1:1 in order, (no Unicode surrogate pairs or multi-glyph characters)
• left-to-right and top-to-bottom text layout

All coordinates are in the same space as the text is being drawn (typically pixels).

Author:

borkholder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SimpleTextLayout.TextBoundingBox	When drawing using the JOGL TextRenderer, the SimpleTextLayout.TextBoundingBox.leftX and SimpleTextLayout.TextBoundingBox.baselineY should be used as the text origin.

Constructor Summary

Constructors

Constructor	Description
SimpleTextLayout(Font font, FontRenderContext frc)
SimpleTextLayout(Font font, FontRenderContext frc, BreakIterator breaker)

Method Summary

Modifier and Type	Method	Description
void	doLayout(String text, float leftX, float topY, float maxWidth)	Takes the text and performs the layout.
double	getAscent()
boolean	getBreakOnEol()	Whether to force a break on the end of line characters (\r \f \n).
double	getDescent()
SimpleTextLayout.TextBoundingBox	getLine(int line)
double	getLineHeight()
List<SimpleTextLayout.TextBoundingBox>	getLines()
float	getLineSpacing()	The spacing between the bottom (descent) of one line of text to the top (ascent) of the next line.
String	getSourceText()
int	numberOfLines()
void	setAscent(float ascent)
void	setBreakOnEol(boolean breakOnEol)
void	setLineSpacing(float lineSpacing)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimpleTextLayout

public SimpleTextLayout(Font font,
                        FontRenderContext frc)

Parameters:

font - The font to use for the layout

frc - The FontRenderContext used to rasterize the font. This will help define the character bounds

SimpleTextLayout

public SimpleTextLayout(Font font,
                        FontRenderContext frc,
                        BreakIterator breaker)

Parameters:

font - The font to use for the layout

frc - The FontRenderContext used to rasterize the font. This will help define the character bounds

breaker - The BreakIterator that is used to break the text (also see forceBreakAfter(int))

Method Detail

getLineHeight

public double getLineHeight()

getDescent

public double getDescent()

getAscent

public double getAscent()

setAscent

public void setAscent(float ascent)

setBreakOnEol

public void setBreakOnEol(boolean breakOnEol)

getBreakOnEol

public boolean getBreakOnEol()

Whether to force a break on the end of line characters (\r \f \n).

setLineSpacing

public void setLineSpacing(float lineSpacing)

getLineSpacing

public float getLineSpacing()

The spacing between the bottom (descent) of one line of text to the top (ascent) of the next line.

doLayout

public void doLayout(String text,
                     float leftX,
                     float topY,
                     float maxWidth)

Takes the text and performs the layout. The provided constraints determine the top-left position of the text and the maximum width. See numberOfLines(), getLine(int) and #getBounds(int) for the results of the layout.

Parameters:

text - The text to lay out

leftX - The leftmost X value of any pixel of text

topY - The topmost Y value of any pixel of text

maxWidth - The suggested maximum width of any line of the text

getSourceText

public String getSourceText()

numberOfLines

public int numberOfLines()

getLine

public SimpleTextLayout.TextBoundingBox getLine(int line)

getLines

public List<SimpleTextLayout.TextBoundingBox> getLines()