rst.pdfbox.layout.text

Class Indent

java.lang.Object

rst.pdfbox.layout.text.ControlFragment

rst.pdfbox.layout.text.Indent

All Implemented Interfaces:

Area, TextFragment

public class Indent
extends ControlFragment

Control fragment that represents a indent in text.

Field Summary

Fields

Modifier and Type	Field and Description
protected Alignment	alignment
protected SpaceUnit	indentUnit
protected float	indentWidth
protected StyledText	styledText
static Indent	UNINDENT Constant for the indentation of 0.

Fields inherited from class rst.pdfbox.layout.text.ControlFragment

DEFAULT_FONT_DESCRIPTOR

Constructor Summary

Constructors

Constructor and Description
Indent(float indentPt) Directly creates an indent of the given width in pt.
Indent(float indentWidth, SpaceUnit indentUnit) Creates a new line with the given font descriptor.
Indent(String label, float indentWidth, SpaceUnit indentUnit, float fontSize, org.apache.pdfbox.pdmodel.font.PDFont font) Creates a new line with the ControlFragment.DEFAULT_FONT_DESCRIPTOR's font and the given height.
Indent(String label, float indentWidth, SpaceUnit indentUnit, float fontSize, org.apache.pdfbox.pdmodel.font.PDFont font, Alignment alignment) Creates a new line with the ControlFragment.DEFAULT_FONT_DESCRIPTOR's font and the given height.
Indent(String label, float indentWidth, SpaceUnit indentUnit, float fontSize, org.apache.pdfbox.pdmodel.font.PDFont font, Alignment alignment, Color color) Creates a new line with the ControlFragment.DEFAULT_FONT_DESCRIPTOR's font and the given height.
Indent(String label, float indentWidth, SpaceUnit indentUnit, FontDescriptor fontDescriptor, Alignment alignment, Color color) Creates a new line with the given font descriptor.

Method Summary

Modifier and Type	Method and Description
float	getWidth()
String	toString()
StyledText	toStyledText()

Methods inherited from class rst.pdfbox.layout.text.ControlFragment

getColor, getFontDescriptor, getHeight, getName, getText

Methods inherited from class java.lang.Object

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

Field Detail

UNINDENT

public static final Indent UNINDENT

Constant for the indentation of 0.

indentWidth

protected float indentWidth

indentUnit

protected SpaceUnit indentUnit

alignment

protected Alignment alignment

styledText

protected StyledText styledText

Constructor Detail

Indent

public Indent(float indentWidth,
              SpaceUnit indentUnit)
       throws IOException

Creates a new line with the given font descriptor.

Parameters:

indentWidth - the indentation.

indentUnit - the indentation unit.

Throws:

IOException - by pdfbox

Indent

public Indent(String label,
              float indentWidth,
              SpaceUnit indentUnit,
              float fontSize,
              org.apache.pdfbox.pdmodel.font.PDFont font)
       throws IOException

Creates a new line with the ControlFragment.DEFAULT_FONT_DESCRIPTOR's font and the given height.

Parameters:

label - the label of the indentation.

indentWidth - the indentation.

indentUnit - the indentation unit.

fontSize - the font size, resp. the height of the new line.

font - the font to use.

Throws:

IOException - by pdfbox

Indent

public Indent(String label,
              float indentWidth,
              SpaceUnit indentUnit,
              float fontSize,
              org.apache.pdfbox.pdmodel.font.PDFont font,
              Alignment alignment)
       throws IOException

Creates a new line with the ControlFragment.DEFAULT_FONT_DESCRIPTOR's font and the given height.

Parameters:

label - the label of the indentation.

indentWidth - the indentation.

indentUnit - the indentation unit.

fontSize - the font size, resp. the height of the new line.

font - the font to use.

alignment - the alignment of the label.

Throws:

IOException - by pdfbox

Indent

public Indent(String label,
              float indentWidth,
              SpaceUnit indentUnit,
              float fontSize,
              org.apache.pdfbox.pdmodel.font.PDFont font,
              Alignment alignment,
              Color color)
       throws IOException

Creates a new line with the ControlFragment.DEFAULT_FONT_DESCRIPTOR's font and the given height.

Parameters:

label - the label of the indentation.

indentWidth - the indentation.

indentUnit - the indentation unit.

fontSize - the font size, resp. the height of the new line.

font - the font to use.

alignment - the alignment of the label.

color - the color to use.

Throws:

IOException - by pdfbox

Indent

public Indent(String label,
              float indentWidth,
              SpaceUnit indentUnit,
              FontDescriptor fontDescriptor,
              Alignment alignment,
              Color color)
       throws IOException

Creates a new line with the given font descriptor.

Parameters:

label - the label of the indentation.

indentWidth - the indentation width.

indentUnit - the indentation unit.

fontDescriptor - the font and size associated with this new line.

alignment - the alignment of the label.

color - the color to use.

Throws:

IOException - by pdfbox

Indent

public Indent(float indentPt)

Directly creates an indent of the given width in pt.

Parameters:

indentPt - the indentation in pt.

Method Detail

getWidth

public float getWidth()
               throws IOException

Specified by:

getWidth in interface Area

Overrides:

getWidth in class ControlFragment

Returns:

the width of the area.

Throws:

IOException - by pdfbox

toStyledText

public StyledText toStyledText()

Returns:

a styled text representation of the indent.

toString

public String toString()

Overrides:

toString in class ControlFragment