Class Paragraph

java.lang.Object

com.itextpdf.commons.actions.sequence.AbstractIdentifiableElement

com.itextpdf.layout.ElementPropertyContainer<Paragraph>

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

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

com.itextpdf.layout.element.Paragraph

All Implemented Interfaces:

IAbstractElement, IBlockElement, IElement, IPropertyContainer, IAccessibleElement

Direct Known Subclasses:

AnonymousInlineBox

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	Description
protected DefaultAccessibilityProperties	tagProperties

Fields inherited from class AbstractElement

childElements, nextRenderer, styles

Fields inherited from class ElementPropertyContainer

properties

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Paragraph	add(IBlockElement element)	Adds an element to this Paragraph.
Paragraph	add(ILeafElement element)	Adds a element to this Paragraph.
Paragraph	add(String text)	Adds a piece of text to this Paragraph.
<T2 extends ILeafElement> Paragraph	addAll(List<T2> elements)	Adds a List of layout elements to this Paragraph.
Paragraph	addTabStops(TabStop... tabStops)	Adds an unspecified amount of tabstop elements as properties to this Paragraph.
Paragraph	addTabStops(List<TabStop> tabStops)	Adds a List of tabstop elements as properties to this Paragraph.
private void	addTabStopsAsProperty(List<TabStop> newTabStops)
AccessibilityProperties	getAccessibilityProperties()	Gets the accessibility properties.
<T1> T1	getDefaultProperty(int property)	Gets the default property from this entity.
protected IRenderer	makeNewRenderer()	Creates a new renderer instance.
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.
Paragraph	setOrphansControl(ParagraphOrphansControl orphansControl)	Sets orphans restriction on a Paragraph.
Paragraph	setWidowsControl(ParagraphWidowsControl widowsControl)	Sets widows restriction on a Paragraph.

Methods inherited from class BlockElement

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

Methods inherited from class AbstractElement

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

Methods inherited from class ElementPropertyContainer

deleteOwnProperty, getOwnProperty, getSplitCharacters, getStrokeColor, getStrokeWidth, getTextRenderingMode, getTransparentStrokeColor, hasOwnProperty, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundImage, setBackgroundImage, setBaseDirection, setBorder, setBorderBottom, setBorderBottomLeftRadius, setBorderBottomRightRadius, setBorderLeft, setBorderRadius, setBorderRight, setBorderTop, setBorderTopLeftRadius, setBorderTopRightRadius, setCharacterSpacing, setDashPattern, setDestination, setFixedPosition, setFixedPosition, setFixedPosition, setFixedPosition, setFont, setFontColor, setFontColor, setFontColor, setFontFamily, setFontFamily, setFontKerning, setFontScript, setFontSize, setHorizontalAlignment, setHyphenation, setLineThrough, setOpacity, setProperty, setRelativePosition, setSplitCharacters, setStrokeColor, setStrokeColor, setStrokeColor, setStrokeWidth, setTextAlignment, setTextRenderingMode, setUnderline, setUnderline, setUnderline, setUnderline, setUnderline, setWordSpacing, simulateBold, simulateItalic

Methods inherited from class Object

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

Methods inherited from interface IAbstractElement

getChildren

Methods inherited from interface IElement

createRendererSubTree, getRenderer, setNextRenderer

Methods inherited from interface IPropertyContainer

deleteOwnProperty, getOwnProperty, getProperty, hasOwnProperty, hasProperty, setProperty

Field Details

tagProperties

protected DefaultAccessibilityProperties tagProperties

Constructor Details

Paragraph

public Paragraph()

Creates a new Paragraph instance.

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 Details

add

public Paragraph add(String text)

Adds a piece of text to this Paragraph.

Parameters:

text - the content to be added, as a String

Returns:

this Paragraph

add

public Paragraph add(ILeafElement element)

Adds a element to this Paragraph.

Parameters:

element - the content to be added, any ILeafElement

Returns:

this Paragraph

add

public Paragraph add(IBlockElement element)

Adds an element to this Paragraph.

Parameters:

element - the content to be added, any IBlockElement

Returns:

this Paragraph

addAll

public <T2 extends ILeafElement> Paragraph addAll(List<T2> elements)

Adds a List of layout elements to this Paragraph.

Type Parameters:

T2 - any ILeafElement

Parameters:

elements - the content to be added

Returns:

this Paragraph

addTabStops

public Paragraph addTabStops(TabStop... tabStops)

Adds an unspecified amount of tabstop elements as properties to this 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 this 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> 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 BlockElement<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

setOrphansControl

public Paragraph setOrphansControl(ParagraphOrphansControl orphansControl)

Sets orphans restriction on a Paragraph.

Parameters:

orphansControl - an instance of ParagraphOrphansControl.

Returns:

this Paragraph instance.

setWidowsControl

public Paragraph setWidowsControl(ParagraphWidowsControl widowsControl)

Sets widows restriction on a Paragraph.

Parameters:

widowsControl - an instance of ParagraphWidowsControl.

Returns:

this Paragraph instance.

setFixedLeading

public Paragraph setFixedLeading(float leading)

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

If for the element RenderingMode.HTML_MODE is enabled, than Property.LINE_HEIGHT property will be set instead of default layout Property.LEADING.

Parameters:

leading - the new leading value

Returns:

this Paragraph

See Also:

• Leading
• LineHeight

setMultipliedLeading

public Paragraph setMultipliedLeading(float leading)

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

If for the element RenderingMode.HTML_MODE is enabled, than Property.LINE_HEIGHT property will be set instead of default layout Property.LEADING.

Parameters:

leading - the new leading value

Returns:

this Paragraph

See Also:

• Leading
• LineHeight

getAccessibilityProperties

public AccessibilityProperties getAccessibilityProperties()

Gets the accessibility properties. See also IAccessibleElement.

Returns:

an interface that allows to specify properties of a tagged element in Tagged PDF.

makeNewRenderer

protected IRenderer makeNewRenderer()

Creates a new renderer instance.

Specified by:

makeNewRenderer in class AbstractElement<Paragraph>

Returns:

new IRenderer

addTabStopsAsProperty

private void addTabStopsAsProperty(List<TabStop> newTabStops)