Modifier and Type	Class and Description
public static interface	TextParagraph.BulletStyle
public static enum	TextParagraph.FontAlign
public static enum	TextParagraph.TextAlign Specifies a list of text alignment types

Method Summary

Modifier and Type	Method and Description
public void	addTabStops(double positionInPoints, TabStop.TabStopType tabStopType) Set the `TabStop` collection
public void	clearTabStops() Removes the tabstops of this paragraphs.
public TextParagraph.BulletStyle	Returns: the bullet style of the paragraph, if `null` then no bullets are used getBulletStyle()
public String	getDefaultFontFamily()
public Double	Returns: the default font size, in case its not set in the textrun or null, if unset getDefaultFontSize()
public Double	Returns: the default size for a tab character within this paragraph in points, null if unset getDefaultTabSize()
public TextParagraph.FontAlign	Returns: alignment that is applied to the paragraph getFontAlign() Returns the font alignment that is applied to the paragraph.
public Double	Returns: the indent (in points) applied to the first line of text in the paragraph. or null, if unset getIndent()
public int	Returns: the text level of this paragraph (0-based). Default is 0. getIndentLevel()
public Double	Returns: the left margin (in points) of the paragraph or null, if unset getLeftMargin()
public Double	Returns: the vertical line spacing or null, if unset getLineSpacing() Returns the vertical line spacing that is to be used within a paragraph.
public TextShape<S, P>	getParentShape()
public Double	Returns: the right margin (in points) of the paragraph or null, if unset getRightMargin() Specifies the right margin of the paragraph.
public Double	Returns: the vertical white space after the paragraph or null, if unset getSpaceAfter() The 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.
public Double	Returns: the vertical white space before the paragraph, or null if unset getSpaceBefore() The 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.
public List<? extends TabStop>	Returns: the tabstop collection or `null` if no tabstops are defined getTabStops() Get the `TabStops` - the list can't be and its entries shouldn't be modified.
public TextParagraph.TextAlign	Returns: alignment that is applied to the paragraph getTextAlign() Returns the alignment that is applied to the paragraph.
public List<T>	getTextRuns() Fetch the text runs that are contained within this block of text
public boolean	Returns: true if this paragraph is part of a header or footer placeholder isHeaderOrFooter() Convenience method to determine if this text paragraph is part of the slide header or footer
public void	setBulletStyle(Object... styles) Sets the bullet styles.
public void	setIndent(Double the indent (in points) applied to the first line of text in the paragraph indent) Specifies the indent size that will be applied to the first line of text in the paragraph.
public void	setIndentLevel(int the level (0 ... 4) level) Specifies the particular level text properties that this paragraph will follow.
public void	setLeftMargin(Double the left margin (in points) or null to unset leftMargin) Specifies the left margin of the paragraph.
public void	setLineSpacing(Double the vertical line spacing lineSpacing) This element specifies the vertical line spacing that is to be used within a paragraph.
public void	setRightMargin(Double the right margin (in points) of the paragraph rightMargin)
public void	setSpaceAfter(Double the vertical white space after the paragraph, null to unset spaceAfter) Set the amount of vertical white space that will be present after the paragraph.
public void	setSpaceBefore(Double the vertical white space before the paragraph, null to unset spaceBefore) Set the amount of vertical white space that will be present before the paragraph.
public void	setTextAlign(TextParagraph.TextAlign text align align) Specifies the alignment that is to be applied to the paragraph.

Inherited from java.lang.Iterable:: forEach iterator spliterator

Method Detail

addTabStops back to summary

addTabStops	back to summary
public void addTabStops(double positionInPoints, TabStop.TabStopType tabStopType) Set the `TabStop` collection Since POI 4.0.0

public void addTabStops(double positionInPoints, TabStop.TabStopType tabStopType)

Set the TabStop collection

Since: POI 4.0.0

clearTabStops	back to summary
public void clearTabStops() Removes the tabstops of this paragraphs. This doesn't affect inherited tabstops, e.g. inherited by the slide master Since POI 4.0.0

clearTabStops

back to summary

public void clearTabStops()

Removes the tabstops of this paragraphs. This doesn't affect inherited tabstops, e.g. inherited by the slide master

Since: POI 4.0.0

getBulletStyle	back to summary
public TextParagraph.BulletStyle getBulletStyle() Returns:TextParagraph.BulletStyle the bullet style of the paragraph, if `null` then no bullets are used

getDefaultFontFamily	back to summary
public String getDefaultFontFamily()

