|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.poi.xslf.usermodel.XSLFTextParagraph
@Beta public class XSLFTextParagraph
Represents a paragraph of text within the containing text body. The paragraph is the highest level text separation mechanism.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.apache.poi.sl.usermodel.TextParagraph |
---|
TextParagraph.BulletStyle, TextParagraph.FontAlign, TextParagraph.TextAlign |
Method Summary | |
---|---|
XSLFTextRun |
addLineBreak()
Insert a line break |
XSLFTextRun |
addNewTextRun()
Add a new run of text |
void |
addTabStop(double value)
|
AutoNumberingScheme |
getAutoNumberingScheme()
|
java.lang.Integer |
getAutoNumberingStartAt()
|
java.lang.String |
getBulletCharacter()
|
java.lang.String |
getBulletFont()
|
PaintStyle |
getBulletFontColor()
|
java.lang.Double |
getBulletFontSize()
Returns the bullet size that is to be used within a paragraph. |
TextParagraph.BulletStyle |
getBulletStyle()
|
java.lang.String |
getDefaultFontFamily()
|
java.lang.Double |
getDefaultFontSize()
|
java.lang.Double |
getDefaultTabSize()
|
TextParagraph.FontAlign |
getFontAlign()
|
java.lang.Double |
getIndent()
|
int |
getIndentLevel()
|
java.lang.Double |
getLeftMargin()
|
java.lang.Double |
getLineSpacing()
|
XSLFTextShape |
getParentShape()
|
java.lang.Double |
getRightMargin()
|
java.lang.Double |
getSpaceAfter()
|
java.lang.Double |
getSpaceBefore()
|
double |
getTabStop(int idx)
|
java.lang.String |
getText()
|
TextParagraph.TextAlign |
getTextAlign()
|
java.util.List<XSLFTextRun> |
getTextRuns()
|
org.openxmlformats.schemas.drawingml.x2006.main.CTTextParagraph |
getXmlObject()
|
boolean |
isBullet()
Returns whether this paragraph has bullets |
boolean |
isHeaderOrFooter()
|
java.util.Iterator<XSLFTextRun> |
iterator()
|
protected XSLFTextRun |
newTextRun(org.openxmlformats.schemas.drawingml.x2006.main.CTRegularTextRun r)
Helper method to allow subclasses to provide their own text run |
void |
setBullet(boolean flag)
|
void |
setBulletAutoNumber(AutoNumberingScheme scheme,
int startAt)
Specifies that automatic numbered bullet points should be applied to this paragraph |
void |
setBulletCharacter(java.lang.String str)
|
void |
setBulletFont(java.lang.String typeface)
|
void |
setBulletFontColor(java.awt.Color color)
|
void |
setBulletFontColor(PaintStyle color)
Set the color to be used on bullet characters within a given paragraph. |
void |
setBulletFontSize(double bulletSize)
Sets the bullet size that is to be used within a paragraph. |
void |
setBulletStyle(java.lang.Object... styles)
|
void |
setFontAlign(TextParagraph.FontAlign align)
Specifies the font alignment that is to be applied to the paragraph. |
void |
setIndent(java.lang.Double indent)
|
void |
setIndentLevel(int level)
|
void |
setLeftMargin(java.lang.Double leftMargin)
|
void |
setLineSpacing(java.lang.Double lineSpacing)
|
void |
setRightMargin(java.lang.Double rightMargin)
|
void |
setSpaceAfter(java.lang.Double spaceAfter)
|
void |
setSpaceBefore(java.lang.Double spaceBefore)
|
void |
setTextAlign(TextParagraph.TextAlign align)
|
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public java.lang.String getText()
@Internal public org.openxmlformats.schemas.drawingml.x2006.main.CTTextParagraph getXmlObject()
public XSLFTextShape getParentShape()
getParentShape
in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
public java.util.List<XSLFTextRun> getTextRuns()
getTextRuns
in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
public java.util.Iterator<XSLFTextRun> iterator()
iterator
in interface java.lang.Iterable<XSLFTextRun>
public XSLFTextRun addNewTextRun()
public XSLFTextRun addLineBreak()
public TextParagraph.TextAlign getTextAlign()
getTextAlign
in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
public void setTextAlign(TextParagraph.TextAlign align)
setTextAlign
in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
public TextParagraph.FontAlign getFontAlign()
getFontAlign
in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
public void setFontAlign(TextParagraph.FontAlign align)
TextParagraph.FontAlign
.
align
- font alignpublic java.lang.String getBulletFont()
public void setBulletFont(java.lang.String typeface)
public java.lang.String getBulletCharacter()
public void setBulletCharacter(java.lang.String str)
public PaintStyle getBulletFontColor()
null
value means to use the text font color.public void setBulletFontColor(java.awt.Color color)
public void setBulletFontColor(PaintStyle color)
color
- the bullet colorpublic java.lang.Double getBulletFontSize()
If bulletSize >= 0, then bulletSize is a percentage of the font size. If bulletSize < 0, then it specifies the size in points
public void setBulletFontSize(double bulletSize)
If bulletSize >= 0, then bulletSize is a percentage of the font size. If bulletSize < 0, then it specifies the size in points
public AutoNumberingScheme getAutoNumberingScheme()
public java.lang.Integer getAutoNumberingStartAt()
public void setIndent(java.lang.Double indent)
setIndent
in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
public java.lang.Double getIndent()
getIndent
in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
public void setLeftMargin(java.lang.Double leftMargin)
setLeftMargin
in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
public java.lang.Double getLeftMargin()
getLeftMargin
in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
public void setRightMargin(java.lang.Double rightMargin)
setRightMargin
in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
public java.lang.Double getRightMargin()
getRightMargin
in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
public java.lang.Double getDefaultTabSize()
getDefaultTabSize
in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
public double getTabStop(int idx)
public void addTabStop(double value)
public void setLineSpacing(java.lang.Double lineSpacing)
setLineSpacing
in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
public java.lang.Double getLineSpacing()
getLineSpacing
in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
public void setSpaceBefore(java.lang.Double spaceBefore)
setSpaceBefore
in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
public java.lang.Double getSpaceBefore()
getSpaceBefore
in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
public void setSpaceAfter(java.lang.Double spaceAfter)
setSpaceAfter
in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
public java.lang.Double getSpaceAfter()
getSpaceAfter
in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
public void setIndentLevel(int level)
setIndentLevel
in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
public int getIndentLevel()
getIndentLevel
in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
public boolean isBullet()
public void setBullet(boolean flag)
flag
- whether text in this paragraph has bulletspublic void setBulletAutoNumber(AutoNumberingScheme scheme, int startAt)
scheme
- type of auto-numberingstartAt
- the number that will start number for a given sequence of automatically
numbered bullets (1-based).public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.Double getDefaultFontSize()
getDefaultFontSize
in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
public java.lang.String getDefaultFontFamily()
getDefaultFontFamily
in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
public TextParagraph.BulletStyle getBulletStyle()
getBulletStyle
in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
public void setBulletStyle(java.lang.Object... styles)
setBulletStyle
in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
public boolean isHeaderOrFooter()
isHeaderOrFooter
in interface TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun>
protected XSLFTextRun newTextRun(org.openxmlformats.schemas.drawingml.x2006.main.CTRegularTextRun r)
r
- the xml reference
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |