A
Paragraph
is a series of
Chunk
s 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)));
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.
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.
attributes
- Some attributes
Paragraph
public Paragraph(String string)
Constructs a Paragraph
with a certain String
.
Paragraph
public Paragraph(String string,
Font font)
Constructs a Paragraph
with a certain String
and a certain Font
.
string
- a String
font
- a Font
Paragraph
public Paragraph(Chunk chunk)
Constructs a Paragraph
with a certain Chunk
.
Paragraph
public Paragraph(Phrase phrase)
Constructs a Paragraph
with a certain Phrase
.
Paragraph
public Paragraph(float leading)
Constructs a Paragraph
with a certain leading.
Paragraph
public Paragraph(float leading,
String string)
Constructs a Paragraph
with a certain String
and a certain leading.
leading
- the leadingstring
- a String
Paragraph
public Paragraph(float leading,
String string,
Font font)
Constructs a Paragraph
with a certain leading, String
and Font
.
leading
- the leadingstring
- a String
font
- a Font
Paragraph
public Paragraph(float leading,
Chunk chunk)
Constructs a Paragraph
with a certain Chunk
and a certain leading.
leading
- the leadingchunk
- a Chunk
add
public boolean add(Object o)
Adds an Object
to the Paragraph
.
- add in interface TextElementArray
- add in interface Phrase
o
- object the object to add.
- true is adding the object succeeded
alignment
public int alignment()
Gets the alignment of this paragraph.
getExtraParagraphSpace
public float getExtraParagraphSpace()
Getter for property extraParagraphSpace.
- Value of property extraParagraphSpace.
getFirstLineIndent
public float getFirstLineIndent()
Getter for property firstLineIndent.
- Value of property firstLineIndent.
getKeepTogether
public boolean getKeepTogether()
Checks if this paragraph has to be kept together on one page.
- true if the paragraph may not be split over 2 pages.
getMultipliedLeading
public float getMultipliedLeading()
Gets the variable leading
indentationLeft
public float indentationLeft()
Gets the indentation of this paragraph on the left side.
indentationRight
public float indentationRight()
Gets the indentation of this paragraph on the right side.
isTag
public static boolean isTag(String tag)
Checks if a given tag corresponds with this object.
- isTag in interface Phrase
- true if the tag corresponds
setAlignment
public void setAlignment(String alignment)
Sets the alignment of this paragraph.
alignment
- the new alignment as a String
setAlignment
public void setAlignment(int alignment)
Sets the alignment of this paragraph.
alignment
- the new alignment
setExtraParagraphSpace
public void setExtraParagraphSpace(float extraParagraphSpace)
Setter for property extraParagraphSpace.
extraParagraphSpace
- New value of property extraParagraphSpace.
setFirstLineIndent
public void setFirstLineIndent(float firstLineIndent)
Setter for property firstLineIndent.
firstLineIndent
- New value of property firstLineIndent.
setIndentationLeft
public void setIndentationLeft(float indentation)
Sets the indentation of this paragraph on the left side.
indentation
- the new indentation
setIndentationRight
public void setIndentationRight(float indentation)
Sets the indentation of this paragraph on the right side.
indentation
- the new indentation
setKeepTogether
public void setKeepTogether(boolean keeptogether)
Indicates that the paragraph has to be kept together on one page.
keeptogether
- true of the paragraph may not be split over 2 pages
setLeading
public void setLeading(float fixedLeading)
- 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.
fixedLeading
- the fixed leadingmultipliedLeading
- the variable leading
setSpacingAfter
public void setSpacingAfter(float spacing)
Sets the spacing after this paragraph.
spacing
- the new spacing
setSpacingBefore
public void setSpacingBefore(float spacing)
Sets the spacing before this paragraph.
spacing
- the new spacing
spacingAfter
public float spacingAfter()
Gets the spacing after this paragraph.
spacingBefore
public float spacingBefore()
Gets the spacing before this paragraph.
type
public int type()
Gets the type of the text element.
- type in interface Element
- type in interface Phrase