Package com.itextpdf.layout.element

Class AbstractParagraph>

java.lang.Object

com.itextpdf.commons.actions.sequence.AbstractIdentifiableElement

com.itextpdf.layout.ElementPropertyContainer

com.itextpdf.layout.element.AbstractElement

com.itextpdf.layout.element.BlockElement

com.itextpdf.layout.element.AbstractParagraph

Type Parameters:

T - the type of the concrete subclass extending this abstract class

All Implemented Interfaces:

IAbstractElement, IBlockElement, IElement, IPropertyContainer, IAccessibleElement

Direct Known Subclasses:

Paragraph, VerticalParagraph

       public abstract class AbstractParagraph> extends BlockElement
      

An abstract class that represents a paragraph of text in a document. It provides methods for adding text and other elements to the paragraph, as well as managing properties such as leading, indentation, and margins.

Field Summary

Fields

Modifier and Type	Field	Description
protected DefaultAccessibilityProperties	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

Modifier	Constructor	Description
protected	AbstractParagraph()	Creates a new instance of AbstractParagraph.

Method Summary

Modifier and Type	Method	Description
T	add(ILeafElement element)	Adds a ILeafElement element to this AbstractParagraph.
T	add(Paragraph element)	Adds a Paragraph element.
T	add(VerticalParagraph element)	Adds a VerticalParagraph element.
T	add(String text)	Adds a piece of text to this AbstractParagraph.
ILeafElement> T	addAll(List elements)	Adds a List of layout elements to this AbstractParagraph.
protected void	addTabStopsAsProperty(List<TabStop> newTabStops)	Adds a list of TabStop objects to the paragraph's properties.
AccessibilityProperties	getAccessibilityProperties()	Gets the accessibility properties.
T1	getDefaultProperty(int property)	Gets the default property from this entity.
T	setFirstLineIndent(float indent)	Sets the indent value for the first line of the AbstractParagraph.
T	setOrphansControl(ParagraphOrphansControl orphansControl)	Sets orphans restriction on a AbstractParagraph.
T	setWidowsControl(ParagraphWidowsControl widowsControl)	Sets widows restriction on a AbstractParagraph.

Methods inherited from class com.itextpdf.layout.element.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, setTransform, setVerticalAlignment, setWidth, setWidth

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

addStyle, addStyleIfAbsent, createRendererSubTree, getChildren, getProperty, getRenderer, getStyles, hasProperty, isEmpty, makeNewRenderer, setAction, setNextRenderer, setPageNumber

Methods inherited from class com.itextpdf.layout.ElementPropertyContainer

deleteOwnProperty, getLineCapStyle, getLineJoinStyle, getMiterLimit, getOwnProperties, 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, setLineCapStyle, setLineJoinStyle, setLineThrough, setMiterLimit, setOpacity, setProperty, setRelativePosition, setSplitCharacters, setStrokeColor, setStrokeColor, setStrokeColor, setStrokeWidth, setTextAlignment, setTextRenderingMode, setUnderline, setUnderline, setUnderline, setUnderline, setUnderline, setWordSpacing, simulateBold, simulateItalic

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.IAbstractElement

getChildren

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 Details

tagProperties

             protected DefaultAccessibilityProperties tagProperties
            

Constructor Details

AbstractParagraph

             protected AbstractParagraph()
            

Creates a new instance of AbstractParagraph. This constructor is protected to allow subclassing.

Method Details

add

             public T add
             (String text)
            

Adds a piece of text to this AbstractParagraph.

Parameters:

text - the content to be added, as a String

Returns:

this Element

add

             public T add
             (ILeafElement element)
            

Adds a ILeafElement element to this AbstractParagraph.

Parameters:

element - the content to be added, any ILeafElement

Returns:

this Element

add

             public T add
             (Paragraph element)
            

Adds a Paragraph element.

Parameters:

element - the content to be added, any Paragraph

Returns:

this Element

add

             public T add
             (VerticalParagraph element)
            

Adds a VerticalParagraph element.

Parameters:

element - the content to be added, any VerticalParagraph

Returns:

this Element

addAll

             public ILeafElement> T addAll
             (List elements)
            

Adds a List of layout elements to this AbstractParagraph.

Type Parameters:

T2 - any ILeafElement

Parameters:

elements - the content to be added

Returns:

this Element

setFirstLineIndent

             public T setFirstLineIndent
             (float indent)
            

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

Parameters:

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

Returns:

this Element

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 BlockElement<T extends AbstractParagraph<T>>

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

setOrphansControl

             public T setOrphansControl
             (ParagraphOrphansControl orphansControl)
            

Sets orphans restriction on a AbstractParagraph.

Parameters:

orphansControl - an instance of ParagraphOrphansControl

Returns:

this Element

setWidowsControl

             public T setWidowsControl
             (ParagraphWidowsControl widowsControl)
            

Sets widows restriction on a AbstractParagraph.

Parameters:

widowsControl - an instance of ParagraphWidowsControl

Returns:

this Element

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.

addTabStopsAsProperty

             protected void addTabStopsAsProperty
             (List<TabStop> newTabStops)
            

Adds a list of TabStop objects to the paragraph's properties.

Parameters:

newTabStops - the list of TabStop objects to be added