Package org.apache.poi.hwpf.usermodel

Class Paragraph

java.lang.Object
org.apache.poi.hwpf.usermodel.Range
org.apache.poi.hwpf.usermodel.Paragraph
All Implemented Interfaces:
org.apache.poi.common.Duplicatable
Direct Known Subclasses:
ListEntry
public class Paragraph extends Range implements org.apache.poi.common.Duplicatable

  • Field Details

  • Method Details

    • newParagraph

      @Internal public static Paragraph newParagraph(Range parent, PAPX papx)

    • getStyleIndex

      public short getStyleIndex()
      Returns the index of the style which applies to this Paragraph. Details of the style can be looked up from the StyleSheet, via StyleSheet.getStyleDescription(int)

    • isInTable

      public boolean isInTable()

    • isTableRowEnd

      public boolean isTableRowEnd()
      Returns:
      true, if table trailer paragraph (last in table row), false otherwise

    • getTableLevel

      public int getTableLevel()

    • isEmbeddedCellMark

      public boolean isEmbeddedCellMark()
      Returns:
      true, if the end of paragraph mark is really an end of cell mark for a nested table cell, false otherwise

    • getJustification

      public int getJustification()

    • setJustification

      public void setJustification(byte jc)

    • keepOnPage

      public boolean keepOnPage()

    • setKeepOnPage

      public void setKeepOnPage(boolean fKeep)

    • keepWithNext

      public boolean keepWithNext()

    • setKeepWithNext

      public void setKeepWithNext(boolean fKeepFollow)

    • pageBreakBefore

      public boolean pageBreakBefore()

    • setPageBreakBefore

      public void setPageBreakBefore(boolean fPageBreak)

    • isLineNotNumbered

      public boolean isLineNotNumbered()

    • setLineNotNumbered

      public void setLineNotNumbered(boolean fNoLnn)

    • isSideBySide

      public boolean isSideBySide()

    • setSideBySide

      public void setSideBySide(boolean fSideBySide)

    • isAutoHyphenated

      public boolean isAutoHyphenated()

    • setAutoHyphenated

      public void setAutoHyphenated(boolean autoHyph)

    • isWidowControlled

      public boolean isWidowControlled()

    • setWidowControl

      public void setWidowControl(boolean widowControl)

    • getIndentFromRight

      public int getIndentFromRight()

    • setIndentFromRight

      public void setIndentFromRight(int dxaRight)

    • getIndentFromLeft

      public int getIndentFromLeft()

    • setIndentFromLeft

      public void setIndentFromLeft(int dxaLeft)

    • getFirstLineIndent

      public int getFirstLineIndent()

    • setFirstLineIndent

      public void setFirstLineIndent(int first)

    • getLineSpacing

      public LineSpacingDescriptor getLineSpacing()

    • setLineSpacing

      public void setLineSpacing(LineSpacingDescriptor lspd)

    • getSpacingBefore

      public int getSpacingBefore()

    • setSpacingBefore

      public void setSpacingBefore(int before)

    • getSpacingAfter

      public int getSpacingAfter()

    • setSpacingAfter

      public void setSpacingAfter(int after)

    • isKinsoku

      public boolean isKinsoku()

    • setKinsoku

      public void setKinsoku(boolean kinsoku)

    • isWordWrapped

      public boolean isWordWrapped()

    • setWordWrapped

      public void setWordWrapped(boolean wrap)

    • getFontAlignment

      public int getFontAlignment()

    • setFontAlignment

      public void setFontAlignment(int align)

    • isVertical

      public boolean isVertical()

    • setVertical

      public void setVertical(boolean vertical)

    • isBackward

      public boolean isBackward()

    • setBackward

      public void setBackward(boolean bward)

    • getTopBorder

      public BorderCode getTopBorder()

    • setTopBorder

      public void setTopBorder(BorderCode top)

    • getLeftBorder

      public BorderCode getLeftBorder()

    • setLeftBorder

      public void setLeftBorder(BorderCode left)

    • getBottomBorder

      public BorderCode getBottomBorder()

    • setBottomBorder

      public void setBottomBorder(BorderCode bottom)

    • getRightBorder

      public BorderCode getRightBorder()

    • setRightBorder

      public void setRightBorder(BorderCode right)

    • getBarBorder

      public BorderCode getBarBorder()

    • setBarBorder

      public void setBarBorder(BorderCode bar)

    • getShading

      public ShadingDescriptor getShading()

    • setShading

      public void setShading(ShadingDescriptor shd)

    • getDropCap

      public DropCapSpecifier getDropCap()

    • setDropCap

      public void setDropCap(DropCapSpecifier dcs)

    • getIlfo

      public int getIlfo()
      Returns the ilfo, an index to the document's hpllfo, which describes the automatic number formatting of the paragraph. A value of zero means it isn't numbered.

    • getIlvl

      public int getIlvl()
      Returns the multi-level indent for the paragraph. Will be zero for non-list paragraphs, and the first level of any list. Subsequent levels in hold values 1-8.

    • getLvl

      public int getLvl()
      Returns the heading level (1-8), or 9 if the paragraph isn't in a heading style.

    • getTabStopsNumber

      public int getTabStopsNumber()
      Returns number of tabs stops defined for paragraph. Must be >= 0 and <= 64.
      Returns:
      number of tabs stops defined for paragraph. Must be >= 0 and <= 64

    • getTabStopsPositions

      public int[] getTabStopsPositions()
      Returns array of positions of itbdMac tab stops
      Returns:
      array of positions of itbdMac tab stops

    • getList

      public HWPFList getList()

    • isInList

      public boolean isInList()

    • cloneProperties

      public ParagraphProperties cloneProperties()
      Clone the ParagraphProperties object associated with this Paragraph, so that you can apply the same properties to another Paragraph.

    • copy

      public Paragraph copy()
      Specified by:
      copy in interface org.apache.poi.common.Duplicatable

    • toString

      public String toString()
      Overrides:
      toString in class Range

    • getProps

      @Internal public ParagraphProperties getProps()