public abstract class HSLFTextShape extends HSLFSimpleShape implements TextShape<HSLFShape,HSLFTextParagraph>
TextShape.TextAutofit, TextShape.TextDirection, TextShape.TextPlaceholder| Modifier and Type | Field and Description |
|---|---|
protected static java.awt.font.FontRenderContext |
_frc
Used to calculate text bounds
|
protected java.util.List<HSLFTextParagraph> |
_paragraphs
TextRun object which holds actual text and format data
|
protected EscherTextboxWrapper |
_txtbox
Escher container which holds text attributes such as
TextHeaderAtom, TextBytesAtom ot TextCharsAtom, StyleTextPropAtom etc.
|
static int |
WrapByPoints
Specifies a wrapping rule that is equivalent to that of WrapSquare
Excel 97, Excel 2000, Excel 2002, and Office Excel 2003 use this value.
|
static int |
WrapNone
Specifies that a line of text will extend into or beyond a margin instead
of continuing on subsequent lines.
|
static int |
WrapSquare
Specifies that a line of text will continue on subsequent lines instead
of extending into or beyond a margin.
|
static int |
WrapThrough
Specifies a wrapping rule that is undefined and MUST be ignored.
|
static int |
WrapTopBottom
Specifies a wrapping rule that is undefined and MUST be ignored.
|
_hyperlink, DEFAULT_LINE_WIDTH| Modifier | Constructor and Description |
|---|---|
|
HSLFTextShape()
Create a new TextBox.
|
protected |
HSLFTextShape(EscherContainerRecord escherRecord,
ShapeContainer<HSLFShape,HSLFTextParagraph> parent)
Create a TextBox object and initialize it from the supplied Record container.
|
|
HSLFTextShape(ShapeContainer<HSLFShape,HSLFTextParagraph> parent)
Create a new TextBox.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
afterInsert(HSLFSheet sh)
When a textbox is added to a sheet we need to tell upper-level
PPDrawing about it. |
HSLFTextRun |
appendText(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.
|
double |
getBottomInset()
Returns the distance (in points) between the bottom of the text frame
and the bottom of the inscribed rectangle of the shape that contains the text.
|
protected EscherTextboxWrapper |
getEscherTextboxWrapper() |
RoundTripHFPlaceholder12 |
getHFPlaceholderAtom()
Return
RoundTripHFPlaceholder12, the atom that describes a header/footer placeholder. |
java.util.List<HSLFHyperlink> |
getHyperlinks()
Returns the array of all hyperlinks in this text run
|
Insets2D |
getInsets() |
double |
getLeftInset()
Returns the distance (in points) between the left edge of the text frame
and the left edge of the inscribed rectangle of the shape that contains
the text.
|
TextShape<?,?> |
getMetroShape()
Get alternative representation of text shape stored as metro blob escher property.
|
OEPlaceholderAtom |
getPlaceholderAtom()
Return
OEPlaceholderAtom, the atom that describes a placeholder. |
java.lang.String |
getRawText()
Returns the raw text content of the shape.
|
double |
getRightInset()
Returns the distance (in points) between the right edge of the
text frame and the right edge of the inscribed rectangle of the shape
that contains the text.
|
int |
getRunType()
Returns the type of the text, from the TextHeaderAtom.
|
java.lang.String |
getText()
Returns the text contained in this text frame, which has been made safe
for printing and other use.
|
TextShape.TextDirection |
getTextDirection() |
double |
getTextHeight()
Compute the cumulative height occupied by the text
|
int |
getTextId() |
java.util.List<HSLFTextParagraph> |
getTextParagraphs() |
TextShape.TextPlaceholder |
getTextPlaceholder() |
java.lang.Double |
getTextRotation()
The text rotation can be independent specified from the shape rotation.
|
double |
getTopInset()
Returns the distance (in points) between the top of the text frame
and the top of the inscribed rectangle of the shape that contains the text.
|
VerticalAlignment |
getVerticalAlignment()
Returns the type of vertical alignment for the text.
|
boolean |
getWordWrap() |
int |
getWordWrapEx()
Returns the value indicating word wrap.
|
boolean |
isAlignToBaseline() |
boolean |
isHorizontalCentered()
Returns if the text is centered.
|
boolean |
isPlaceholder() |
java.util.Iterator<HSLFTextParagraph> |
iterator() |
java.awt.geom.Rectangle2D |
resizeToFitText()
Adjust the size of the shape so it encompasses the text inside it.
|
void |
setAlignToBaseline(boolean alignToBaseline)
Sets the vertical alignment relative to the baseline
|
void |
setBottomInset(double margin)
Sets the botom margin.
|
protected void |
setDefaultTextProperties(HSLFTextParagraph _txtrun)
Set default properties for the TextRun.
|
void |
setHorizontalCentered(java.lang.Boolean isCentered)
Sets if the paragraphs are horizontal centered
|
void |
setInsets(Insets2D insets)
Sets the shape margins
|
void |
setLeftInset(double margin)
Sets the left margin.
|
void |
setRightInset(double margin)
Sets the right margin.
|
void |
setRunType(int type)
Changes the type of the text.
|
void |
setSheet(HSLFSheet sheet)
Assign the
SlideShow this shape belongs to |
HSLFTextRun |
setText(java.lang.String text)
Sets (overwrites) the current text.
|
void |
setTextDirection(TextShape.TextDirection orientation)
sets the vertical orientation
|
void |
setTextId(int id)
Sets text ID
|
void |
setTextPlaceholder(TextShape.TextPlaceholder placeholder)
Sets the text placeholder
|
void |
setTextRotation(java.lang.Double rotation)
Sets the text rotation.
|
void |
setTopInset(double margin)
Sets the top margin.
|
void |
setVerticalAlignment(VerticalAlignment vAlign)
Sets the type of vertical alignment for the text.
|
void |
setWordWrap(boolean wrap) |
void |
setWordWrapEx(int wrap)
Specifies how the text should be wrapped
|
protected void |
storeText()
Saves the modified paragraphs/textrun to the records.
|
createHyperlink, createSpContainer, getAdjustValue, getFillColor, getGeometry, getHyperlink, getLineCap, getLineColor, getLineCompound, getLineDash, getLineDecoration, getLineHeadDecoration, getLineHeadLength, getLineHeadWidth, getLineTailDecoration, getLineTailLength, getLineTailWidth, getLineWidth, getPlaceholder, getShadow, getShadowAngle, getShadowColor, getShadowDistance, getStrokeStyle, setFillColor, setHyperlink, setLineCap, setLineColor, setLineCompound, setLineDash, setLineHeadDecoration, setLineHeadLength, setLineHeadWidth, setLineTailDecoration, setLineTailLength, setLineTailWidth, setLineWidth, setPlaceholder, setStrokeStyledraw, 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, setShapeTypeclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcreateHyperlink, getFillColor, getFillStyle, getGeometry, getHyperlink, getLineDecoration, getPlaceholder, getShadow, getShapeType, getStrokeStyle, setFillColor, setPlaceholder, setShapeType, setStrokeStyledraw, getAnchor, getParent, getSheetgetAdjustValuegetAnchor, getFlipHorizontal, getFlipVertical, getParent, getRotation, getSheet, setAnchor, setFlipHorizontal, setFlipVertical, setRotationpublic static final int WrapSquare
public static final int WrapByPoints
public static final int WrapNone
public static final int WrapTopBottom
public static final int WrapThrough
protected java.util.List<HSLFTextParagraph> _paragraphs
protected EscherTextboxWrapper _txtbox
protected static final java.awt.font.FontRenderContext _frc
protected HSLFTextShape(EscherContainerRecord escherRecord, ShapeContainer<HSLFShape,HSLFTextParagraph> parent)
escherRecord - EscherSpContainer container which holds information about this shapeparent - the parent of the shapepublic HSLFTextShape(ShapeContainer<HSLFShape,HSLFTextParagraph> parent)
parent - the parent of this Shape. For example, if this text box is a cell
in a table then the parent is Table.public HSLFTextShape()
protected void setDefaultTextProperties(HSLFTextParagraph _txtrun)
protected void afterInsert(HSLFSheet sh)
PPDrawing about it.afterInsert in class HSLFShapesh - the sheet we are adding toprotected EscherTextboxWrapper getEscherTextboxWrapper()
public java.awt.geom.Rectangle2D resizeToFitText()
Rectangle2D that is the bounds of this shape.public int getRunType()
TextHeaderAtompublic void setRunType(int type)
TextHeaderAtompublic boolean isAlignToBaseline()
public void setAlignToBaseline(boolean alignToBaseline)
alignToBaseline - if true, vertical alignment is relative to baselinepublic boolean isHorizontalCentered()
TextShapeisHorizontalCentered in interface TextShape<HSLFShape,HSLFTextParagraph>public void setHorizontalCentered(java.lang.Boolean isCentered)
TextShapesetHorizontalCentered in interface TextShape<HSLFShape,HSLFTextParagraph>isCentered - true, if the paragraphs are horizontal centered
A null values unsets this property.public VerticalAlignment getVerticalAlignment()
TextShapegetVerticalAlignment in interface TextShape<HSLFShape,HSLFTextParagraph>public void setVerticalAlignment(VerticalAlignment vAlign)
TextShapesetVerticalAlignment in interface TextShape<HSLFShape,HSLFTextParagraph>vAlign - - the type of alignment.
A null values unsets this property.public double getBottomInset()
public void setBottomInset(double margin)
margin - the bottom margingetBottomInset()public double getLeftInset()
public void setLeftInset(double margin)
margin - the left margingetLeftInset()public double getRightInset()
public void setRightInset(double margin)
margin - the right margingetRightInset()public double getTopInset()
public void setTopInset(double margin)
margin - the top margingetTopInset()public int getWordWrapEx()
Wrap* constants defined in this class.public void setWordWrapEx(int wrap)
wrap - the value indicating how the text should be wrapped.
Must be one of the Wrap* constants defined in this class.public boolean getWordWrap()
getWordWrap in interface TextShape<HSLFShape,HSLFTextParagraph>public void setWordWrap(boolean wrap)
setWordWrap in interface TextShape<HSLFShape,HSLFTextParagraph>wrap - whether to wrap words within the bounding rectanglepublic int getTextId()
public void setTextId(int id)
id - of the textpublic java.util.List<HSLFTextParagraph> getTextParagraphs()
getTextParagraphs in interface TextShape<HSLFShape,HSLFTextParagraph>public void setSheet(HSLFSheet sheet)
HSLFShapeSlideShow this shape belongs topublic OEPlaceholderAtom getPlaceholderAtom()
OEPlaceholderAtom, the atom that describes a placeholder.OEPlaceholderAtom or null if not foundpublic RoundTripHFPlaceholder12 getHFPlaceholderAtom()
RoundTripHFPlaceholder12, the atom that describes a header/footer placeholder.
Compare the RoundTripHFPlaceholder12.getPlaceholderId() with
OEPlaceholderAtom.MasterHeader or OEPlaceholderAtom.MasterFooter, to find out
what kind of placeholder this is.RoundTripHFPlaceholder12 or null if not foundpublic boolean isPlaceholder()
isPlaceholder in class HSLFShapepublic java.util.Iterator<HSLFTextParagraph> iterator()
iterator in interface java.lang.Iterable<HSLFTextParagraph>public Insets2D getInsets()
getInsets in interface TextShape<HSLFShape,HSLFTextParagraph>public void setInsets(Insets2D insets)
TextShapesetInsets in interface TextShape<HSLFShape,HSLFTextParagraph>insets - the new shape marginspublic double getTextHeight()
TextShapegetTextHeight in interface TextShape<HSLFShape,HSLFTextParagraph>public TextShape.TextDirection getTextDirection()
getTextDirection in interface TextShape<HSLFShape,HSLFTextParagraph>public void setTextDirection(TextShape.TextDirection orientation)
TextShapesetTextDirection in interface TextShape<HSLFShape,HSLFTextParagraph>orientation - vertical orientation of the textpublic java.lang.Double getTextRotation()
TextShapegetTextRotation in interface TextShape<HSLFShape,HSLFTextParagraph>public void setTextRotation(java.lang.Double rotation)
TextShapesetTextRotation in interface TextShape<HSLFShape,HSLFTextParagraph>rotation - the text rotation, or null to unset the rotationpublic java.lang.String getRawText()
public java.lang.String getText()
TextShapegetText in interface TextShape<HSLFShape,HSLFTextParagraph>public HSLFTextRun appendText(java.lang.String text, boolean newParagraph)
TextShapeappendText in interface TextShape<HSLFShape,HSLFTextParagraph>text - the text string to be appended.newParagraph - if true, a new paragraph will be added,
which will contain the added textpublic HSLFTextRun setText(java.lang.String text)
TextShapesetText in interface TextShape<HSLFShape,HSLFTextParagraph>text - the text string used by this object.protected void storeText()
public java.util.List<HSLFHyperlink> getHyperlinks()
null
if not found.public void setTextPlaceholder(TextShape.TextPlaceholder placeholder)
TextShapesetTextPlaceholder in interface TextShape<HSLFShape,HSLFTextParagraph>public TextShape.TextPlaceholder getTextPlaceholder()
getTextPlaceholder in interface TextShape<HSLFShape,HSLFTextParagraph>public TextShape<?,?> getMetroShape()
Copyright 2017 The Apache Software Foundation or its licensors, as applicable.