getDefaultFontSize	back to summary
public Double getDefaultFontSize() Returns:Double the default font size, in case its not set in the textrun or null, if unset

getDefaultTabSize	back to summary
public Double getDefaultTabSize() Returns:Double the default size for a tab character within this paragraph in points, null if unset

getFontAlign back to summary

getFontAlign	back to summary
public TextParagraph.FontAlign getFontAlign() Returns 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 of `FontAlign#AUTO` Returns:TextParagraph.FontAlign alignment that is applied to the paragraph

public TextParagraph.FontAlign getFontAlign()

Returns 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 of FontAlign#AUTO

Returns:TextParagraph.FontAlign: alignment that is applied to the paragraph

getIndent	back to summary
public Double getIndent() Returns:Double the indent (in points) applied to the first line of text in the paragraph. or null, if unset

getIndentLevel	back to summary
public int getIndentLevel() Returns:int the text level of this paragraph (0-based). Default is 0.

getLeftMargin	back to summary
public Double getLeftMargin() Returns:Double the left margin (in points) of the paragraph or null, if unset

getLineSpacing	back to summary
public Double getLineSpacing() Returns 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 Returns:Double the vertical line spacing or null, if unset

getLineSpacing

back to summary

public Double getLineSpacing()

Returns 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

Returns:Double: the vertical line spacing or null, if unset

getParentShape	back to summary
public TextShape<S, P> getParentShape()

getRightMargin	back to summary
public Double getRightMargin() Specifies 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. Returns:Double the right margin (in points) of the paragraph or null, if unset

getRightMargin

back to summary

public Double getRightMargin()

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

Returns:Double: the right margin (in points) of the paragraph or null, if unset

getSpaceAfter	back to summary
public Double getSpaceAfter() The 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 Returns:Double the vertical white space after the paragraph or null, if unset

getSpaceAfter

back to summary

public Double getSpaceAfter()

The 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

Returns:Double: the vertical white space after the paragraph or null, if unset

getSpaceBefore	back to summary
public Double getSpaceBefore() The 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 Returns:Double the vertical white space before the paragraph, or null if unset

getSpaceBefore

back to summary

public Double getSpaceBefore()

The 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

Returns:Double: the vertical white space before the paragraph, or null if unset

getTabStops back to summary

getTabStops	back to summary
public List<? extends TabStop> getTabStops() Get the `TabStops` - the list can't be and its 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. Returns:List<? extends TabStop> the tabstop collection or `null` if no tabstops are defined Annotations @SuppressWarnings:java:S1452 Since POI 4.0.0

public List<? extends TabStop> getTabStops()

Get the TabStops - the list can't be and its 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.

Returns:List<? extends TabStop>

the tabstop collection or null if no tabstops are defined

Annotations

@SuppressWarnings:java:S1452

Since

POI 4.0.0

getTextAlign back to summary

getTextAlign	back to summary
public TextParagraph.TextAlign getTextAlign() Returns the alignment that is applied to the paragraph. If this attribute is omitted, then null is returned. User code can imply the value `org.apache.poi.sl.usermodel.TextParagraph.TextAlign#LEFT` then. Returns:TextParagraph.TextAlign alignment that is applied to the paragraph

public TextParagraph.TextAlign getTextAlign()

Returns the alignment that is applied to the paragraph. If this attribute is omitted, then null is returned. User code can imply the value org.apache.poi.sl.usermodel.TextParagraph.TextAlign#LEFT then.

Returns:TextParagraph.TextAlign: alignment that is applied to the paragraph

getTextRuns	back to summary
public List<T> getTextRuns() Fetch the text runs that are contained within this block of text

isHeaderOrFooter	back to summary
public boolean isHeaderOrFooter() Convenience method to determine if this text paragraph is part of the slide header or footer Returns:boolean true if this paragraph is part of a header or footer placeholder Since POI 3.15-beta2

isHeaderOrFooter

back to summary

public boolean isHeaderOrFooter()

Convenience method to determine if this text paragraph is part of the slide header or footer

Returns:boolean: true if this paragraph is part of a header or footer placeholder
Since: POI 3.15-beta2

setBulletStyle	back to summary
public void setBulletStyle(Object... styles) Sets 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

setIndent	back to summary
public void setIndent(Double indent) Specifies the indent size that will be applied to the first line of text in the paragraph. Parameters indent:Double the indent (in points) applied to the first line of text in the paragraph

setIndent

back to summary

public void setIndent(Double indent)

Specifies the indent size that will be applied to the first line of text in the paragraph.

Parameters

indent:Double: the indent (in points) applied to the first line of text in the paragraph

setIndentLevel	back to summary
public void setIndentLevel(int level) Specifies 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. Parameters level:int the level (0 ... 4)

setIndentLevel

back to summary

public void setIndentLevel(int level)

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

Parameters

level:int: the level (0 ... 4)

setLeftMargin	back to summary
public void setLeftMargin(Double leftMargin) Specifies 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. Parameters leftMargin:Double the left margin (in points) or null to unset

setLeftMargin

back to summary

public void setLeftMargin(Double leftMargin)

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

Parameters

leftMargin:Double: the left margin (in points) or null to unset

setLineSpacing back to summary

setLineSpacing	back to summary
public void setLineSpacing(Double lineSpacing) This 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);` Parameters lineSpacing:Double the vertical line spacing

public void setLineSpacing(Double lineSpacing)

This 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);

Parameters

lineSpacing:Double: the vertical line spacing

setRightMargin	back to summary
public void setRightMargin(Double rightMargin) Parameters rightMargin:Double the right margin (in points) of the paragraph

setSpaceAfter back to summary

setSpaceAfter	back to summary
public void setSpaceAfter(Double spaceAfter) Set 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);` Parameters spaceAfter:Double the vertical white space after the paragraph, null to unset

public void setSpaceAfter(Double spaceAfter)

Set 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);

Parameters

spaceAfter:Double: the vertical white space after the paragraph, null to unset

setSpaceBefore back to summary

