Class DOCXPPr
- All Implemented Interfaces:
ICTElement
Paragraph Properties Definition.
Represents w:pPr in xml.
- Author:
- Jamson Chan
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionorg.openxmlformats.schemas.wordprocessingml.x2006.main.CTCnfReturns the conditional formatting of the paragraph.org.openxmlformats.schemas.wordprocessingml.x2006.main.CTPPrgetCT()Returns the CT object of current element.getDivId()Returns the associated HTML div ID.org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFramePrReturns the text frame properties.org.openxmlformats.schemas.wordprocessingml.x2006.main.CTIndgetInd()Returns the indentation of the paragraph.org.openxmlformats.schemas.wordprocessingml.x2006.main.STJc.EnumgetJc()Returns the alignment of the paragraph.org.openxmlformats.schemas.wordprocessingml.x2006.main.CTNumPrgetNumPr()Returns the numbering definition instance reference.Returns the associated outline level.Returns the parent paragraph.org.openxmlformats.schemas.wordprocessingml.x2006.main.CTPBdrgetPBdr()Returns the paragraph border.Returns the referenced paragraph style.getRPr()Returns the run properties of the paragraph properties.getRPr(boolean create) Returns the run properties of the paragraph properties.Returns the section properties.getSectPr(boolean create) Returns the section properties.org.openxmlformats.schemas.wordprocessingml.x2006.main.CTShdgetShd()Returns the shading for the paragraph.org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSpacingReturns the spacing between lines and above/below paragraph.org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTabsgetTabs()Returns the set of custom tab stops.org.openxmlformats.schemas.wordprocessingml.x2006.main.STTextAlignment.EnumReturns the vertical character alignment in line.org.openxmlformats.schemas.wordprocessingml.x2006.main.STTextDirection.EnumReturns the paragraph text flow direction.booleanReturns whether automatically adjust right indent when using document grid.booleanReturns whether automatically adjust spacing of latin and east asian text.booleanReturns whether automatically adjust spacing of east asian text and numbers.booleanisBidi()Returns whether right to left paragraph layout.booleanReturns whether ignore spacing above and below when using identical styles.booleanReturns whether keep all lines on one page.booleanReturns whether keep paragraph with next paragraph.booleanReturns whether to use East Asian typography rules for first and last character per line.booleanReturns whether to use left/right indents as inside/outside indents.booleanReturns whether allow punctuation to extend past text extents.booleanReturns whether start paragraph on next page.booleanisSetRPr()Returns whether the run properties of the paragraph properties. is set.booleanReturns whether to use document grid settings for inter-line paragraph spacing.booleanReturns whether suppress hyphenation for paragraph.booleanReturns whether suppress line numbers for paragraph.booleanReturns whether prevent text frames from overlapping.booleanReturns whether compress punctuation at start of a line.booleanReturns whether allow first/last line to display on a separate page.booleanReturns whether allow line breaking at character level.voidsetAdjustRightInd(boolean adjustRightInd) Sets whether automatically adjust right indent when using document grid.voidsetAutoSpaceDE(boolean autoSpaceDE) Sets whether automatically adjust spacing of latin and east asian text.voidsetAutoSpaceDN(boolean autoSpaceDN) Sets whether automatically adjust spacing of east asian text and numbers.voidsetBidi(boolean bidi) Sets whether right to left paragraph layout.voidsetCnfStyle(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTCnf cnfStyle) Sets the conditional formatting of the paragraph.voidsetContextualSpacing(boolean contextualSpacing) Sets whether ignore spacing above and below when using identical styles.voidSets the associated HTML div ID.voidsetFramePr(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFramePr framePr) Sets the text frame properties.voidsetInd(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTInd ind) Sets the indentation of the paragraph.voidsetJc(org.openxmlformats.schemas.wordprocessingml.x2006.main.STJc.Enum jc) Sets the alignment of the paragraph.voidsetKeepLines(boolean keepLines) Sets whether keep all lines on one page.voidsetKeepNext(boolean keepNext) Sets whether keep paragraph with next paragraph.voidsetKinsoku(boolean kinsoku) Sets whether to use East Asian typography rules for first and last character per line.voidsetMirrorIndents(boolean mirrorIndents) Sets whether to use left/right indents as inside/outside indents.voidsetNumPr(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTNumPr numPr) Sets the numbering definition instance reference.voidsetOutlineLvl(Long outlineLvl) Sets the associated outline level.voidsetOverflowPunct(boolean overflowPunct) Sets whether allow punctuation to extend past text extents.voidsetPageBreakBefore(boolean pageBreakBefore) Sets whether start paragraph on next page.voidSets the parent paragraph.voidsetPBdr(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTPBdr pBdr) Sets the paragraph border.voidSets the referenced paragraph style.voidsetRPr(DOCXParaRPr rPr) Sets the run properties of the paragraph properties.voidsetSectPr(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSectPr sectPr) Sets the section properties.voidsetShd(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTShd shd) Sets the shading for the paragraph.voidsetSnapToGrid(boolean snapToGrid) Sets whether to use document grid settings for inter-line paragraph spacing.voidsetSpacing(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSpacing spacing) Sets the spacing between lines and above/below paragraph.voidsetSuppressAutoHyphens(boolean suppressAutoHyphens) Sets whether suppress hyphenation for paragraph.voidsetSuppressLineNumbers(boolean suppressLineNumbers) Sets whether suppress line numbers for paragraph.voidsetSuppressOverlap(boolean suppressOverlap) Sets whether prevent text frames from overlapping.voidsetTabs(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTabs tabs) Sets the set of custom tab stops.voidsetTextAlignment(org.openxmlformats.schemas.wordprocessingml.x2006.main.STTextAlignment.Enum textAlignment) Sets the vertical character alignment in line.voidsetTextDirection(org.openxmlformats.schemas.wordprocessingml.x2006.main.STTextDirection.Enum textDirection) Sets the paragraph text flow direction.voidsetTopLinePunct(boolean topLinePunct) Sets whether compress punctuation at start of a line.voidsetWidowControl(boolean widowControl) Sets whether allow first/last line to display on a separate page.voidsetWordWrap(boolean wordWrap) Sets whether allow line breaking at character level.
-
Constructor Details
-
DOCXPPr
Create a new ParagraphProperties by given CTPPr.- Parameters:
pPr- the CTPPr object.parent- the parent Paragraph object.
-
-
Method Details
-
getCT
public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTPPr getCT()Description copied from interface:ICTElementReturns the CT object of current element.- Specified by:
getCTin interfaceICTElement
-
getParent
Returns the parent paragraph.- Returns:
- the parent paragraph.
-
setParent
Sets the parent paragraph.- Parameters:
parent- the parent paragraph.
-
getRPr
Returns the run properties of the paragraph properties.Represents the following element tag in the schema:
w:rPr.- Returns:
- the run properties of the paragraph properties.
-
getRPr
Returns the run properties of the paragraph properties.Represents the following element tag in the schema:
w:rPr.- Parameters:
create- whether to create a new run properties if not exist.- Returns:
- the run properties of the paragraph properties.
-
setRPr
Sets the run properties of the paragraph properties.Represents the following element tag in the schema:
w:rPr.- Parameters:
rPr- the run properties of the paragraph properties.
-
isSetRPr
public boolean isSetRPr()Returns whether the run properties of the paragraph properties. is set.- Returns:
- whether the run properties of the paragraph properties. is set.
-
isAdjustRightInd
public boolean isAdjustRightInd()Returns whether automatically adjust right indent when using document grid.Represents the following element tag in the schema:
w:adjustRightInd.- Returns:
- whether automatically adjust right indent when using document grid.
-
setAdjustRightInd
public void setAdjustRightInd(boolean adjustRightInd) Sets whether automatically adjust right indent when using document grid.Represents the following element tag in the schema:
w:adjustRightInd.- Parameters:
adjustRightInd- whether automatically adjust right indent when using document grid.
-
isAutoSpaceDE
public boolean isAutoSpaceDE()Returns whether automatically adjust spacing of latin and east asian text.Represents the following element tag in the schema:
w:autoSpaceDE.- Returns:
- whether automatically adjust spacing of latin and east asian text.
-
setAutoSpaceDE
public void setAutoSpaceDE(boolean autoSpaceDE) Sets whether automatically adjust spacing of latin and east asian text.Represents the following element tag in the schema:
w:autoSpaceDE.- Parameters:
autoSpaceDE- whether automatically adjust spacing of latin and east asian text.
-
isAutoSpaceDN
public boolean isAutoSpaceDN()Returns whether automatically adjust spacing of east asian text and numbers.Represents the following element tag in the schema:
w:autoSpaceDN.- Returns:
- whether automatically adjust spacing of east asian text and numbers.
-
setAutoSpaceDN
public void setAutoSpaceDN(boolean autoSpaceDN) Sets whether automatically adjust spacing of east asian text and numbers.Represents the following element tag in the schema:
w:autoSpaceDN.- Parameters:
autoSpaceDN- whether automatically adjust spacing of east asian text and numbers.
-
isBidi
public boolean isBidi()Returns whether right to left paragraph layout.Represents the following element tag in the schema:
w:bidi.- Returns:
- whether right to left paragraph layout.
-
setBidi
public void setBidi(boolean bidi) Sets whether right to left paragraph layout.Represents the following element tag in the schema:
w:bidi.- Parameters:
bidi- whether right to left paragraph layout.
-
getCnfStyle
public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTCnf getCnfStyle()Returns the conditional formatting of the paragraph.Represents the following element tag in the schema:
w:cnfStyle.- Returns:
- cnfStyle the conditional formatting of the paragraph.
-
setCnfStyle
public void setCnfStyle(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTCnf cnfStyle) Sets the conditional formatting of the paragraph.Represents the following element tag in the schema:
w:cnfStyle.- Parameters:
cnfStyle- the conditional formatting of the paragraph.
-
isContextualSpacing
public boolean isContextualSpacing()Returns whether ignore spacing above and below when using identical styles.Represents the following element tag in the schema:
w:contextualSpacing.- Returns:
- whether ignore spacing above and below when using identical styles.
-
setContextualSpacing
public void setContextualSpacing(boolean contextualSpacing) Sets whether ignore spacing above and below when using identical styles.Represents the following element tag in the schema:
w:contextualSpacing.- Parameters:
contextualSpacing- whether ignore spacing above and below when using identical styles.
-
getDivId
Returns the associated HTML div ID.Represents the following element tag in the schema:
w:divId.- Returns:
- the associated HTML div ID.
-
setDivId
Sets the associated HTML div ID.Represents the following element tag in the schema:
w:divId.- Parameters:
divId- the associated HTML div ID.
-
getFramePr
public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFramePr getFramePr()Returns the text frame properties.Represents the following element tag in the schema:
w:framePr.- Returns:
- the text frame properties.
-
setFramePr
public void setFramePr(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFramePr framePr) Sets the text frame properties.Represents the following element tag in the schema:
w:framePr.- Parameters:
framePr- the text frame properties.
-
getInd
public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTInd getInd()Returns the indentation of the paragraph.Represents the following element tag in the schema:
w:ind.- Returns:
- the indentation of the paragraph.
-
setInd
public void setInd(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTInd ind) Sets the indentation of the paragraph.Represents the following element tag in the schema:
w:ind.- Parameters:
ind- the indentation of the paragraph.
-
getJc
public org.openxmlformats.schemas.wordprocessingml.x2006.main.STJc.Enum getJc()Returns the alignment of the paragraph.Represents the following element tag in the schema:
w:jc.- Returns:
- the alignment of the paragraph.
-
setJc
public void setJc(org.openxmlformats.schemas.wordprocessingml.x2006.main.STJc.Enum jc) Sets the alignment of the paragraph.Represents the following element tag in the schema:
w:jc.- Parameters:
jc- the alignment of the paragraph.
-
isKeepLines
public boolean isKeepLines()Returns whether keep all lines on one page.Represents the following element tag in the schema:
w:keepLines.- Returns:
- whether keep all lines on one page.
-
setKeepLines
public void setKeepLines(boolean keepLines) Sets whether keep all lines on one page.Represents the following element tag in the schema:
w:keepLines.- Parameters:
keepLines- whether keep all lines on one page.
-
isKeepNext
public boolean isKeepNext()Returns whether keep paragraph with next paragraph.Represents the following element tag in the schema:
w:keepNext.- Returns:
- whether keep paragraph with next paragraph.
-
setKeepNext
public void setKeepNext(boolean keepNext) Sets whether keep paragraph with next paragraph.Represents the following element tag in the schema:
w:keepNext.- Parameters:
keepNext- whether keep paragraph with next paragraph.
-
isKinsoku
public boolean isKinsoku()Returns whether to use East Asian typography rules for first and last character per line.Represents the following element tag in the schema:
w:kinsoku.- Returns:
- whether to use East Asian typography rules for first and last character per line.
-
setKinsoku
public void setKinsoku(boolean kinsoku) Sets whether to use East Asian typography rules for first and last character per line.Represents the following element tag in the schema:
w:kinsoku.- Parameters:
kinsoku- whether to use East Asian typography rules for first and last character per line.
-
isMirrorIndents
public boolean isMirrorIndents()Returns whether to use left/right indents as inside/outside indents.Represents the following element tag in the schema:
w:mirrorIndents.- Returns:
- whether to use left/right indents as inside/outside indents.
-
setMirrorIndents
public void setMirrorIndents(boolean mirrorIndents) Sets whether to use left/right indents as inside/outside indents.Represents the following element tag in the schema:
w:mirrorIndents.- Parameters:
mirrorIndents- whether to use left/right indents as inside/outside indents.
-
getNumPr
public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTNumPr getNumPr()Returns the numbering definition instance reference.Represents the following element tag in the schema:
w:numPr.- Returns:
- the numbering definition instance reference.
-
setNumPr
public void setNumPr(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTNumPr numPr) Sets the numbering definition instance reference.Represents the following element tag in the schema:
w:numPr.- Parameters:
numPr- the numbering definition instance reference.
-
getOutlineLvl
Returns the associated outline level.Represents the following element tag in the schema:
w:outlineLvl.- Returns:
- the associated outline level.
-
setOutlineLvl
Sets the associated outline level.Represents the following element tag in the schema:
w:outlineLvl.- Parameters:
outlineLvl- the associated outline level.
-
isOverflowPunct
public boolean isOverflowPunct()Returns whether allow punctuation to extend past text extents.Represents the following element tag in the schema:
w:overflowPunct.- Returns:
- whether allow punctuation to extend past text extents.
-
setOverflowPunct
public void setOverflowPunct(boolean overflowPunct) Sets whether allow punctuation to extend past text extents.Represents the following element tag in the schema:
w:overflowPunct.- Parameters:
overflowPunct- whether allow punctuation to extend past text extents.
-
isPageBreakBefore
public boolean isPageBreakBefore()Returns whether start paragraph on next page.Represents the following element tag in the schema:
w:pageBreakBefore.- Returns:
- whether start paragraph on next page.
-
setPageBreakBefore
public void setPageBreakBefore(boolean pageBreakBefore) Sets whether start paragraph on next page.Represents the following element tag in the schema:
w:pageBreakBefore.- Parameters:
pageBreakBefore- whether start paragraph on next page.
-
getPBdr
public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTPBdr getPBdr()Returns the paragraph border.Represents the following element tag in the schema:
w:pBdr.- Returns:
- the paragraph border.
-
setPBdr
public void setPBdr(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTPBdr pBdr) Sets the paragraph border.Represents the following element tag in the schema:
w:pBdr.- Parameters:
pBdr- the paragraph border.
-
getPStyle
Returns the referenced paragraph style.Represents the following element tag in the schema:
w:pStyle.- Returns:
- the referenced paragraph style.
-
setPStyle
Sets the referenced paragraph style.Represents the following element tag in the schema:
w:pStyle.- Parameters:
pStyle- the referenced paragraph style.
-
getSectPr
Returns the section properties.Represents the following element tag in the schema:
w:sectPr.- Returns:
- the section properties.
-
getSectPr
Returns the section properties.Represents the following element tag in the schema:
w:sectPr.- Parameters:
create- whether to create a new section properties if not exist.- Returns:
- the section properties.
-
setSectPr
public void setSectPr(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSectPr sectPr) Sets the section properties.Represents the following element tag in the schema:
w:sectPr.- Parameters:
sectPr- the section properties.
-
getShd
public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTShd getShd()Returns the shading for the paragraph.Represents the following element tag in the schema:
w:shd.- Returns:
- the shading for the paragraph.
-
setShd
public void setShd(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTShd shd) Sets the shading for the paragraph.Represents the following element tag in the schema:
w:shd.- Parameters:
shd- the shading for the paragraph.
-
isSnapToGrid
public boolean isSnapToGrid()Returns whether to use document grid settings for inter-line paragraph spacing.Represents the following element tag in the schema:
w:snapToGrid.- Returns:
- whether to use document grid settings for inter-line paragraph spacing.
-
setSnapToGrid
public void setSnapToGrid(boolean snapToGrid) Sets whether to use document grid settings for inter-line paragraph spacing.Represents the following element tag in the schema:
w:snapToGrid.- Parameters:
snapToGrid- whether to use document grid settings for inter-line paragraph spacing.
-
getSpacing
public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSpacing getSpacing()Returns the spacing between lines and above/below paragraph.Represents the following element tag in the schema:
w:spacing.- Returns:
- the spacing between lines and above/below paragraph.
-
setSpacing
public void setSpacing(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSpacing spacing) Sets the spacing between lines and above/below paragraph.Represents the following element tag in the schema:
w:spacing.- Parameters:
spacing- the spacing between lines and above/below paragraph.
-
isSuppressAutoHyphens
public boolean isSuppressAutoHyphens()Returns whether suppress hyphenation for paragraph.Represents the following element tag in the schema:
w:suppressAutoHyphens.- Returns:
- whether suppress hyphenation for paragraph.
-
setSuppressAutoHyphens
public void setSuppressAutoHyphens(boolean suppressAutoHyphens) Sets whether suppress hyphenation for paragraph.Represents the following element tag in the schema:
w:suppressAutoHyphens.- Parameters:
suppressAutoHyphens- whether suppress hyphenation for paragraph.
-
isSuppressLineNumbers
public boolean isSuppressLineNumbers()Returns whether suppress line numbers for paragraph.Represents the following element tag in the schema:
w:suppressLineNumbers.- Returns:
- whether suppress line numbers for paragraph.
-
setSuppressLineNumbers
public void setSuppressLineNumbers(boolean suppressLineNumbers) Sets whether suppress line numbers for paragraph.Represents the following element tag in the schema:
w:suppressLineNumbers.- Parameters:
suppressLineNumbers- whether suppress line numbers for paragraph.
-
isSuppressOverlap
public boolean isSuppressOverlap()Returns whether prevent text frames from overlapping.Represents the following element tag in the schema:
w:suppressOverlap.- Returns:
- whether prevent text frames from overlapping.
-
setSuppressOverlap
public void setSuppressOverlap(boolean suppressOverlap) Sets whether prevent text frames from overlapping.Represents the following element tag in the schema:
w:suppressOverlap.- Parameters:
suppressOverlap- whether prevent text frames from overlapping.
-
getTabs
public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTabs getTabs()Returns the set of custom tab stops.Represents the following element tag in the schema:
w:tabs.- Returns:
- the set of custom tab stops.
-
setTabs
public void setTabs(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTabs tabs) Sets the set of custom tab stops.Represents the following element tag in the schema:
w:tabs.- Parameters:
tabs- the set of custom tab stops.
-
getTextAlignment
public org.openxmlformats.schemas.wordprocessingml.x2006.main.STTextAlignment.Enum getTextAlignment()Returns the vertical character alignment in line.Represents the following element tag in the schema:
w:textAlignment.- Returns:
- the vertical character alignment in line.
-
setTextAlignment
public void setTextAlignment(org.openxmlformats.schemas.wordprocessingml.x2006.main.STTextAlignment.Enum textAlignment) Sets the vertical character alignment in line.Represents the following element tag in the schema:
w:textAlignment.- Parameters:
textAlignment- the vertical character alignment in line.
-
getTextDirection
public org.openxmlformats.schemas.wordprocessingml.x2006.main.STTextDirection.Enum getTextDirection()Returns the paragraph text flow direction.Represents the following element tag in the schema:
w:textDirection.- Returns:
- the paragraph text flow direction.
-
setTextDirection
public void setTextDirection(org.openxmlformats.schemas.wordprocessingml.x2006.main.STTextDirection.Enum textDirection) Sets the paragraph text flow direction.Represents the following element tag in the schema:
w:textDirection.- Parameters:
textDirection- the paragraph text flow direction.
-
isTopLinePunct
public boolean isTopLinePunct()Returns whether compress punctuation at start of a line.Represents the following element tag in the schema:
w:topLinePunct.- Returns:
- whether compress punctuation at start of a line.
-
setTopLinePunct
public void setTopLinePunct(boolean topLinePunct) Sets whether compress punctuation at start of a line.Represents the following element tag in the schema:
w:topLinePunct.- Parameters:
topLinePunct- whether compress punctuation at start of a line.
-
isWidowControl
public boolean isWidowControl()Returns whether allow first/last line to display on a separate page.Represents the following element tag in the schema:
widowControl.- Returns:
- whether allow first/last line to display on a separate page.
-
setWidowControl
public void setWidowControl(boolean widowControl) Sets whether allow first/last line to display on a separate page.Represents the following element tag in the schema:
widowControl.- Parameters:
widowControl- whether allow first/last line to display on a separate page.
-
isWordWrap
public boolean isWordWrap()Returns whether allow line breaking at character level.Represents the following element tag in the schema:
w:wordWrap.- Returns:
- whether allow line breaking at character level.
-
setWordWrap
public void setWordWrap(boolean wordWrap) Sets whether allow line breaking at character level.Represents the following element tag in the schema:
w:wordWrap.- Parameters:
wordWrap- whether allow line breaking at character level.
-