Class XSLFTextParagraph
- All Implemented Interfaces:
Iterable<XSLFTextRun>,TextParagraph<XSLFShape,XSLFTextParagraph, XSLFTextRun>
- 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
Modifier and TypeMethodDescriptionInsert a line breakAdd a new run of textvoidaddTabStop(double value) voidaddTabStops(double positionInPoints, TabStop.TabStopType tabStopType) Set theTabStopcollectionvoidRemoves the tabstops of this paragraphs.Returns the bullet size that is to be used within a paragraph.Returns the font alignment that is applied to the paragraph.intReturns the vertical line spacing that is to be used within a paragraph.Specifies the right margin of the paragraph.The amount of vertical white space after the paragraph This may be specified in two different ways, percentage spacing and font point spacing:The amount of vertical white space before the paragraph This may be specified in two different ways, percentage spacing and font point spacing:doublegetTabStop(int idx) Get theTabStops- the list can't be and it's entries shouldn't be modified.getText()Returns the alignment that is applied to the paragraph.Fetch the text runs that are contained within this block of textorg.openxmlformats.schemas.drawingml.x2006.main.CTTextParagraphbooleanisBullet()Returns whether this paragraph has bulletsbooleanConvenience method to determine if this text paragraph is part of the slide header or footeriterator()protected XSLFTextRunnewTextRun(org.apache.xmlbeans.XmlObject r) Helper method to allow subclasses to provide their own text runprotected XSLFTextRunnewTextRun(org.openxmlformats.schemas.drawingml.x2006.main.CTTextLineBreak r) voidsetBullet(boolean flag) voidsetBulletAutoNumber(AutoNumberingScheme scheme, int startAt) Specifies that automatic numbered bullet points should be applied to this paragraphvoidsetBulletCharacter(String str) voidsetBulletFont(String typeface) voidsetBulletFontColor(Color color) voidsetBulletFontColor(PaintStyle color) Set the color to be used on bullet characters within a given paragraph.voidsetBulletFontSize(double bulletSize) Sets the bullet size that is to be used within a paragraph.voidsetBulletStyle(Object... styles) Sets the bullet styles.voidSpecifies the font alignment that is to be applied to the paragraph.voidSpecifies the indent size that will be applied to the first line of text in the paragraph.voidsetIndentLevel(int level) Specifies the particular level text properties that this paragraph will follow.voidsetLeftMargin(Double leftMargin) Specifies the left margin of the paragraph.voidsetLineSpacing(Double lineSpacing) This element specifies the vertical line spacing that is to be used within a paragraph.voidsetRightMargin(Double rightMargin) voidsetSpaceAfter(Double spaceAfter) Set the amount of vertical white space that will be present after the paragraph.voidsetSpaceBefore(Double spaceBefore) Set the amount of vertical white space that will be present before the paragraph.voidSpecifies the alignment that is to be applied to the paragraph.toString()Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface java.lang.Iterable
forEach, spliterator
-
Method Details
-
getText
-
getXmlObject
-
getParentShape
- Specified by:
getParentShapein interfaceTextParagraph<XSLFShape,XSLFTextParagraph, XSLFTextRun>
-
getTextRuns
Description copied from interface:TextParagraphFetch the text runs that are contained within this block of text- Specified by:
getTextRunsin interfaceTextParagraph<XSLFShape,XSLFTextParagraph, XSLFTextRun>
-
iterator
- Specified by:
iteratorin interfaceIterable<XSLFTextRun>
-
addNewTextRun
Add a new run of text- Returns:
- a new run of text
-
addLineBreak
Insert a line break- Returns:
- text run representing this line break ('\n')
-
getTextAlign
Description copied from interface:TextParagraphReturns the alignment that is applied to the paragraph. If this attribute is omitted, then null is returned. User code can imply the valueTextParagraph.TextAlign.LEFTthen.- Specified by:
getTextAlignin interfaceTextParagraph<XSLFShape,XSLFTextParagraph, XSLFTextRun> - Returns:
- alignment that is applied to the paragraph
-
setTextAlign
Description copied from interface:TextParagraphSpecifies the alignment that is to be applied to the paragraph. Possible values for this include left, right, centered, justified and distributed, seeTextParagraph.TextAlign.- Specified by:
setTextAlignin interfaceTextParagraph<XSLFShape,XSLFTextParagraph, XSLFTextRun> - Parameters:
align- text align
-
getFontAlign
Description copied from interface:TextParagraphReturns the font alignment that is applied to the paragraph. If this attribute is omitted, then null is return, user code can imply the a value ofTextParagraph.FontAlign.AUTO- Specified by:
getFontAlignin interfaceTextParagraph<XSLFShape,XSLFTextParagraph, XSLFTextRun> - Returns:
- alignment that is applied to the paragraph
-
setFontAlign
Specifies the font alignment that is to be applied to the paragraph. Possible values for this include auto, top, center, baseline and bottom. seeTextParagraph.FontAlign.- Parameters:
align- font align
-
getBulletFont
- Returns:
- the font to be used on bullet characters within a given paragraph
-
setBulletFont
-
getBulletCharacter
- Returns:
- the character to be used in place of the standard bullet point
-
setBulletCharacter
-
getBulletFontColor
- Returns:
- the color of bullet characters within a given paragraph.
A
nullvalue means to use the text font color.
-
setBulletFontColor
-
setBulletFontColor
Set the color to be used on bullet characters within a given paragraph.- Parameters:
color- the bullet color
-
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
- Returns:
- the auto numbering scheme, or null if not defined
-
getAutoNumberingStartAt
- Returns:
- the auto numbering starting number, or null if not defined
-
setIndent
Description copied from interface:TextParagraphSpecifies the indent size that will be applied to the first line of text in the paragraph.- Specified by:
setIndentin interfaceTextParagraph<XSLFShape,XSLFTextParagraph, XSLFTextRun> - Parameters:
indent- the indent (in points) applied to the first line of text in the paragraph
-
getIndent
- Specified by:
getIndentin interfaceTextParagraph<XSLFShape,XSLFTextParagraph, XSLFTextRun> - Returns:
- the indent (in points) applied to the first line of text in the paragraph. or null, if unset
-
setLeftMargin
Description copied from interface:TextParagraphSpecifies the left margin of the paragraph. This is specified in addition to the text body inset and applies only to this text paragraph. That is the text body Inset and the LeftMargin attributes are additive with respect to the text position.- Specified by:
setLeftMarginin interfaceTextParagraph<XSLFShape,XSLFTextParagraph, XSLFTextRun> - Parameters:
leftMargin- the left margin (in points) or null to unset
-
getLeftMargin
- Specified by:
getLeftMarginin interfaceTextParagraph<XSLFShape,XSLFTextParagraph, XSLFTextRun> - Returns:
- the left margin (in points) of the paragraph, null if unset
-
setRightMargin
- Specified by:
setRightMarginin interfaceTextParagraph<XSLFShape,XSLFTextParagraph, XSLFTextRun> - Parameters:
rightMargin- the right margin (in points) of the paragraph
-
getRightMargin
Description copied from interface:TextParagraphSpecifies the right margin of the paragraph. This is specified in addition to the text body inset and applies only to this text paragraph. That is the text body Inset and the RightMargin attributes are additive with respect to the text position. The right margin is not support and therefore ignored by the HSLF implementation.- Specified by:
getRightMarginin interfaceTextParagraph<XSLFShape,XSLFTextParagraph, XSLFTextRun> - Returns:
- the right margin of the paragraph, null if unset
-
getDefaultTabSize
- Specified by:
getDefaultTabSizein interfaceTextParagraph<XSLFShape,XSLFTextParagraph, XSLFTextRun> - Returns:
- the default size for a tab character within this paragraph in points, null if unset
-
getTabStop
public double getTabStop(int idx) -
addTabStop
public void addTabStop(double value) -
setLineSpacing
Description copied from interface:TextParagraphThis element specifies the vertical line spacing that is to be used within a paragraph. This may be specified in two different ways, percentage spacing and font point spacing:If linespacing >= 0, then linespacing is a percentage of normal line height If linespacing < 0, the absolute value of linespacing is the spacing in points
Examples:// spacing will be 120% of the size of the largest text on each line paragraph.setLineSpacing(120); // spacing will be 200% of the size of the largest text on each line paragraph.setLineSpacing(200); // spacing will be 48 points paragraph.setLineSpacing(-48.0);- Specified by:
setLineSpacingin interfaceTextParagraph<XSLFShape,XSLFTextParagraph, XSLFTextRun> - Parameters:
lineSpacing- the vertical line spacing
-
getLineSpacing
Description copied from interface:TextParagraphReturns the vertical line spacing that is to be used within a paragraph. This may be specified in two different ways, percentage spacing and font point spacing:If linespacing >= 0, then linespacing is a percentage of normal line height. If linespacing < 0, the absolute value of linespacing is the spacing in points
- Specified by:
getLineSpacingin interfaceTextParagraph<XSLFShape,XSLFTextParagraph, XSLFTextRun> - Returns:
- the vertical line spacing or null, if unset
-
setSpaceBefore
Description copied from interface:TextParagraphSet the amount of vertical white space that will be present before the paragraph. This space is specified in either percentage or points:If spaceBefore >= 0, then space is a percentage of normal line height. If spaceBefore < 0, the absolute value of linespacing is the spacing in points
Examples:// The paragraph will be formatted to have a spacing before the paragraph text. // The spacing will be 200% of the size of the largest text on each line paragraph.setSpaceBefore(200); // The spacing will be a size of 48 points paragraph.setSpaceBefore(-48.0);- Specified by:
setSpaceBeforein interfaceTextParagraph<XSLFShape,XSLFTextParagraph, XSLFTextRun> - Parameters:
spaceBefore- the vertical white space before the paragraph, null to unset
-
getSpaceBefore
Description copied from interface:TextParagraphThe amount of vertical white space before the paragraph This may be specified in two different ways, percentage spacing and font point spacing:If spaceBefore >= 0, then space is a percentage of normal line height. If spaceBefore < 0, the absolute value in points
- Specified by:
getSpaceBeforein interfaceTextParagraph<XSLFShape,XSLFTextParagraph, XSLFTextRun> - Returns:
- the vertical white space before the paragraph, or null if unset
-
setSpaceAfter
Description copied from interface:TextParagraphSet the amount of vertical white space that will be present after the paragraph. This space is specified in either percentage or points:If spaceAfter >= 0, then space is a percentage of normal line height. If spaceAfter < 0, the absolute value of linespacing is the spacing in points
Examples:// The paragraph will be formatted to have a spacing after the paragraph text. // The spacing will be 200% of the size of the largest text on each line paragraph.setSpaceAfter(200); // The spacing will be a size of 48 points paragraph.setSpaceAfter(-48.0);- Specified by:
setSpaceAfterin interfaceTextParagraph<XSLFShape,XSLFTextParagraph, XSLFTextRun> - Parameters:
spaceAfter- the vertical white space after the paragraph, null to unset
-
getSpaceAfter
Description copied from interface:TextParagraphThe amount of vertical white space after the paragraph This may be specified in two different ways, percentage spacing and font point spacing:If spaceBefore >= 0, then space is a percentage of normal line height. If spaceBefore < 0, the absolute value of linespacing is the spacing in points
- Specified by:
getSpaceAfterin interfaceTextParagraph<XSLFShape,XSLFTextParagraph, XSLFTextRun> - Returns:
- the vertical white space after the paragraph or null, if unset
-
setIndentLevel
public void setIndentLevel(int level) Description copied from interface:TextParagraphSpecifies the particular level text properties that this paragraph will follow. The value for this attribute formats the text according to the corresponding level paragraph properties defined in the SlideMaster.- Specified by:
setIndentLevelin interfaceTextParagraph<XSLFShape,XSLFTextParagraph, XSLFTextRun> - Parameters:
level- the level (0 ... 4)
-
getIndentLevel
public int getIndentLevel()- Specified by:
getIndentLevelin interfaceTextParagraph<XSLFShape,XSLFTextParagraph, XSLFTextRun> - Returns:
- the text level of this paragraph (0-based). Default is 0.
-
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
Specifies that automatic numbered bullet points should be applied to this paragraph- Parameters:
scheme- type of auto-numberingstartAt- the number that will start number for a given sequence of automatically numbered bullets (1-based).
-
toString
-
getDefaultFontSize
- Specified by:
getDefaultFontSizein interfaceTextParagraph<XSLFShape,XSLFTextParagraph, XSLFTextRun> - Returns:
- the default font size, in case its not set in the textrun or null, if unset
-
getDefaultFontFamily
- Specified by:
getDefaultFontFamilyin interfaceTextParagraph<XSLFShape,XSLFTextParagraph, XSLFTextRun>
-
getBulletStyle
- Specified by:
getBulletStylein interfaceTextParagraph<XSLFShape,XSLFTextParagraph, XSLFTextRun> - Returns:
- the bullet style of the paragraph, if
nullthen no bullets are used
-
setBulletStyle
Description copied from interface:TextParagraphSets the bullet styles. If no styles are given, the bullets are omitted. Possible attributes are integer/double (bullet size), Color (bullet color), character (bullet character), string (bullet font), AutoNumberingScheme- Specified by:
setBulletStylein interfaceTextParagraph<XSLFShape,XSLFTextParagraph, XSLFTextRun>
-
getTabStops
Description copied from interface:TextParagraphGet theTabStops- the list can't be and it's entries shouldn't be modified. Opposed to other properties, this method is not cascading to the master sheet, if the property is not defined on the normal slide level, i.e. the tabstops on different levels aren't merged.- Specified by:
getTabStopsin interfaceTextParagraph<XSLFShape,XSLFTextParagraph, XSLFTextRun> - Returns:
- the tabstop collection or
nullif no tabstops are defined
-
addTabStops
Description copied from interface:TextParagraphSet theTabStopcollection- Specified by:
addTabStopsin interfaceTextParagraph<XSLFShape,XSLFTextParagraph, XSLFTextRun>
-
clearTabStops
public void clearTabStops()Description copied from interface:TextParagraphRemoves the tabstops of this paragraphs. This doesn't affect inherited tabstops, e.g. inherited by the slide master- Specified by:
clearTabStopsin interfaceTextParagraph<XSLFShape,XSLFTextParagraph, XSLFTextRun>
-
newTextRun
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
-