com.lowagie.text

Class Paragraph

public class Paragraph extends Phrase

A Paragraph is a series of Chunks and/or Phrases.

A Paragraph has the same qualities of a Phrase, but also some additional layout-parameters:

the indentation
the alignment of the text

Example:

 Paragraph p = new Paragraph("This is a paragraph",
               FontFactory.getFont(FontFactory.HELVETICA, 18, Font.BOLDITALIC, new Color(0, 0, 255)));

See Also: Element Phrase ListItem

Field Summary
protected int	alignment The alignment of the text.
float	extraParagraphSpace Holds value of property extraParagraphSpace.
float	firstLineIndent Holds value of property firstLineIndent.
protected float	indentationLeft The indentation of this paragraph on the left side.
protected float	indentationRight The indentation of this paragraph on the right side.
protected boolean	keeptogether Does the paragraph has to be kept together on 1 page.
protected float	multipliedLeading The text leading that is multiplied by the biggest font size in the line.
static long	serialVersionUID
protected float	spacingAfter The spacing after the paragraph.
protected float	spacingBefore The spacing before the paragraph.

Constructor Summary
	Paragraph() Constructs a `Paragraph`.
	Paragraph(float leading) Constructs a `Paragraph` with a certain leading.
	Paragraph(Chunk chunk) Constructs a `Paragraph` with a certain `Chunk`.
	Paragraph(float leading, Chunk chunk) Constructs a `Paragraph` with a certain `Chunk` and a certain leading.
	Paragraph(String string) Constructs a `Paragraph` with a certain `String`.
	Paragraph(String string, Font font) Constructs a `Paragraph` with a certain `String` and a certain `Font`.
	Paragraph(float leading, String string) Constructs a `Paragraph` with a certain `String` and a certain leading.
	Paragraph(float leading, String string, Font font) Constructs a `Paragraph` with a certain leading, `String` and `Font`.
	Paragraph(Phrase phrase) Constructs a `Paragraph` with a certain `Phrase`.

Method Summary
boolean	add(Object o) Adds an `Object` to the `Paragraph`.
int	getAlignment() Gets the alignment of this paragraph.
float	getExtraParagraphSpace() Getter for property extraParagraphSpace.
float	getFirstLineIndent() Getter for property firstLineIndent.
float	getIndentationLeft() Gets the indentation of this paragraph on the left side.
float	getIndentationRight() Gets the indentation of this paragraph on the right side.
boolean	getKeepTogether() Checks if this paragraph has to be kept together on one page.
float	getMultipliedLeading() Gets the variable leading
float	getTotalLeading() Gets the total leading.
void	setAlignment(int alignment) Sets the alignment of this paragraph.
void	setAlignment(String alignment) Sets the alignment of this paragraph.
void	setExtraParagraphSpace(float extraParagraphSpace) Setter for property extraParagraphSpace.
void	setFirstLineIndent(float firstLineIndent) Setter for property firstLineIndent.
void	setIndentationLeft(float indentation) Sets the indentation of this paragraph on the left side.
void	setIndentationRight(float indentation) Sets the indentation of this paragraph on the right side.
void	setKeepTogether(boolean keeptogether) Indicates that the paragraph has to be kept together on one page.
void	setLeading(float fixedLeading)
void	setLeading(float fixedLeading, float multipliedLeading) Sets the leading fixed and variable.
void	setMultipliedLeading(float multipliedLeading) Sets the variable leading.
void	setSpacingAfter(float spacing) Sets the spacing after this paragraph.
void	setSpacingBefore(float spacing) Sets the spacing before this paragraph.
float	spacingAfter() Gets the spacing after this paragraph.
float	spacingBefore() Gets the spacing before this paragraph.
int	type() Gets the type of the text element.

Field Detail

alignment

protected int alignment

The alignment of the text.

extraParagraphSpace

private float extraParagraphSpace

Holds value of property extraParagraphSpace.

firstLineIndent

private float firstLineIndent

Holds value of property firstLineIndent.

indentationLeft

protected float indentationLeft

The indentation of this paragraph on the left side.

indentationRight

protected float indentationRight

The indentation of this paragraph on the right side.

keeptogether

protected boolean keeptogether

Does the paragraph has to be kept together on 1 page.

multipliedLeading

protected float multipliedLeading

The text leading that is multiplied by the biggest font size in the line.

serialVersionUID

private static final long serialVersionUID

spacingAfter

protected float spacingAfter

The spacing after the paragraph.

spacingBefore

protected float spacingBefore

The spacing before the paragraph.

Constructor Detail

Paragraph

public Paragraph()

Constructs a Paragraph.

Paragraph

public Paragraph(float leading)

Constructs a Paragraph with a certain leading.

Parameters: leading the leading

Paragraph

public Paragraph(Chunk chunk)

Constructs a Paragraph with a certain Chunk.

Parameters: chunk a Chunk

Paragraph

public Paragraph(float leading, Chunk chunk)

Constructs a Paragraph with a certain Chunk and a certain leading.

Parameters: leading the leading chunk a Chunk

Paragraph

public Paragraph(String string)

Constructs a Paragraph with a certain String.

Parameters: string a String

Paragraph

public Paragraph(String string, Font font)

Constructs a Paragraph with a certain String and a certain Font.

Parameters: string a String font a Font

Paragraph

public Paragraph(float leading, String string)

Constructs a Paragraph with a certain String and a certain leading.

Parameters: leading the leading string a String

Paragraph

public Paragraph(float leading, String string, Font font)

Constructs a Paragraph with a certain leading, String and Font.

Parameters: leading the leading string a String font a Font

Paragraph

public Paragraph(Phrase phrase)

Constructs a Paragraph with a certain Phrase.

Parameters: phrase a Phrase

Method Detail

add

public boolean add(Object o)

Adds an Object to the Paragraph.

Parameters: o object the object to add.

Returns: true is adding the object succeeded

getAlignment

public int getAlignment()

Gets the alignment of this paragraph.

Returns: alignment

getExtraParagraphSpace

public float getExtraParagraphSpace()

Getter for property extraParagraphSpace.

Returns: Value of property extraParagraphSpace.

getFirstLineIndent

public float getFirstLineIndent()

Getter for property firstLineIndent.

Returns: Value of property firstLineIndent.

getIndentationLeft

public float getIndentationLeft()

Gets the indentation of this paragraph on the left side.

Returns: the indentation

getIndentationRight

public float getIndentationRight()

Gets the indentation of this paragraph on the right side.

Returns: the indentation

getKeepTogether

public boolean getKeepTogether()

Checks if this paragraph has to be kept together on one page.

Returns: true if the paragraph may not be split over 2 pages.

getMultipliedLeading

public float getMultipliedLeading()

Gets the variable leading

Returns: the leading

getTotalLeading

public float getTotalLeading()

Gets the total leading. This method is based on the assumption that the font of the Paragraph is the font of all the elements that make part of the paragraph. This isn't necessarily true.

Returns: the total leading (fixed and multiplied)

setAlignment

public void setAlignment(int alignment)

Sets the alignment of this paragraph.

Parameters: alignment the new alignment

setAlignment

public void setAlignment(String alignment)

Sets the alignment of this paragraph.

Parameters: alignment the new alignment as a String

setExtraParagraphSpace

public void setExtraParagraphSpace(float extraParagraphSpace)

Setter for property extraParagraphSpace.

Parameters: extraParagraphSpace New value of property extraParagraphSpace.

setFirstLineIndent

public void setFirstLineIndent(float firstLineIndent)

Setter for property firstLineIndent.

Parameters: firstLineIndent New value of property firstLineIndent.

setIndentationLeft

public void setIndentationLeft(float indentation)

Sets the indentation of this paragraph on the left side.

Parameters: indentation the new indentation

setIndentationRight

public void setIndentationRight(float indentation)

Sets the indentation of this paragraph on the right side.

Parameters: indentation the new indentation

setKeepTogether

public void setKeepTogether(boolean keeptogether)

Indicates that the paragraph has to be kept together on one page.

Parameters: keeptogether true of the paragraph may not be split over 2 pages

setLeading

public void setLeading(float fixedLeading)

setLeading

public void setLeading(float fixedLeading, float multipliedLeading)

Sets the leading fixed and variable. The resultant leading will be fixedLeading+multipliedLeading*maxFontSize where maxFontSize is the size of the biggest font in the line.

Parameters: fixedLeading the fixed leading multipliedLeading the variable leading