rst.pdfbox.layout.text

Class StyledText

java.lang.Object

rst.pdfbox.layout.text.StyledText

All Implemented Interfaces:

Area, TextFragment

Direct Known Subclasses:

AnnotatedStyledText

public class StyledText
extends Object
implements TextFragment

Base class representing drawable text styled with font, size, color etc.

Constructor Summary

Constructors

Constructor and Description
StyledText(String text, float size, org.apache.pdfbox.pdmodel.font.PDFont font) Creates a styled text.
StyledText(String text, float size, org.apache.pdfbox.pdmodel.font.PDFont font, Color color) Creates a styled text.
StyledText(String text, float size, org.apache.pdfbox.pdmodel.font.PDFont font, Color color, float baselineOffset) Creates a styled text.
StyledText(String text, FontDescriptor fontDescriptor) Creates a styled text.
StyledText(String text, FontDescriptor fontDescriptor, Color color) Creates a styled text.
StyledText(String text, FontDescriptor fontDescriptor, Color color, float baselineOffset, float leftMargin, float rightMargin) Creates a styled text.

Method Summary

Modifier and Type	Method and Description
TextSequence	asSequence()
float	getAsent()
float	getBaselineOffset()
Color	getColor()
FontDescriptor	getFontDescriptor()
float	getHeight()
float	getLeftMargin()
float	getRightMargin()
String	getText()
float	getWidth()
float	getWidthWithoutMargin()
boolean	hasMargin()
StyledText	inheritAttributes(String text)
StyledText	inheritAttributes(String text, float leftMargin, float rightMargin)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StyledText

public StyledText(String text,
                  float size,
                  org.apache.pdfbox.pdmodel.font.PDFont font)

Creates a styled text.

Parameters:

text - the text to draw. Must not contain line feeds ('\n').

size - the size of the font.

font - the font to use.

StyledText

public StyledText(String text,
                  float size,
                  org.apache.pdfbox.pdmodel.font.PDFont font,
                  Color color)

Creates a styled text.

Parameters:

text - the text to draw. Must not contain line feeds ('\n').

size - the size of the font.

font - the font to use.

color - the color to use.

StyledText

public StyledText(String text,
                  float size,
                  org.apache.pdfbox.pdmodel.font.PDFont font,
                  Color color,
                  float baselineOffset)

Creates a styled text.

Parameters:

text - the text to draw. Must not contain line feeds ('\n').

size - the size of the font.

font - the font to use.

color - the color to use.

baselineOffset - the offset of the baseline.

StyledText

public StyledText(String text,
                  FontDescriptor fontDescriptor)

Creates a styled text.

Parameters:

text - the text to draw. Must not contain line feeds ('\n').

fontDescriptor - the font to use.

StyledText

public StyledText(String text,
                  FontDescriptor fontDescriptor,
                  Color color)

Creates a styled text.

Parameters:

text - the text to draw. Must not contain line feeds ('\n').

fontDescriptor - the font to use.

color - the color to use.

StyledText

public StyledText(String text,
                  FontDescriptor fontDescriptor,
                  Color color,
                  float baselineOffset,
                  float leftMargin,
                  float rightMargin)

Creates a styled text.

Parameters:

text - the text to draw. Must not contain line feeds ('\n').

fontDescriptor - the font to use.

color - the color to use.

baselineOffset - the offset of the baseline.

leftMargin - the margin left to the text.

rightMargin - the margin right to the text.

Method Detail

getText

public String getText()

Specified by:

getText in interface TextFragment

Returns:

the text to draw.

getFontDescriptor

public FontDescriptor getFontDescriptor()

Specified by:

getFontDescriptor in interface TextFragment

Returns:

the font to use to draw the text.

getWidth

public float getWidth()
               throws IOException

Specified by:

getWidth in interface Area

Returns:

the width of the area.

Throws:

IOException - by pdfbox

getWidthWithoutMargin

public float getWidthWithoutMargin()
                            throws IOException

Throws:

IOException

getHeight

public float getHeight()
                throws IOException

Specified by:

getHeight in interface Area

Returns:

the height of the area.

Throws:

IOException - by pdfbox

getAsent

public float getAsent()
               throws IOException

Returns:

the ascent of the associated font.

Throws:

IOException - by pdfbox.

getBaselineOffset

public float getBaselineOffset()

getColor

public Color getColor()

Specified by:

getColor in interface TextFragment

Returns:

the color to use to draw the text.

getLeftMargin

public float getLeftMargin()

Returns:

the margin left to the text represented by this object.

getRightMargin

public float getRightMargin()

Returns:

the margin right to the text represented by this object.

hasMargin

public boolean hasMargin()

Returns:

indicates if this text has margin.

asSequence

public TextSequence asSequence()

Returns:

converts this text to a sequence.

inheritAttributes

public StyledText inheritAttributes(String text)

inheritAttributes

public StyledText inheritAttributes(String text,
                                    float leftMargin,
                                    float rightMargin)

toString

public String toString()

Overrides:

toString in class Object