|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.poi.xslf.usermodel.XSLFShape
org.apache.poi.xslf.usermodel.XSLFSimpleShape
org.apache.poi.xslf.usermodel.XSLFTextShape
@Beta public abstract class XSLFTextShape
Represents a shape that can hold text.
Method Summary | |
---|---|
XSLFTextParagraph |
addNewTextParagraph()
|
java.awt.Color |
getFillColor()
|
double |
getMarginBottom()
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. |
double |
getMarginLeft()
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 |
getMarginRight()
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. |
double |
getMarginTop()
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. |
java.lang.String |
getText()
|
TextAutofit |
getTextAutofit()
|
protected abstract org.openxmlformats.schemas.drawingml.x2006.main.CTTextBody |
getTextBody(boolean create)
|
protected org.openxmlformats.schemas.drawingml.x2006.main.CTTextBodyProperties |
getTextBodyPr()
|
TextDirection |
getTextDirection()
|
java.util.List<XSLFTextParagraph> |
getTextParagraphs()
|
VerticalAlignment |
getVerticalAlignment()
Returns the type of vertical alignment for the text. |
boolean |
getWordWrap()
Returns the value indicating word wrap. |
void |
setFillColor(java.awt.Color color)
Specifies a solid color fill. |
void |
setMarginBottom(double margin)
Sets the botom margin. |
void |
setMarginLeft(double margin)
Sets the left margin. |
void |
setMarginRight(double margin)
Sets the right margin. |
void |
setMarginTop(double margin)
Sets the top margin. |
void |
setTextAutofit(TextAutofit value)
Specifies that a shape should be auto-fit to fully contain the text described within it. |
void |
setTextDirection(TextDirection orientation)
|
void |
setVerticalAlignment(VerticalAlignment anchor)
Sets the type of vertical alignment for the text. |
void |
setWordWrap(boolean wrap)
Specifies how the text should be wrapped |
Methods inherited from class org.apache.poi.xslf.usermodel.XSLFSimpleShape |
---|
getAnchor, getFlipHorizontal, getFlipVertical, getLineCap, getLineColor, getLineDash, getLineWidth, getNvPr, getRotation, getShapeId, getShapeName, getShapeType, getSheet, getSpPr, getXmlObject, setAnchor, setFlipHorizontal, setFlipVertical, setLineCap, setLineColor, setLineDash, setLineWidth, setRotation |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public java.lang.String getText()
public java.util.List<XSLFTextParagraph> getTextParagraphs()
public XSLFTextParagraph addNewTextParagraph()
public void setFillColor(java.awt.Color color)
color
- the solid color fill.
The value of null
unsets the solidFIll attribute from the underlying xmlpublic java.awt.Color getFillColor()
public void setVerticalAlignment(VerticalAlignment anchor)
Anchor*
constants defined in this class.
anchor
- - the type of alignment. Default is VerticalAlignment.TOP
public VerticalAlignment getVerticalAlignment()
public void setTextDirection(TextDirection orientation)
orientation
- vertical orientation of the textpublic TextDirection getTextDirection()
public double getMarginBottom()
public double getMarginLeft()
public double getMarginRight()
public double getMarginTop()
public void setMarginBottom(double margin)
margin
- the bottom margingetMarginBottom()
public void setMarginLeft(double margin)
margin
- the left margingetMarginLeft()
public void setMarginRight(double margin)
margin
- the right margingetMarginRight()
public void setMarginTop(double margin)
margin
- the top margingetMarginTop()
public boolean getWordWrap()
Wrap*
constants defined in this class.
public void setWordWrap(boolean wrap)
wrap
- the value indicating how the text should be wrappedpublic void setTextAutofit(TextAutofit value)
value
- type of autofitpublic TextAutofit getTextAutofit()
protected org.openxmlformats.schemas.drawingml.x2006.main.CTTextBodyProperties getTextBodyPr()
protected abstract org.openxmlformats.schemas.drawingml.x2006.main.CTTextBody getTextBody(boolean create)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |