org.apache.poi.hslf.usermodel
Class HSLFTextParagraph

java.lang.Object
  org.apache.poi.hslf.usermodel.HSLFTextParagraph

All Implemented Interfaces:

java.lang.Iterable<HSLFTextRun>, TextParagraph<HSLFShape,HSLFTextParagraph,HSLFTextRun>

public final class HSLFTextParagraph
extends java.lang.Object
implements TextParagraph<HSLFShape,HSLFTextParagraph,HSLFTextRun>

This class represents a run of text in a powerpoint document. That run could be text on a sheet, or text in a note. It is only a very basic class for now

logger

protected static final POILogger logger

_ruler

protected TextRulerAtom _ruler

_runs

protected final java.util.List<HSLFTextRun> _runs

_parentShape

protected HSLFTextShape _parentShape

addTextRun

public void addTextRun(HSLFTextRun run)

getTextRuns

public java.util.List<HSLFTextRun> getTextRuns()

Description copied from interface: TextParagraph

Fetch the text runs that are contained within this block of text

Specified by:

getTextRuns in interface TextParagraph<HSLFShape,HSLFTextParagraph,HSLFTextRun>

getParagraphStyle

public TextPropCollection getParagraphStyle()

setParagraphStyle

public void setParagraphStyle(TextPropCollection paragraphStyle)

supplySheet

public static void supplySheet(java.util.List<HSLFTextParagraph> paragraphs,
                               HSLFSheet sheet)

Supply the Sheet we belong to, which might have an assigned SlideShow Also passes it on to our child RichTextRuns

getSheet

public HSLFSheet getSheet()

getShapeId

protected int getShapeId()

Returns:

Shape ID

setShapeId

protected void setShapeId(int id)

Parameters:

id - Shape ID

getIndex

protected int getIndex()

Returns:

0-based index of the text run in the SLWT container

setIndex

protected void setIndex(int index)

Sets the index of the paragraph in the SLWT container

Parameters:

index -

getRunType

public int getRunType()

Returns the type of the text, from the TextHeaderAtom. Possible values can be seen from TextHeaderAtom

See Also:

TextHeaderAtom

setRunType

public void setRunType(int runType)

isDrawingBased

public boolean isDrawingBased()

Is this Text Run one from a PPDrawing, or is it one from the SlideListWithText?

getTextRuler

public TextRulerAtom getTextRuler()

createTextRuler

public TextRulerAtom createTextRuler()

getRecords

public Record[] getRecords()

Returns records that make up the list of text paragraphs (there can be misc InteractiveInfo, TxInteractiveInfo and other records)

Returns:

text run records

setStyleTextProp9Atom

public void setStyleTextProp9Atom(StyleTextProp9Atom styleTextProp9Atom)

Numbered List info

getStyleTextProp9Atom

public StyleTextProp9Atom getStyleTextProp9Atom()

Numbered List info

iterator

public java.util.Iterator<HSLFTextRun> iterator()

Specified by:

iterator in interface java.lang.Iterable<HSLFTextRun>

getLeftMargin

public java.lang.Double getLeftMargin()

Specified by:

getLeftMargin in interface TextParagraph<HSLFShape,HSLFTextParagraph,HSLFTextRun>

Returns:

the left margin (in points) of the paragraph or null, if unset

setLeftMargin

public void setLeftMargin(java.lang.Double leftMargin)

Description copied from interface: TextParagraph

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.

Specified by:

setLeftMargin in interface TextParagraph<HSLFShape,HSLFTextParagraph,HSLFTextRun>

Parameters:

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

getRightMargin

public java.lang.Double getRightMargin()

Description copied from interface: TextParagraph

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.

Specified by:

getRightMargin in interface TextParagraph<HSLFShape,HSLFTextParagraph,HSLFTextRun>

Returns:

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

setRightMargin

public void setRightMargin(java.lang.Double rightMargin)

Specified by:

setRightMargin in interface TextParagraph<HSLFShape,HSLFTextParagraph,HSLFTextRun>

Parameters:

rightMargin - the right margin (in points) of the paragraph

getIndent

public java.lang.Double getIndent()

Specified by:

getIndent in interface TextParagraph<HSLFShape,HSLFTextParagraph,HSLFTextRun>

Returns:

the indent (in points) applied to the first line of text in the paragraph. or null, if unset

setIndent

public void setIndent(java.lang.Double indent)

Description copied from interface: TextParagraph

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

Specified by:

setIndent in interface TextParagraph<HSLFShape,HSLFTextParagraph,HSLFTextRun>

Parameters:

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

getDefaultFontFamily

public java.lang.String getDefaultFontFamily()

Specified by:

getDefaultFontFamily in interface TextParagraph<HSLFShape,HSLFTextParagraph,HSLFTextRun>

getDefaultFontSize

public java.lang.Double getDefaultFontSize()

Specified by:

getDefaultFontSize in interface TextParagraph<HSLFShape,HSLFTextParagraph,HSLFTextRun>

Returns:

the default font size, in case its not set in the textrun or null, if unset

setTextAlign

public void setTextAlign(TextParagraph.TextAlign align)

Description copied from interface: TextParagraph

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

Specified by:

setTextAlign in interface TextParagraph<HSLFShape,HSLFTextParagraph,HSLFTextRun>

Parameters:

align - text align

getTextAlign

public TextParagraph.TextAlign getTextAlign()

Description copied from interface: TextParagraph

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

Specified by:

getTextAlign in interface TextParagraph<HSLFShape,HSLFTextParagraph,HSLFTextRun>

Returns:

alignment that is applied to the paragraph

getFontAlign

public TextParagraph.FontAlign getFontAlign()

Description copied from interface: TextParagraph

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 TextParagraph.FontAlign.AUTO

Specified by:

getFontAlign in interface TextParagraph<HSLFShape,HSLFTextParagraph,HSLFTextRun>

Returns:

alignment that is applied to the paragraph

getAutoNumberingScheme

public AutoNumberingScheme getAutoNumberingScheme()

getAutoNumberingStartAt

public java.lang.Integer getAutoNumberingStartAt()

getBulletStyle

public TextParagraph.BulletStyle getBulletStyle()

Specified by:

getBulletStyle in interface TextParagraph<HSLFShape,HSLFTextParagraph,HSLFTextRun>

Returns:

the bullet style of the paragraph, if null then no bullets are used

setBulletStyle

public void setBulletStyle(java.lang.Object... styles)

Description copied from interface: TextParagraph

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

Specified by:

setBulletStyle in interface TextParagraph<HSLFShape,HSLFTextParagraph,HSLFTextRun>

getParentShape

public HSLFTextShape getParentShape()

Specified by:

getParentShape in interface TextParagraph<HSLFShape,HSLFTextParagraph,HSLFTextRun>

setParentShape

public void setParentShape(HSLFTextShape parentShape)

getIndentLevel

public int getIndentLevel()

Specified by:

getIndentLevel in interface TextParagraph<HSLFShape,HSLFTextParagraph,HSLFTextRun>

Returns:

the text level of this paragraph (0-based). Default is 0.

setIndentLevel

public void setIndentLevel(int level)

Description copied from interface: TextParagraph

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.

Specified by:

setIndentLevel in interface TextParagraph<HSLFShape,HSLFTextParagraph,HSLFTextRun>

Parameters:

level - the level (0 ... 4)

setBullet

public void setBullet(boolean flag)

Sets whether this rich text run has bullets

isBullet

public boolean isBullet()

Returns whether this rich text run has bullets

setBulletChar

public void setBulletChar(java.lang.Character c)

Sets the bullet character

getBulletChar

public java.lang.Character getBulletChar()

Returns the bullet character

setBulletSize

public void setBulletSize(java.lang.Double size)

Sets the bullet size

getBulletSize

public java.lang.Double getBulletSize()

Returns the bullet size, null if unset

setBulletColor

public void setBulletColor(java.awt.Color color)

Sets the bullet color

getBulletColor

public java.awt.Color getBulletColor()

Returns the bullet color

setBulletFont

public void setBulletFont(java.lang.String typeface)

Sets the bullet font

getBulletFont

public java.lang.String getBulletFont()

Returns the bullet font

setLineSpacing

public void setLineSpacing(java.lang.Double lineSpacing)

Description copied from interface: TextParagraph

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

Specified by:

setLineSpacing in interface TextParagraph<HSLFShape,HSLFTextParagraph,HSLFTextRun>

Parameters:

lineSpacing - the vertical line spacing

getLineSpacing

public java.lang.Double getLineSpacing()

Description copied from interface: TextParagraph

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

Specified by:

getLineSpacing in interface TextParagraph<HSLFShape,HSLFTextParagraph,HSLFTextRun>

Returns:

the vertical line spacing or null, if unset

setSpaceBefore

public void setSpaceBefore(java.lang.Double spaceBefore)

Description copied from interface: TextParagraph

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

Specified by:

setSpaceBefore in interface TextParagraph<HSLFShape,HSLFTextParagraph,HSLFTextRun>

Parameters:

spaceBefore - the vertical white space before the paragraph, null to unset

getSpaceBefore

public java.lang.Double getSpaceBefore()

Description copied from interface: TextParagraph

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

Specified by:

getSpaceBefore in interface TextParagraph<HSLFShape,HSLFTextParagraph,HSLFTextRun>

Returns:

the vertical white space before the paragraph, or null if unset

setSpaceAfter

public void setSpaceAfter(java.lang.Double spaceAfter)

Description copied from interface: TextParagraph

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

Specified by:

setSpaceAfter in interface TextParagraph<HSLFShape,HSLFTextParagraph,HSLFTextRun>

Parameters:

spaceAfter - the vertical white space after the paragraph, null to unset

getSpaceAfter

public java.lang.Double getSpaceAfter()

Description copied from interface: TextParagraph

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

Specified by:

getSpaceAfter in interface TextParagraph<HSLFShape,HSLFTextParagraph,HSLFTextRun>

Returns:

the vertical white space after the paragraph or null, if unset

getDefaultTabSize

public java.lang.Double getDefaultTabSize()

Specified by:

getDefaultTabSize in interface TextParagraph<HSLFShape,HSLFTextParagraph,HSLFTextRun>

Returns:

the default size for a tab character within this paragraph in points, null if unset

getPropVal

protected TextProp getPropVal(TextPropCollection props,
                              TextPropCollection masterProps,
                              java.lang.String propName)

Fetch the value of the given Paragraph related TextProp. Returns null if that TextProp isn't present. If the TextProp isn't present, the value from the appropriate Master Sheet will apply. The propName can be a comma-separated list, in case multiple equivalent values are queried

setPropVal

protected void setPropVal(TextPropCollection props,
                          TextPropCollection masterProps,
                          java.lang.String name,
                          java.lang.Integer val)

Returns the named TextProp, either by fetching it (if it exists) or adding it (if it didn't)

Parameters:

props - the TextPropCollection to fetch from / add into

name - the name of the TextProp to fetch/add

val - the value, null if unset

fixLineEndings

protected static void fixLineEndings(java.util.List<HSLFTextParagraph> paragraphs)

Check and add linebreaks to text runs leading other paragraphs

Parameters:

paragraphs -

storeText

protected static void storeText(java.util.List<HSLFTextParagraph> paragraphs)

Saves the modified paragraphs/textrun to the records. Also updates the styles to the correct text length.

appendText

protected static HSLFTextRun appendText(java.util.List<HSLFTextParagraph> paragraphs,
                                        java.lang.String text,
                                        boolean newParagraph)

Adds the supplied text onto the end of the TextParagraphs, creating a new RichTextRun for it to sit in.

Parameters:

text - the text string used by this object.

setText

public static HSLFTextRun setText(java.util.List<HSLFTextParagraph> paragraphs,
                                  java.lang.String text)

Sets (overwrites) the current text. Uses the properties of the first paragraph / textrun

Parameters:

text - the text string used by this object.

getText

public static java.lang.String getText(java.util.List<HSLFTextParagraph> paragraphs)

getRawText

public static java.lang.String getRawText(java.util.List<HSLFTextParagraph> paragraphs)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toInternalString

protected static java.lang.String toInternalString(java.lang.String s)

Returns a new string with line breaks converted into internal ppt representation

toExternalString

public static java.lang.String toExternalString(java.lang.String rawText,
                                                int runType)

Converts raw text from the text paragraphs to a formatted string, i.e. it converts certain control characters used in the raw txt

Parameters:

rawText - the raw text

runType - the run type of the shape, paragraph or headerAtom. use -1 if unknown

Returns:

the formatted string

findTextParagraphs

public static java.util.List<java.util.List<HSLFTextParagraph>> findTextParagraphs(PPDrawing ppdrawing,
                                                                                   HSLFSheet sheet)

For a given PPDrawing, grab all the TextRuns

findTextParagraphs

protected static java.util.List<HSLFTextParagraph> findTextParagraphs(EscherTextboxWrapper wrapper,
                                                                      HSLFSheet sheet)

Scans through the supplied record array, looking for a TextHeaderAtom followed by one of a TextBytesAtom or a TextCharsAtom. Builds up TextRuns from these

Parameters:

wrapper - an EscherTextboxWrapper

findTextParagraphs

protected static java.util.List<java.util.List<HSLFTextParagraph>> findTextParagraphs(Record[] records)

Scans through the supplied record array, looking for a TextHeaderAtom followed by one of a TextBytesAtom or a TextCharsAtom. Builds up TextRuns from these

Parameters:

records - the records to build from

applyHyperlinks

protected static void applyHyperlinks(java.util.List<HSLFTextParagraph> paragraphs)

applyCharacterStyles

protected static void applyCharacterStyles(java.util.List<HSLFTextParagraph> paragraphs,
                                           java.util.List<TextPropCollection> charStyles)

applyParagraphStyles

protected static void applyParagraphStyles(java.util.List<HSLFTextParagraph> paragraphs,
                                           java.util.List<TextPropCollection> paraStyles)

applyParagraphIndents

protected static void applyParagraphIndents(java.util.List<HSLFTextParagraph> paragraphs,
                                            java.util.List<IndentProp> paraStyles)

getTextboxWrapper

public EscherTextboxWrapper getTextboxWrapper()

getColorFromColorIndexStruct

protected static java.awt.Color getColorFromColorIndexStruct(int rgb,
                                                             HSLFSheet sheet)

setParagraphTextPropVal

public void setParagraphTextPropVal(java.lang.String propName,
                                    java.lang.Integer val)

Sets the value of the given Paragraph TextProp, add if required

Parameters:

propName - The name of the Paragraph TextProp

val - The value to set for the TextProp

setDirty

public void setDirty()

marks this paragraph dirty, so its records will be renewed on save

isDirty

public boolean isDirty()

isHeaderOrFooter

public boolean isHeaderOrFooter()

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

Specified by:

isHeaderOrFooter in interface TextParagraph<HSLFShape,HSLFTextParagraph,HSLFTextRun>

Returns:

true if this paragraph is part of a header or footer placeholder

See Also:

RoundTripHFPlaceholder12