com.itextpdf.layout.element

Class Paragraph

java.lang.Object

com.itextpdf.layout.ElementPropertyContainer

com.itextpdf.layout.element.AbstractElement

com.itextpdf.layout.element.BlockElement<Paragraph>

com.itextpdf.layout.element.Paragraph

All Implemented Interfaces:

IAccessibleElement, IBlockElement, IElement, IPropertyContainer

public class Paragraph
extends BlockElement<Paragraph>

A layout element that represents a self-contained block of textual and graphical information. It is a BlockElement which essentially acts as a container for leaf elements.

Field Summary

Fields

Modifier and Type	Field and Description
protected PdfName	role
protected AccessibilityProperties	tagProperties

Fields inherited from class com.itextpdf.layout.element.AbstractElement

childElements, nextRenderer, styles

Fields inherited from class com.itextpdf.layout.ElementPropertyContainer

properties

Constructor Summary

Constructors

Constructor and Description
Paragraph() Creates a Paragraph.
Paragraph(String text) Creates a Paragraph, initialized with a piece of text.
Paragraph(Text text) Creates a Paragraph, initialized with a piece of text.

Method Summary

Modifier and Type	Method and Description
Paragraph	add(ILeafElement element) Adds a layout element to the Paragraph.
Paragraph	add(String text) Adds a piece of text to the Paragraph
ILeafElement> Paragraph	addAll(List elements) Adds a List of layout elements to the Paragraph.
Paragraph	addTabStops(List<TabStop> tabStops) Adds a List of tabstop elements as properties to the Paragraph.
Paragraph	addTabStops(TabStop... tabStops) Adds an unspecified amount of tabstop elements as properties to the Paragraph.
AccessibilityProperties	getAccessibilityProperties() Gets the accessibility properties.
T1	getDefaultProperty(int property) Gets the default property from this entity.
PdfName	getRole() Gets the element's role.
protected IRenderer	makeNewRenderer()
Paragraph	removeTabStop(float tabStopPosition) Removes a tabstop position from the Paragraph, if it is present in the Property.TAB_STOPS property.
Paragraph	setFirstLineIndent(float indent) Sets the indent value for the first line of the Paragraph.
Paragraph	setFixedLeading(float leading) Sets the leading value, using the Leading.FIXED strategy.
Paragraph	setMultipliedLeading(float leading) Sets the leading value, using the Leading.MULTIPLIED strategy.
void	setRole(PdfName role) Sets the element's role.

Methods inherited from class com.itextpdf.layout.element.BlockElement

getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, isKeepTogether, isKeepWithNext, setHeight, setKeepTogether, setKeepWithNext, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMargins, setMarginTop, setMaxHeight, setMinHeight, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddings, setPaddingTop, setRotationAngle, setRotationAngle, setSpacingRatio, setVerticalAlignment

Methods inherited from class com.itextpdf.layout.element.AbstractElement

addStyle, createRendererSubTree, getChildren, getProperty, getRenderer, hasProperty, isEmpty, propagateArtifactRoleToChildElements, setAction, setNextRenderer, setPageNumber

Methods inherited from class com.itextpdf.layout.ElementPropertyContainer

deleteOwnProperty, getHeight, getOwnProperty, getSplitCharacters, getStrokeColor, getStrokeWidth, getTextRenderingMode, getWidth, hasOwnProperty, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBaseDirection, setBold, setBorder, setBorderBottom, setBorderLeft, setBorderRight, setBorderTop, setCharacterSpacing, setDestination, setFixedPosition, setFixedPosition, setFixedPosition, setFixedPosition, setFont, setFont, setFontColor, setFontColor, setFontKerning, setFontScript, setFontSize, setHorizontalAlignment, setHyphenation, setItalic, setLineThrough, setOpacity, setProperty, setRelativePosition, setSplitCharacters, setStrokeColor, setStrokeWidth, setTextAlignment, setTextRenderingMode, setUnderline, setUnderline, setUnderline, setUnderline, setWidth, setWidth, setWidthPercent, setWordSpacing

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.itextpdf.layout.element.IElement

