@Beta public abstract class XSLFTextShape extends XSLFSimpleShape implements TextShape<XSLFShape,XSLFTextParagraph>
TextShape.TextAutofit, TextShape.TextDirection
Modifier and Type | Method and Description |
---|---|
XSLFTextParagraph |
addNewTextParagraph()
add a new paragraph run to this shape
|
void |
clearText()
unset text from this shape
|
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.
|
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.
|
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.
|
java.lang.String |
getText() |
TextShape.TextAutofit |
getTextAutofit() |
protected abstract org.openxmlformats.schemas.drawingml.x2006.main.CTTextBody |
getTextBody(boolean create) |
protected org.openxmlformats.schemas.drawingml.x2006.main.CTTextBodyProperties |
getTextBodyPr() |
TextShape.TextDirection |
getTextDirection() |
double |
getTextHeight()
Compute the cumulative height occupied by the text
|
java.util.List<XSLFTextParagraph> |
getTextParagraphs() |
Placeholder |
getTextType() |
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() |
boolean |
isHorizontalCentered()
Returns if the text is centered.
|
java.util.Iterator<XSLFTextParagraph> |
iterator() |
java.awt.Rectangle |
resizeToFitText()
Adjust the size of the shape so it encompasses the text inside it.
|
void |
setBottomInset(double margin)
Sets the bottom margin.
|
void |
setHorizontalCentered(java.lang.Boolean isCentered)
Sets if the paragraphs are horizontal centered
|
void |
setLeftInset(double margin)
Sets the left margin.
|
void |
setPlaceholder(Placeholder placeholder)
Specifies that the corresponding shape should be represented by the generating application
as a placeholder.
|
void |
setRightInset(double margin)
Sets the right margin.
|
void |
setText(java.lang.String text) |
void |
setTextAutofit(TextShape.TextAutofit value)
Specifies that a shape should be auto-fit to fully contain the text described within it.
|
void |
setTextDirection(TextShape.TextDirection orientation) |
void |
setTopInset(double margin)
Sets the top margin.
|
void |
setVerticalAlignment(VerticalAlignment anchor)
Sets the type of vertical alignment for the text.
|
void |
setWordWrap(boolean wrap) |
getAdjustValue, getAnchor, getFillColor, getFillStyle, getFlipHorizontal, getFlipVertical, getGeometry, getLineCap, getLineColor, getLineCompound, getLineDash, getLineDecoration, getLineHeadDecoration, getLineHeadLength, getLineHeadWidth, getLinePaint, getLineTailDecoration, getLineTailLength, getLineTailWidth, getLineWidth, getRotation, getSafeXfrm, getShadow, getShapeType, getStrokeStyle, getXfrm, isPlaceholder, setAnchor, setFillColor, setFlipHorizontal, setFlipVertical, setLineCap, setLineColor, setLineDash, setLineHeadDecoration, setLineHeadLength, setLineHeadWidth, setLineTailDecoration, setLineTailLength, setLineTailWidth, setLineWidth, setRotation, setShapeType
fetchShapeProperty, getBgPr, getBgRef, getCNvPr, getCTPlaceholder, getFillPaint, getGrpSpPr, getPaint, getParent, getShapeId, getShapeName, getSheet, getSpPr, getSpStyle, getXmlObject, selectPaint, selectPaint, selectPaint, selectPaint, selectPaint, selectProperty, setParent
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getFillStyle, getGeometry, getLineDecoration, getShadow, getShapeType, getStrokeStyle, isPlaceholder
getAdjustValue
getAnchor, getFlipHorizontal, getFlipVertical, getParent, getRotation, setAnchor, setFlipHorizontal, setFlipVertical, setRotation
public java.util.Iterator<XSLFTextParagraph> iterator()
iterator
in interface java.lang.Iterable<XSLFTextParagraph>
public java.lang.String getText()
public void clearText()
public void setText(java.lang.String text)
public java.util.List<XSLFTextParagraph> getTextParagraphs()
getTextParagraphs
in interface TextShape<XSLFShape,XSLFTextParagraph>
public XSLFTextParagraph addNewTextParagraph()
public void setVerticalAlignment(VerticalAlignment anchor)
anchor
- - the type of alignment.
A null
values unsets this property.public VerticalAlignment getVerticalAlignment()
getVerticalAlignment
in interface TextShape<XSLFShape,XSLFTextParagraph>
public void setHorizontalCentered(java.lang.Boolean isCentered)
isCentered
- true, if the paragraphs are horizontal centered
A null
values unsets this property.TextShape.isHorizontalCentered()
public boolean isHorizontalCentered()
TextShape
isHorizontalCentered
in interface TextShape<XSLFShape,XSLFTextParagraph>
public void setTextDirection(TextShape.TextDirection orientation)
orientation
- vertical orientation of the textpublic TextShape.TextDirection getTextDirection()
getTextDirection
in interface TextShape<XSLFShape,XSLFTextParagraph>
public double getBottomInset()
public double getLeftInset()
public double getRightInset()
public double getTopInset()
public void setBottomInset(double margin)
margin
- the bottom margingetBottomInset()
public void setLeftInset(double margin)
margin
- the left margingetLeftInset()
public void setRightInset(double margin)
margin
- the right margingetRightInset()
public void setTopInset(double margin)
margin
- the top margingetTopInset()
public Insets2D getInsets()
getInsets
in interface TextShape<XSLFShape,XSLFTextParagraph>
public boolean getWordWrap()
getWordWrap
in interface TextShape<XSLFShape,XSLFTextParagraph>
public void setWordWrap(boolean wrap)
wrap
- whether to wrap words within the bounding rectanglepublic void setTextAutofit(TextShape.TextAutofit value)
value
- type of autofitpublic TextShape.TextAutofit getTextAutofit()
protected org.openxmlformats.schemas.drawingml.x2006.main.CTTextBodyProperties getTextBodyPr()
protected abstract org.openxmlformats.schemas.drawingml.x2006.main.CTTextBody getTextBody(boolean create)
public void setPlaceholder(Placeholder placeholder)
XSLFShape
setPlaceholder
in class XSLFShape
public Placeholder getTextType()
public double getTextHeight()
TextShape
getTextHeight
in interface TextShape<XSLFShape,XSLFTextParagraph>
public java.awt.Rectangle resizeToFitText()
Rectangle2D
that is the bounds of this shape.Copyright 2016 The Apache Software Foundation or its licensors, as applicable.