setSpaceBefore	back to summary
public void setSpaceBefore(Double spaceBefore) Set 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);` Parameters spaceBefore:Double the vertical white space before the paragraph, null to unset

public void setSpaceBefore(Double spaceBefore)

Set 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);

Parameters

spaceBefore:Double: the vertical white space before the paragraph, null to unset

setTextAlign back to summary

setTextAlign	back to summary
public void setTextAlign(TextParagraph.TextAlign align) Specifies the alignment that is to be applied to the paragraph. Possible values for this include left, right, centered, justified and distributed, see `org.apache.poi.sl.usermodel.TextParagraph.TextAlign`. Parameters align:TextParagraph.TextAlign text align

public void setTextAlign(TextParagraph.TextAlign align)

Specifies the alignment that is to be applied to the paragraph. Possible values for this include left, right, centered, justified and distributed, see org.apache.poi.sl.usermodel.TextParagraph.TextAlign.

Parameters

align:TextParagraph.TextAlign: text align

org.apache.poi.sl.usermodel back to summary

public Interface TextParagraph.BulletStyle

Method Summary

Modifier and Type	Method and Description
public AutoNumberingScheme	getAutoNumberingScheme()
public Integer	getAutoNumberingStartAt() Index (1-based) of the first auto number value, or null if auto numbering scheme wasn't assigned.
public String	getBulletCharacter()
public String	getBulletFont()
public PaintStyle	Returns: the color of bullet characters within a given paragraph. A `null` value means to use the text font color. getBulletFontColor()
public Double	Returns: the bullet point font size getBulletFontSize() The bullet point font size If bulletFontSize >= 0, then space is a percentage of normal line height.
public void	setBulletFontColor(Color color) Convenience function to set a solid color
public void	setBulletFontColor(PaintStyle color)

Method Detail

getAutoNumberingScheme	back to summary
public AutoNumberingScheme getAutoNumberingScheme()

getAutoNumberingStartAt	back to summary
public Integer getAutoNumberingStartAt() Index (1-based) of the first auto number value, or null if auto numbering scheme wasn't assigned.

getBulletCharacter	back to summary
public String getBulletCharacter()

getBulletFont	back to summary
public String getBulletFont()

getBulletFontColor	back to summary
public PaintStyle getBulletFontColor() Returns:PaintStyle the color of bullet characters within a given paragraph. A `null` value means to use the text font color.

getBulletFontSize	back to summary
public Double getBulletFontSize() The bullet point font size If bulletFontSize >= 0, then space is a percentage of normal line height. If bulletFontSize < 0, the absolute value in points Returns:Double the bullet point font size

getBulletFontSize

back to summary

public Double getBulletFontSize()

The bullet point font size If bulletFontSize >= 0, then space is a percentage of normal line height. If bulletFontSize < 0, the absolute value in points

Returns:Double: the bullet point font size

setBulletFontColor	back to summary
public void setBulletFontColor(Color color) Convenience function to set a solid color

setBulletFontColor	back to summary
public void setBulletFontColor(PaintStyle color)

org.apache.poi.sl.usermodel back to summary

public final Enum TextParagraph.FontAlign

Class Inheritance

extends Enum<TextParagraph.FontAlign>

java.lang.Object
java.lang.Enum
org.apache.poi.sl.usermodel.TextParagraph.FontAlign

Field Summary

Modifier and Type	Field and Description
public static final TextParagraph.FontAlign	AUTO
public static final TextParagraph.FontAlign	BASELINE Place characters on font baseline.
public static final TextParagraph.FontAlign	BOTTOM Characters are anchored to the very bottom of a single line.
public static final TextParagraph.FontAlign	CENTER Characters centered within line height.
public static final TextParagraph.FontAlign	TOP Characters hang from top of line height.

Constructor Summary

Access	Constructor and Description
private	FontAlign()

Method Summary

Modifier and Type	Method and Description
public static TextParagraph.FontAlign	valueOf(String name)
public static TextParagraph.FontAlign[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

AUTO	back to summary
public static final TextParagraph.FontAlign AUTO

BASELINE	back to summary
public static final TextParagraph.FontAlign BASELINE Place characters on font baseline. Also known as "Roman"

BOTTOM	back to summary
public static final TextParagraph.FontAlign BOTTOM Characters are anchored to the very bottom of a single line. This is different than BASELINE because of letters such as "g", "q", and "y". Also known as "UpholdFixed"

CENTER	back to summary
public static final TextParagraph.FontAlign CENTER Characters centered within line height.

TOP	back to summary
public static final TextParagraph.FontAlign TOP Characters hang from top of line height. Also known as "Hanging"

Constructor Detail

FontAlign	back to summary
private FontAlign()

Method Detail

valueOf	back to summary
public static TextParagraph.FontAlign valueOf(String name)

values	back to summary
public static TextParagraph.FontAlign[] values()

org.apache.poi.sl.usermodel back to summary

public final Enum TextParagraph.TextAlign

Class Inheritance

extends Enum<TextParagraph.TextAlign>

java.lang.Object
java.lang.Enum
org.apache.poi.sl.usermodel.TextParagraph.TextAlign

Specifies a list of text alignment types

Field Summary

Modifier and Type	Field and Description
public static final TextParagraph.TextAlign	CENTER For horizontal text, centered.
public static final TextParagraph.TextAlign	DIST Distribute space between characters.
public static final TextParagraph.TextAlign	JUSTIFY Align text so that it is justified across the whole line.
public static final TextParagraph.TextAlign	JUSTIFY_LOW Kashida justify low.
public static final TextParagraph.TextAlign	LEFT For horizontal text, left aligned.
public static final TextParagraph.TextAlign	RIGHT For horizontal text, right aligned.
public static final TextParagraph.TextAlign	THAI_DIST Thai distribution justification.

Constructor Summary

Access	Constructor and Description
private	TextAlign()

Method Summary

Modifier and Type	Method and Description
public static TextParagraph.TextAlign	valueOf(String name)
public static TextParagraph.TextAlign[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CENTER	back to summary
public static final TextParagraph.TextAlign CENTER For horizontal text, centered. For vertical text, middle aligned.

DIST	back to summary
public static final TextParagraph.TextAlign DIST Distribute space between characters.

JUSTIFY	back to summary
public static final TextParagraph.TextAlign JUSTIFY Align text so that it is justified across the whole line. It is smart in the sense that it will not justify sentences which are short For horizontal text, flush left and right. For vertical text, flush top and bottom.

JUSTIFY_LOW	back to summary
public static final TextParagraph.TextAlign JUSTIFY_LOW Kashida justify low.

LEFT	back to summary
public static final TextParagraph.TextAlign LEFT For horizontal text, left aligned. For vertical text, top aligned.

RIGHT	back to summary
public static final TextParagraph.TextAlign RIGHT For horizontal text, right aligned. For vertical text, bottom aligned.

THAI_DIST	back to summary
public static final TextParagraph.TextAlign THAI_DIST Thai distribution justification.

Constructor Detail

TextAlign	back to summary
private TextAlign()

Method Detail

valueOf	back to summary
public static TextParagraph.TextAlign valueOf(String name)

values	back to summary
public static TextParagraph.TextAlign[] values()

public Interface TextParagraph<S extends Shape<S, P>, P extends TextParagraph<S, P, T>, T extends TextRun>

Nested and Inner Type Summary

Method Summary

Method Detail

public Interface TextParagraph.BulletStyle

Method Summary

Method Detail

public final Enum TextParagraph.FontAlign

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum TextParagraph.TextAlign

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail