org.apache.poi.hslf.usermodel

Class HSLFTextBox

java.lang.Object

org.apache.poi.hslf.usermodel.HSLFShape

org.apache.poi.hslf.usermodel.HSLFSimpleShape

org.apache.poi.hslf.usermodel.HSLFTextShape

org.apache.poi.hslf.usermodel.HSLFTextBox

All Implemented Interfaces:

java.lang.Iterable<HSLFTextParagraph>, IAdjustableShape, AutoShape<HSLFShape,HSLFTextParagraph>, PlaceableShape<HSLFShape,HSLFTextParagraph>, Shape<HSLFShape,HSLFTextParagraph>, SimpleShape<HSLFShape,HSLFTextParagraph>, TextBox<HSLFShape,HSLFTextParagraph>, TextShape<HSLFShape,HSLFTextParagraph>

Direct Known Subclasses:

HSLFPlaceholder, HSLFTableCell

public class HSLFTextBox
extends HSLFTextShape
implements TextBox<HSLFShape,HSLFTextParagraph>

Represents a TextFrame shape in PowerPoint.

Contains the text in a text frame as well as the properties and methods that control alignment and anchoring of the text.

Author:

Yegor Kozlov

Nested Class Summary

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

TextShape.TextAutofit, TextShape.TextDirection, TextShape.TextPlaceholder

Field Summary

Fields inherited from class org.apache.poi.hslf.usermodel.HSLFTextShape

WrapByPoints, WrapNone, WrapSquare, WrapThrough, WrapTopBottom

Fields inherited from class org.apache.poi.hslf.usermodel.HSLFSimpleShape

_hyperlink, DEFAULT_LINE_WIDTH

Constructor Summary

Constructors

Modifier	Constructor and Description
	HSLFTextBox() Create a new TextBox.
protected	HSLFTextBox(EscherContainerRecord escherRecord, ShapeContainer<HSLFShape,HSLFTextParagraph> parent) Create a TextBox object and initialize it from the supplied Record container.
	HSLFTextBox(ShapeContainer<HSLFShape,HSLFTextParagraph> parent) Create a new TextBox.

Method Summary

Modifier and Type	Method and Description
protected EscherContainerRecord	createSpContainer(boolean isChild) Create a new TextBox and initialize its internal structures
protected void	setDefaultTextProperties(HSLFTextParagraph _txtrun) Set default properties for the TextRun.

Methods inherited from class org.apache.poi.hslf.usermodel.HSLFTextShape

afterInsert, appendText, getBottomInset, getEscherTextboxWrapper, getHFPlaceholderAtom, getHyperlinks, getInsets, getLeftInset, getMetroShape, getPlaceholderAtom, getRawText, getRightInset, getRunType, getText, getTextDirection, getTextHeight, getTextHeight, getTextId, getTextParagraphs, getTextPlaceholder, getTextRotation, getTopInset, getVerticalAlignment, getWordWrap, getWordWrapEx, isAlignToBaseline, isHorizontalCentered, isPlaceholder, iterator, resizeToFitText, resizeToFitText, setAlignToBaseline, setBottomInset, setHorizontalCentered, setInsets, setLeftInset, setRightInset, setRunType, setSheet, setText, setTextDirection, setTextId, setTextPlaceholder, setTextRotation, setTopInset, setVerticalAlignment, setWordWrap, setWordWrapEx, storeText

Methods inherited from class org.apache.poi.hslf.usermodel.HSLFSimpleShape

createHyperlink, getAdjustValue, getFillColor, getGeometry, getHyperlink, getLineBackgroundColor, getLineCap, getLineColor, getLineCompound, getLineDash, getLineDecoration, getLineHeadDecoration, getLineHeadLength, getLineHeadWidth, getLineTailDecoration, getLineTailLength, getLineTailWidth, getLineWidth, getPlaceholder, getShadow, getShadowAngle, getShadowColor, getShadowDistance, getStrokeStyle, setFillColor, setHyperlink, setLineBackgroundColor, setLineCap, setLineColor, setLineCompound, setLineDash, setLineHeadDecoration, setLineHeadLength, setLineHeadWidth, setLineTailDecoration, setLineTailLength, setLineTailWidth, setLineWidth, setPlaceholder, setStrokeStyle

Methods inherited from class org.apache.poi.hslf.usermodel.HSLFShape

draw, getAnchor, getClientData, getClientDataRecord, getClientRecords, getEscherChild, getEscherChild, getEscherChild, getEscherChild, getEscherOptRecord, getEscherProperty, getEscherProperty, getEscherProperty, getFill, getFillStyle, getFlipHorizontal, getFlipVertical, getParent, getRotation, getShapeId, getShapeName, getShapeType, getSheet, getSpContainer, moveTo, setAnchor, setEscherProperty, setEscherProperty, setFlipHorizontal, setFlipVertical, setRotation, setShapeId, setShapeType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.poi.sl.usermodel.TextShape

appendText, getInsets, getText, getTextDirection, getTextHeight, getTextHeight, getTextParagraphs, getTextPlaceholder, getTextRotation, getVerticalAlignment, getWordWrap, isHorizontalCentered, resizeToFitText, resizeToFitText, setHorizontalCentered, setInsets, setText, setTextDirection, setTextPlaceholder, setTextRotation, setVerticalAlignment, setWordWrap

Methods inherited from interface org.apache.poi.sl.usermodel.SimpleShape

createHyperlink, getFillColor, getFillStyle, getGeometry, getHyperlink, getLineDecoration, getPlaceholder, getShadow, getShapeType, getStrokeStyle, setFillColor, setPlaceholder, setShapeType, setStrokeStyle

Methods inherited from interface org.apache.poi.sl.usermodel.Shape

draw, getAnchor, getParent, getSheet

Methods inherited from interface org.apache.poi.sl.draw.geom.IAdjustableShape

getAdjustValue

Methods inherited from interface org.apache.poi.sl.usermodel.PlaceableShape

getAnchor, getFlipHorizontal, getFlipVertical, getParent, getRotation, getSheet, setAnchor, setFlipHorizontal, setFlipVertical, setRotation

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Constructor Detail

HSLFTextBox

protected HSLFTextBox(EscherContainerRecord escherRecord,
                      ShapeContainer<HSLFShape,HSLFTextParagraph> parent)

Create a TextBox object and initialize it from the supplied Record container.

Parameters:

escherRecord - EscherSpContainer container which holds information about this shape

parent - the parent of the shape

HSLFTextBox

public HSLFTextBox(ShapeContainer<HSLFShape,HSLFTextParagraph> parent)

Create a new TextBox. This constructor is used when a new shape is created.

Parameters:

parent - the parent of this Shape. For example, if this text box is a cell in a table then the parent is Table.

HSLFTextBox

public HSLFTextBox()

Create a new TextBox. This constructor is used when a new shape is created.

Method Detail

createSpContainer

protected EscherContainerRecord createSpContainer(boolean isChild)

Create a new TextBox and initialize its internal structures

Overrides:

createSpContainer in class HSLFSimpleShape

Parameters:

isChild - true if the Line is inside a group, false otherwise

Returns:

the created EscherContainerRecord which holds shape data

setDefaultTextProperties

protected void setDefaultTextProperties(HSLFTextParagraph _txtrun)

Description copied from class: HSLFTextShape

Set default properties for the TextRun. Depending on the text and shape type the defaults are different: TextBox: align=left, valign=top AutoShape: align=center, valign=middle

Overrides:

setDefaultTextProperties in class HSLFTextShape