XSLFTextParagraph (poi-ooxml 5.5.1 API)

java.lang.Object
- org.apache.poi.xslf.usermodel.XSLFTextParagraph

All Implemented Interfaces:

Iterable<XSLFTextRun>, TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
```
@Beta
public class XSLFTextParagraph
extends Object
implements TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
```
Represents a paragraph of text within the containing text body. The paragraph is the highest level text separation mechanism.

Since:

POI-3.8

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.poi.sl.usermodel.TextParagraph
  TextParagraph.BulletStyle, TextParagraph.FontAlign, TextParagraph.TextAlign

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`XSLFTextRun`	`addLineBreak()` Insert a line break
`XSLFTextRun`	`addNewTextRun()` Add a new run of text
`void`	`addTabStop(double value)`
`void`	`addTabStops(double positionInPoints, TabStop.TabStopType tabStopType)`
`void`	`clearTabStops()`
`AutoNumberingScheme`	`getAutoNumberingScheme()`
`Integer`	`getAutoNumberingStartAt()`
`String`	`getBulletCharacter()`
`String`	`getBulletFont()`
`PaintStyle`	`getBulletFontColor()`
`Double`	`getBulletFontSize()` Returns the bullet size that is to be used within a paragraph.
`TextParagraph.BulletStyle`	`getBulletStyle()`
`String`	`getDefaultFontFamily()`
`Double`	`getDefaultFontSize()`
`org.openxmlformats.schemas.drawingml.x2006.main.CTTextParagraphProperties`	`getDefaultMasterStyle()`
`Double`	`getDefaultTabSize()`
`TextParagraph.FontAlign`	`getFontAlign()`
`Double`	`getIndent()`
`int`	`getIndentLevel()`
`Double`	`getLeftMargin()`
`Double`	`getLineSpacing()`
`XSLFTextShape`	`getParentShape()`
`Double`	`getRightMargin()`
`Double`	`getSpaceAfter()`
`Double`	`getSpaceBefore()`
`double`	`getTabStop(int idx)`
`List<XSLFTabStop>`	`getTabStops()`
`String`	`getText()`
`TextParagraph.TextAlign`	`getTextAlign()`
`List<XSLFTextRun>`	`getTextRuns()`
`org.openxmlformats.schemas.drawingml.x2006.main.CTTextParagraph`	`getXmlObject()`
`boolean`	`isBullet()` Returns whether this paragraph has bullets
`boolean`	`isHeaderOrFooter()`
`Iterator<XSLFTextRun>`	`iterator()`
`protected XSLFTextRun`	`newTextRun(org.openxmlformats.schemas.drawingml.x2006.main.CTTextLineBreak r)`
`protected XSLFTextRun`	`newTextRun(org.apache.xmlbeans.XmlObject r)` Helper method to allow subclasses to provide their own text run
`boolean`	`removeTextRun(XSLFTextRun textRun)` Remove a text run
`void`	`setBullet(boolean flag)`
`void`	`setBulletAutoNumber(AutoNumberingScheme scheme, int startAt)` Specifies that automatic numbered bullet points should be applied to this paragraph
`void`	`setBulletCharacter(String str)`
`void`	`setBulletFont(String typeface)`
`void`	`setBulletFontColor(Color color)`
`void`	`setBulletFontColor(PaintStyle color)` Set the color to be used on bullet characters within a given paragraph.
`void`	`setBulletFontSize(double bulletSize)` Sets the bullet size that is to be used within a paragraph.
`void`	`setBulletStyle(Object... styles)`
`void`	`setFontAlign(TextParagraph.FontAlign align)` Specifies the font alignment that is to be applied to the paragraph.
`void`	`setIndent(Double indent)`
`void`	`setIndentLevel(int level)`
`void`	`setLeftMargin(Double leftMargin)`
`void`	`setLineSpacing(Double lineSpacing)`
`void`	`setRightMargin(Double rightMargin)`
`void`	`setSpaceAfter(Double spaceAfter)`
`void`	`setSpaceBefore(Double spaceBefore)`
`void`	`setTextAlign(TextParagraph.TextAlign align)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - getText
```
public String getText()
```
  - getXmlObject
```
@Internal
public org.openxmlformats.schemas.drawingml.x2006.main.CTTextParagraph getXmlObject()
```
  - getParentShape
```
public XSLFTextShape getParentShape()
```
    Specified by:
    
    getParentShape in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
  - getTextRuns
```
public List<XSLFTextRun> getTextRuns()
```
    Specified by:
    
    getTextRuns in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
  - iterator
```
public Iterator<XSLFTextRun> iterator()
```
    Specified by:
    
    iterator in interface Iterable<XSLFTextRun>
  - addNewTextRun
```
public XSLFTextRun addNewTextRun()
```
    Add a new run of text
    
    Returns:
    
    a new run of text
  - removeTextRun
```
public boolean removeTextRun(XSLFTextRun textRun)
```
    Remove a text run
    
    Parameters:
    
    textRun - a run of text
    
    Returns:
    
    whether the run was removed
    
    Since:
    
    POI 5.2.2
  - addLineBreak
```
public XSLFTextRun addLineBreak()
```
    Insert a line break
    
    Returns:
    
    text run representing this line break ('\n')
  - getTextAlign
```
public TextParagraph.TextAlign getTextAlign()
```
    Specified by:
    
    getTextAlign in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
  - setTextAlign
```
public void setTextAlign(TextParagraph.TextAlign align)
```
    Specified by:
    
    setTextAlign in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
  - getFontAlign
```
public TextParagraph.FontAlign getFontAlign()
```
    Specified by:
    
    getFontAlign in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
  - setFontAlign
```
public void setFontAlign(TextParagraph.FontAlign align)
```
    Specifies the font alignment that is to be applied to the paragraph. Possible values for this include auto, top, center, baseline and bottom. see TextParagraph.FontAlign.
    
    Parameters:
    
    align - font align
  - getBulletFont
```
public String getBulletFont()
```
    Returns:
    
    the font to be used on bullet characters within a given paragraph
  - setBulletFont
```
public void setBulletFont(String typeface)
```
  - getBulletCharacter
```
public String getBulletCharacter()
```
    Returns:
    
    the character to be used in place of the standard bullet point
  - setBulletCharacter
```
public void setBulletCharacter(String str)
```
  - getBulletFontColor
```
public PaintStyle getBulletFontColor()
```
    Returns:
    
    the color of bullet characters within a given paragraph. A null value means to use the text font color.
  - setBulletFontColor
```
public void setBulletFontColor(Color color)
```
  - setBulletFontColor
```
public void setBulletFontColor(PaintStyle color)
```
    Set the color to be used on bullet characters within a given paragraph.
    
    Parameters:
    
    color - the bullet color
  - getBulletFontSize
```
public Double getBulletFontSize()
```
    Returns the bullet size that is to be used within a paragraph. This may be specified in two different ways, percentage spacing and font point spacing:
    If bulletSize >= 0, then bulletSize is a percentage of the font size. If bulletSize < 0, then it specifies the size in points
    
    Returns:
    
    the bullet size
  - setBulletFontSize
```
public void setBulletFontSize(double bulletSize)
```
    Sets the bullet size that is to be used within a paragraph. This may be specified in two different ways, percentage spacing and font point spacing:
    If bulletSize >= 0, then bulletSize is a percentage of the font size. If bulletSize < 0, then it specifies the size in points
  - getAutoNumberingScheme
```
public AutoNumberingScheme getAutoNumberingScheme()
```
    Returns:
    
    the auto numbering scheme, or null if not defined
  - getAutoNumberingStartAt
```
public Integer getAutoNumberingStartAt()
```
    Returns:
    
    the auto numbering starting number, or null if not defined
  - setIndent
```
public void setIndent(Double indent)
```
    Specified by:
    
    setIndent in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
  - getIndent
```
public Double getIndent()
```
    Specified by:
    
    getIndent in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
  - setLeftMargin
```
public void setLeftMargin(Double leftMargin)
```
    Specified by:
    
    setLeftMargin in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
  - getLeftMargin
```
public Double getLeftMargin()
```
    Specified by:
    
    getLeftMargin in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
    
    Returns:
    
    the left margin (in points) of the paragraph, null if unset
  - setRightMargin
```
public void setRightMargin(Double rightMargin)
```
    Specified by:
    
    setRightMargin in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
  - getRightMargin
```
public Double getRightMargin()
```
    Specified by:
    
    getRightMargin in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
    
    Returns:
    
    the right margin of the paragraph, null if unset
  - getDefaultTabSize
```
public Double getDefaultTabSize()
```
    Specified by:
    
    getDefaultTabSize in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
  - getTabStop
```
public double getTabStop(int idx)
```
  - addTabStop
```
public void addTabStop(double value)
```
  - setLineSpacing
```
public void setLineSpacing(Double lineSpacing)
```
    Specified by:
    
    setLineSpacing in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
  - getLineSpacing
```
public Double getLineSpacing()
```
    Specified by:
    
    getLineSpacing in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
  - setSpaceBefore
```
public void setSpaceBefore(Double spaceBefore)
```
    Specified by:
    
    setSpaceBefore in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
  - getSpaceBefore
```
public Double getSpaceBefore()
```
    Specified by:
    
    getSpaceBefore in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
  - setSpaceAfter
```
public void setSpaceAfter(Double spaceAfter)
```
    Specified by:
    
    setSpaceAfter in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
  - getSpaceAfter
```
public Double getSpaceAfter()
```
    Specified by:
    
    getSpaceAfter in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
  - setIndentLevel
```
public void setIndentLevel(int level)
```
    Specified by:
    
    setIndentLevel in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
  - getIndentLevel
```
public int getIndentLevel()
```
    Specified by:
    
    getIndentLevel in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
  - isBullet
```
public boolean isBullet()
```
    Returns whether this paragraph has bullets
  - setBullet
```
public void setBullet(boolean flag)
```
    Parameters:
    
    flag - whether text in this paragraph has bullets
  - setBulletAutoNumber
```
public void setBulletAutoNumber(AutoNumberingScheme scheme,
                                int startAt)
```
    Specifies that automatic numbered bullet points should be applied to this paragraph
    
    Parameters:
    
    scheme - type of auto-numbering
    
    startAt - the number that will start number for a given sequence of automatically numbered bullets (1-based).
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getDefaultMasterStyle
```
@Internal
public org.openxmlformats.schemas.drawingml.x2006.main.CTTextParagraphProperties getDefaultMasterStyle()
```
    Returns:
    
    master style text paragraph properties, or null if there are no master slides or the master slides do not contain a text paragraph
  - getDefaultFontSize
```
public Double getDefaultFontSize()
```
    Specified by:
    
    getDefaultFontSize in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
  - getDefaultFontFamily
```
public String getDefaultFontFamily()
```
    Specified by:
    
    getDefaultFontFamily in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
  - getBulletStyle
```
public TextParagraph.BulletStyle getBulletStyle()
```
    Specified by:
    
    getBulletStyle in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
  - setBulletStyle
```
public void setBulletStyle(Object... styles)
```
    Specified by:
    
    setBulletStyle in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
  - getTabStops
```
public List<XSLFTabStop> getTabStops()
```
    Specified by:
    
    getTabStops in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
  - addTabStops
```
public void addTabStops(double positionInPoints,
                        TabStop.TabStopType tabStopType)
```
    Specified by:
    
    addTabStops in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
  - clearTabStops
```
public void clearTabStops()
```
    Specified by:
    
    clearTabStops in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
  - isHeaderOrFooter
```
public boolean isHeaderOrFooter()
```
    Specified by:
    
    isHeaderOrFooter in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
  - newTextRun
```
protected XSLFTextRun newTextRun(org.apache.xmlbeans.XmlObject r)
```
    Helper method to allow subclasses to provide their own text run
    
    Parameters:
    
    r - the xml reference
    
    Returns:
    
    a new text paragraph
    
    Since:
    
    POI 3.15-beta2
  - newTextRun
```
protected XSLFTextRun newTextRun(org.openxmlformats.schemas.drawingml.x2006.main.CTTextLineBreak r)
```

Class XSLFTextParagraph

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.poi.sl.usermodel.TextParagraph

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Method Detail

getText

getXmlObject

getParentShape

getTextRuns

iterator

addNewTextRun

removeTextRun

addLineBreak

getTextAlign

setTextAlign

getFontAlign

setFontAlign

getBulletFont

setBulletFont

getBulletCharacter

setBulletCharacter

getBulletFontColor

setBulletFontColor

setBulletFontColor

getBulletFontSize

setBulletFontSize

getAutoNumberingScheme

getAutoNumberingStartAt

setIndent

getIndent

setLeftMargin

getLeftMargin

setRightMargin

getRightMargin

getDefaultTabSize

getTabStop

addTabStop

setLineSpacing

getLineSpacing

setSpaceBefore

getSpaceBefore

setSpaceAfter

getSpaceAfter

setIndentLevel

getIndentLevel

isBullet

setBullet

setBulletAutoNumber

toString

getDefaultMasterStyle

getDefaultFontSize

getDefaultFontFamily

getBulletStyle

setBulletStyle

getTabStops

addTabStops

clearTabStops

isHeaderOrFooter

newTextRun

newTextRun