com.lowagie.text

Class Paragraph

Implemented Interfaces:
Element, MarkupAttributes, TextElementArray
Known Direct Subclasses:
ListItem

public class Paragraph
extends Phrase
implements TextElementArray, MarkupAttributes

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:

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.
private float
extraParagraphSpace
Holds value of property extraParagraphSpace.
private 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.
protected float
spacingAfter
The spacing after the paragraph.
protected float
spacingBefore
The spacing before the paragraph.

Fields inherited from class com.lowagie.text.Phrase

font, leading, markupAttributes

Fields inherited from interface com.lowagie.text.Element

ALIGN_BASELINE, ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_JUSTIFIED, ALIGN_JUSTIFIED_ALL, ALIGN_LEFT, ALIGN_MIDDLE, ALIGN_RIGHT, ALIGN_TOP, ALIGN_UNDEFINED, ANCHOR, ANNOTATION, AUTHOR, CCITTG3_1D, CCITTG3_2D, CCITTG4, CCITT_BLACKIS1, CCITT_ENCODEDBYTEALIGN, CCITT_ENDOFBLOCK, CCITT_ENDOFLINE, CELL, CHAPTER, CHUNK, CREATIONDATE, CREATOR, GRAPHIC, HEADER, IMGRAW, IMGTEMPLATE, JPEG, KEYWORDS, LIST, LISTITEM, MULTI_COLUMN_TEXT, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE

Constructor Summary

Paragraph()
Constructs a Paragraph.
Paragraph(Properties attributes)
Returns a Paragraph that has been constructed taking in account the value of some attributes.
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(Chunk chunk)
Constructs a Paragraph with a certain Chunk.
Paragraph(Phrase phrase)
Constructs a Paragraph with a certain Phrase.
Paragraph(float leading)
Constructs a Paragraph with a certain leading.
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(float leading, Chunk chunk)
Constructs a Paragraph with a certain Chunk and a certain leading.

Method Summary

boolean
add(Object o)
Adds an Object to the Paragraph.
int
alignment()
Gets the alignment of this paragraph.
float
getExtraParagraphSpace()
Getter for property extraParagraphSpace.
float
getFirstLineIndent()
Getter for property firstLineIndent.
boolean
getKeepTogether()
Checks if this paragraph has to be kept together on one page.
float
getMultipliedLeading()
Gets the variable leading
float
indentationLeft()
Gets the indentation of this paragraph on the left side.
float
indentationRight()
Gets the indentation of this paragraph on the right side.
static boolean
isTag(String tag)
Checks if a given tag corresponds with this object.
void
setAlignment(String alignment)
Sets the alignment of this paragraph.
void
setAlignment(int 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
setSpacingAfter(float spacing)
Sets the spacing after this paragraph.
void
setSpacingBefore(float spacing)
Sets the spacing before this paragraph.
float
spacingAfter()
Gets the spacing before this paragraph.
float
spacingBefore()
Gets the spacing before this paragraph.
int
type()
Gets the type of the text element.

Methods inherited from class com.lowagie.text.Phrase

add, add, addAll, addChunk, addSpecial, font, getChunks, getInstance, getInstance, getInstance, getMarkupAttribute, getMarkupAttributeNames, getMarkupAttributes, isEmpty, isTag, leading, leadingDefined, process, setLeading, setMarkupAttribute, setMarkupAttributes, type

Field Details

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.

spacingAfter

protected float spacingAfter
The spacing after the paragraph.

spacingBefore

protected float spacingBefore
The spacing before the paragraph.

Constructor Details

Paragraph

public Paragraph()
Constructs a Paragraph.

Paragraph

public Paragraph(Properties attributes)
Returns a Paragraph that has been constructed taking in account the value of some attributes.
Parameters:
attributes - Some attributes

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(Chunk chunk)
Constructs a Paragraph with a certain Chunk.
Parameters:
chunk - a Chunk

Paragraph

public Paragraph(Phrase phrase)
Constructs a Paragraph with a certain Phrase.
Parameters:
phrase - a Phrase

Paragraph

public Paragraph(float leading)
Constructs a Paragraph with a certain leading.
Parameters:
leading - the leading

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(float leading,
                 Chunk chunk)
Constructs a Paragraph with a certain Chunk and a certain leading.
Parameters:
leading - the leading
chunk - a Chunk

Method Details

add

public boolean add(Object o)
Adds an Object to the Paragraph.
Specified by:
add in interface TextElementArray
Overrides:
add in interface Phrase
Parameters:
o - object the object to add.
Returns:
true is adding the object succeeded

alignment

public int alignment()
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.

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

indentationLeft

public float indentationLeft()
Gets the indentation of this paragraph on the left side.
Returns:
the indentation

indentationRight

public float indentationRight()
Gets the indentation of this paragraph on the right side.
Returns:
the indentation

isTag

public static boolean isTag(String tag)
Checks if a given tag corresponds with this object.
Overrides:
isTag in interface Phrase
Parameters:
tag - the given tag
Returns:
true if the tag corresponds

setAlignment

public void setAlignment(String alignment)
Sets the alignment of this paragraph.
Parameters:
alignment - the new alignment as a String

setAlignment

public void setAlignment(int alignment)
Sets the alignment of this paragraph.
Parameters:
alignment - the new alignment

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)
Overrides:
setLeading in interface Phrase

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 bigest font in the line.
Parameters:
fixedLeading - the fixed leading
multipliedLeading - the variable leading

setSpacingAfter

public void setSpacingAfter(float spacing)
Sets the spacing after this paragraph.
Parameters:
spacing - the new spacing

setSpacingBefore

public void setSpacingBefore(float spacing)
Sets the spacing before this paragraph.
Parameters:
spacing - the new spacing

spacingAfter

public float spacingAfter()
Gets the spacing before this paragraph.
Returns:
the spacing

spacingBefore

public float spacingBefore()
Gets the spacing before this paragraph.
Returns:
the spacing

type

public int type()
Gets the type of the text element.
Specified by:
type in interface Element
Overrides:
type in interface Phrase
Returns:
a type