Package com.itextpdf.text
Class Paragraph
- All Implemented Interfaces:
Indentable
,Spaceable
,Element
,IAccessibleElement
,TextElementArray
,Serializable
,Cloneable
,Iterable<Element>
,Collection<Element>
,List<Element>
,RandomAccess
,SequencedCollection<Element>
- Direct Known Subclasses:
ListItem
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
Paragraph p = new Paragraph("This is a paragraph", FontFactory.getFont(FontFactory.HELVETICA, 18, Font.BOLDITALIC, new Color(0, 0, 255)));
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected int
The alignment of the text.private float
Holds value of property extraParagraphSpace.private float
Holds value of property firstLineIndent.protected AccessibleElementId
protected float
The indentation of this paragraph on the left side.protected float
The indentation of this paragraph on the right side.protected boolean
Does the paragraph has to be kept together on 1 page.protected float
protected PdfName
private static final long
protected float
The spacing after the paragraph.protected float
The spacing before the paragraph.Fields inherited from class com.itextpdf.text.Phrase
font, hyphenation, leading, multipliedLeading, tabSettings
Fields inherited from class java.util.AbstractList
modCount
Fields inherited from interface com.itextpdf.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, BODY, CCITT_BLACKIS1, CCITT_ENCODEDBYTEALIGN, CCITT_ENDOFBLOCK, CCITT_ENDOFLINE, CCITTG3_1D, CCITTG3_2D, CCITTG4, CHAPTER, CHUNK, CREATIONDATE, CREATOR, DIV, HEADER, IMGRAW, IMGTEMPLATE, JBIG2, JPEG, JPEG2000, KEYWORDS, LANGUAGE, LIST, LISTITEM, MARKED, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, SECTION, SUBJECT, TITLE, WRITABLE_DIRECT, YMARK
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs aParagraph
.Paragraph
(float leading) Constructs aParagraph
with a certain leading.Constructs aParagraph
with a certainChunk
and a certain leading.Constructs aParagraph
with a certainString
and a certain leading.Constructs aParagraph
with a certain leading,String
andFont
.Constructs aParagraph
with a certainChunk
.Constructs aParagraph
with a certainPhrase
.Constructs aParagraph
with a certainString
.Constructs aParagraph
with a certainString
and a certainFont
. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Adds anElement
to theParagraph
.breakUp()
Breaks this Paragraph up in different parts, separating paragraphs, lists and tables from each other.cloneShallow
(boolean spacingBefore) Creates a shallow clone of the Paragraph.Get the attribute of accessible element (everything inA
dictionary +Lang
,Alt
,ActualText
,E
).Gets all the properties of accessible element.int
Gets the alignment of this paragraph.float
Getter for property extraParagraphSpace.float
Getter for property firstLineIndent.getId()
float
Gets the indentation on the left side.float
Gets the indentation on the right side.boolean
Checks if this paragraph has to be kept together on one page.float
getRole()
Gets the role of the accessible element.float
Gets the spacing after.float
Gets the spacing before.boolean
isInline()
protected void
populateProperties
(Paragraph copy, boolean spacingBefore) void
setAccessibleAttribute
(PdfName key, PdfObject value) Set the attribute of accessible element (everything inA
dictionary +Lang
,Alt
,ActualText
,E
).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
void
setIndentationLeft
(float indentation) Sets the indentation on the left side.void
setIndentationRight
(float indentation) Sets the indentation on the right side.void
setKeepTogether
(boolean keeptogether) Indicates that the paragraph has to be kept together on one page.void
setPaddingTop
(float paddingTop) void
Sets the role of the accessiblee element.void
setSpacingAfter
(float spacing) Sets the spacing after.void
setSpacingBefore
(float spacing) Sets the spacing before.float
Deprecated.float
Deprecated.As of iText 2.1.5, replaced bygetSpacingBefore()
, scheduled for removal at 2.3.0int
type()
Gets the type of the text element.Methods inherited from class com.itextpdf.text.Phrase
add, add, addAll, addChunk, addSpecial, getChunks, getContent, getFont, getHyphenation, getInstance, getInstance, getInstance, getLeading, getMultipliedLeading, getTabSettings, getTotalLeading, hasLeading, isContent, isEmpty, isNestable, process, setFont, setHyphenation, setLeading, setLeading, setMultipliedLeading, setTabSettings, trim
Methods inherited from class java.util.ArrayList
addAll, addFirst, addLast, clear, clone, contains, ensureCapacity, equals, forEach, get, getFirst, getLast, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeFirst, removeIf, removeLast, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize
Methods inherited from class java.util.AbstractCollection
containsAll, toString
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Collection
parallelStream, stream, toArray
Methods inherited from interface java.util.List
containsAll, reversed
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
alignment
protected int alignmentThe alignment of the text. -
indentationLeft
protected float indentationLeftThe indentation of this paragraph on the left side. -
indentationRight
protected float indentationRightThe indentation of this paragraph on the right side. -
firstLineIndent
private float firstLineIndentHolds value of property firstLineIndent. -
spacingBefore
protected float spacingBeforeThe spacing before the paragraph. -
spacingAfter
protected float spacingAfterThe spacing after the paragraph. -
extraParagraphSpace
private float extraParagraphSpaceHolds value of property extraParagraphSpace. -
keeptogether
protected boolean keeptogetherDoes the paragraph has to be kept together on 1 page. -
paddingTop
protected float paddingTop -
role
-
accessibleAttributes
-
id
-
-
Constructor Details
-
Paragraph
public Paragraph()Constructs aParagraph
. -
Paragraph
public Paragraph(float leading) Constructs aParagraph
with a certain leading.- Parameters:
leading
- the leading
-
Paragraph
Constructs aParagraph
with a certainChunk
.- Parameters:
chunk
- aChunk
-
Paragraph
Constructs aParagraph
with a certainChunk
and a certain leading.- Parameters:
leading
- the leadingchunk
- aChunk
-
Paragraph
Constructs aParagraph
with a certainString
.- Parameters:
string
- aString
-
Paragraph
Constructs aParagraph
with a certainString
and a certainFont
.- Parameters:
string
- aString
font
- aFont
-
Paragraph
Constructs aParagraph
with a certainString
and a certain leading.- Parameters:
leading
- the leadingstring
- aString
-
Paragraph
Constructs aParagraph
with a certain leading,String
andFont
.- Parameters:
leading
- the leadingstring
- aString
font
- aFont
-
Paragraph
Constructs aParagraph
with a certainPhrase
.- Parameters:
phrase
- aPhrase
-
-
Method Details
-
cloneShallow
Creates a shallow clone of the Paragraph.- Returns:
-
populateProperties
-
breakUp
Breaks this Paragraph up in different parts, separating paragraphs, lists and tables from each other.- Returns:
-
type
public int type()Gets the type of the text element. -
add
Adds anElement
to theParagraph
.- Specified by:
add
in interfaceCollection<Element>
- Specified by:
add
in interfaceList<Element>
- Specified by:
add
in interfaceTextElementArray
- Overrides:
add
in classPhrase
- Parameters:
o
- the element to add.- Returns:
- true is adding the object succeeded
-
setAlignment
public void setAlignment(int alignment) Sets the alignment of this paragraph.- Parameters:
alignment
- the new alignment
-
setIndentationLeft
public void setIndentationLeft(float indentation) Description copied from interface:Indentable
Sets the indentation on the left side.- Specified by:
setIndentationLeft
in interfaceIndentable
- Parameters:
indentation
- the new indentation
-
setIndentationRight
public void setIndentationRight(float indentation) Description copied from interface:Indentable
Sets the indentation on the right side.- Specified by:
setIndentationRight
in interfaceIndentable
- Parameters:
indentation
- the new indentation
-
setFirstLineIndent
public void setFirstLineIndent(float firstLineIndent) Setter for property firstLineIndent.- Parameters:
firstLineIndent
- New value of property firstLineIndent.
-
setSpacingBefore
public void setSpacingBefore(float spacing) Description copied from interface:Spaceable
Sets the spacing before.- Specified by:
setSpacingBefore
in interfaceSpaceable
- Parameters:
spacing
- the new spacing
-
setSpacingAfter
public void setSpacingAfter(float spacing) Description copied from interface:Spaceable
Sets the spacing after.- Specified by:
setSpacingAfter
in interfaceSpaceable
- Parameters:
spacing
- the new spacing
-
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
-
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.
-
getAlignment
public int getAlignment()Gets the alignment of this paragraph.- Returns:
- alignment
-
getIndentationLeft
public float getIndentationLeft()Description copied from interface:Indentable
Gets the indentation on the left side.- Specified by:
getIndentationLeft
in interfaceIndentable
- Returns:
- the indentation
-
getIndentationRight
public float getIndentationRight()Description copied from interface:Indentable
Gets the indentation on the right side.- Specified by:
getIndentationRight
in interfaceIndentable
- Returns:
- the indentation
-
getFirstLineIndent
public float getFirstLineIndent()Getter for property firstLineIndent.- Returns:
- Value of property firstLineIndent.
-
getSpacingBefore
public float getSpacingBefore()Description copied from interface:Spaceable
Gets the spacing before.- Specified by:
getSpacingBefore
in interfaceSpaceable
- Returns:
- the spacing
-
getSpacingAfter
public float getSpacingAfter()Description copied from interface:Spaceable
Gets the spacing after.- Specified by:
getSpacingAfter
in interfaceSpaceable
- Returns:
- the spacing
-
getExtraParagraphSpace
public float getExtraParagraphSpace()Getter for property extraParagraphSpace.- Returns:
- Value of property extraParagraphSpace.
-
setExtraParagraphSpace
public void setExtraParagraphSpace(float extraParagraphSpace) Setter for property extraParagraphSpace.- Parameters:
extraParagraphSpace
- New value of property extraParagraphSpace.
-
spacingBefore
Deprecated.As of iText 2.1.5, replaced bygetSpacingBefore()
, scheduled for removal at 2.3.0Gets the spacing before this paragraph.- Returns:
- the spacing
-
spacingAfter
Deprecated.As of iText 2.1.5, replaced bygetSpacingAfter()
, scheduled for removal at 2.3.0Gets the spacing after this paragraph.- Returns:
- the spacing
-
getAccessibleAttribute
Description copied from interface:IAccessibleElement
Get the attribute of accessible element (everything inA
dictionary +Lang
,Alt
,ActualText
,E
).- Specified by:
getAccessibleAttribute
in interfaceIAccessibleElement
- Parameters:
key
-- Returns:
-
setAccessibleAttribute
Description copied from interface:IAccessibleElement
Set the attribute of accessible element (everything inA
dictionary +Lang
,Alt
,ActualText
,E
).- Specified by:
setAccessibleAttribute
in interfaceIAccessibleElement
- Parameters:
key
-value
-
-
getAccessibleAttributes
Description copied from interface:IAccessibleElement
Gets all the properties of accessible element.- Specified by:
getAccessibleAttributes
in interfaceIAccessibleElement
- Returns:
-
getRole
Description copied from interface:IAccessibleElement
Gets the role of the accessible element.- Specified by:
getRole
in interfaceIAccessibleElement
- Returns:
-
setRole
Description copied from interface:IAccessibleElement
Sets the role of the accessiblee element. Set role tonull
if you don't want to tag this element. Note that all child elements won't also be tagged.- Specified by:
setRole
in interfaceIAccessibleElement
- Parameters:
role
-
-
getId
- Specified by:
getId
in interfaceIAccessibleElement
-
setId
- Specified by:
setId
in interfaceIAccessibleElement
-
isInline
public boolean isInline()- Specified by:
isInline
in interfaceIAccessibleElement
-
getPaddingTop
public float getPaddingTop()- Specified by:
getPaddingTop
in interfaceSpaceable
-
setPaddingTop
public void setPaddingTop(float paddingTop) - Specified by:
setPaddingTop
in interfaceSpaceable
-
getSpacingAfter()
, scheduled for removal at 2.3.0