createRendererSubTree, getRenderer, setNextRenderer

Methods inherited from interface com.itextpdf.layout.IPropertyContainer

deleteOwnProperty, getOwnProperty, getProperty, hasOwnProperty, hasProperty, setProperty

Field Detail

role

protected PdfName role

tagProperties

protected AccessibilityProperties tagProperties

Constructor Detail

Paragraph

public Paragraph()

Creates a Paragraph.

Paragraph

public Paragraph(String text)

Creates a Paragraph, initialized with a piece of text.

Parameters:

text - the initial textual content, as a String

Paragraph

public Paragraph(Text text)

Creates a Paragraph, initialized with a piece of text.

Parameters:

text - the initial textual content, as a Text

Method Detail

add

public Paragraph add(String text)

Adds a piece of text to the Paragraph

Parameters:

text - the content to be added, as a String

Returns:

this Paragraph

add

public Paragraph add(ILeafElement element)

Adds a layout element to the Paragraph.

Parameters:

element - the content to be added, any ILeafElement

Returns:

this Paragraph

addAll

public ILeafElement> Paragraph addAll(List elements)

Adds a List of layout elements to the Paragraph.

Parameters:

elements - the content to be added, any ILeafElement

Returns:

this Paragraph

addTabStops

public Paragraph addTabStops(TabStop... tabStops)

Adds an unspecified amount of tabstop elements as properties to the Paragraph.

Parameters:

tabStops - the tabstop(s) to be added as properties

Returns:

this Paragraph

See Also:

TabStop

addTabStops

public Paragraph addTabStops(List<TabStop> tabStops)

Adds a List of tabstop elements as properties to the Paragraph.

Parameters:

tabStops - the list of TabStops to be added as properties

Returns:

this Paragraph

See Also:

TabStop

removeTabStop

public Paragraph removeTabStop(float tabStopPosition)

Removes a tabstop position from the Paragraph, if it is present in the Property.TAB_STOPS property.

Parameters:

tabStopPosition - the TabStop position to be removed.

Returns:

this Paragraph

See Also:

TabStop

getDefaultProperty

public  T1 getDefaultProperty(int property)

Description copied from interface: IPropertyContainer

Gets the default property from this entity.

Specified by:

getDefaultProperty in interface IPropertyContainer

Overrides:

getDefaultProperty in class ElementPropertyContainer<Paragraph>

Type Parameters:

T1 - the return type associated with the property

Parameters:

property - the property to be retrieved

Returns:

the default property value. If the default property is not defined, null will be returned

setFirstLineIndent

public Paragraph setFirstLineIndent(float indent)

Sets the indent value for the first line of the Paragraph.

Parameters:

indent - the indent value that must be applied to the first line of the Paragraph, as a float

Returns:

this Paragraph

setFixedLeading

public Paragraph setFixedLeading(float leading)

Sets the leading value, using the Leading.FIXED strategy.

Parameters:

leading - the new leading value

Returns:

this Paragraph

See Also:

Leading

setMultipliedLeading

public Paragraph setMultipliedLeading(float leading)

Sets the leading value, using the Leading.MULTIPLIED strategy.

Parameters:

leading - the new leading value

Returns:

this Paragraph

See Also:

Leading

makeNewRenderer

protected IRenderer makeNewRenderer()

Specified by:

makeNewRenderer in class AbstractElement<Paragraph>

getRole

public PdfName getRole()

Description copied from interface: IAccessibleElement

Gets the element's role.

Returns:

a PdfName containing the name of the role

setRole

public void setRole(PdfName role)

Description copied from interface: IAccessibleElement

Sets the element's role.

Parameters:

role - the new role which the IAccessibleElement should take

getAccessibilityProperties

public AccessibilityProperties getAccessibilityProperties()

Description copied from interface: IAccessibleElement

Gets the accessibility properties.

Returns:

a properties wrapper object specific to a tagged element in Tagged PDF