Module com.github.librepdf.openpdf
Package com.lowagie.text.pdf

Class ColumnText

java.lang.Object
com.lowagie.text.pdf.ColumnText
@Deprecated public class ColumnText extends Object
Deprecated.
Formats text in a columnwise form. The text is bound on the left and on the right by a sequence of lines. This allows the column to have any shape, not only rectangular.

Several parameters can be set like the first paragraph line indent and extra space between paragraphs.

A call to the method go will return one of the following situations: the column ended or the text ended.

I the column ended, a new column definition can be loaded with the method setColumns and the method go can be called again.

If the text ended, more text can be loaded with addText and the method go can be called again.
The only limitation is that one or more complete paragraphs must be loaded each time.

Full bidirectional reordering is supported. If the run direction is PdfWriter.RUN_DIRECTION_RTL the meaning of the horizontal alignments and margins is mirrored.

Author:
Paulo Soares (psoares@consiste.pt)

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected int
    alignment
    Deprecated.
    The column alignment.
    static final int
    AR_COMPOSEDTASHKEEL
    Deprecated.
    Compose the tashkeel in the ligatures.
    static final int
    AR_LIG
    Deprecated.
    Do some extra double ligatures.
    static final int
    AR_NOVOWEL
    Deprecated.
    Eliminate the arabic vowels
    protected BidiLine
    bidiLine
    Deprecated.
    The chunks that form the text.
    protected PdfContentByte
    canvas
    Deprecated.
    The PdfContent where the text will be written to.
    protected PdfContentByte[]
    canvases
    Deprecated.
     
    protected boolean
    composite
    Deprecated.
     
    protected ColumnText
    compositeColumn
    Deprecated.
     
    protected LinkedList<Element>
    compositeElements
    Deprecated.
     
    protected float
    currentLeading
    Deprecated.
    The leading for the current line.
    protected float
    descender
    Deprecated.
     
    static final int
    DIGIT_TYPE_AN
    Deprecated.
    Digit type option: Use Arabic-Indic digits (U+0660...U+0669).
    static final int
    DIGIT_TYPE_AN_EXTENDED
    Deprecated.
    Digit type option: Use Eastern (Extended) Arabic-Indic digits (U+06f0...U+06f9).
    static final int
    DIGITS_AN2EN
    Deprecated.
    Digit shaping option: Replace Arabic-Indic digits by European digits (U+0030...U+0039).
    static final int
    DIGITS_EN2AN
    Deprecated.
    Digit shaping option: Replace European digits (U+0030...U+0039) by Arabic-Indic digits.
    static final int
    DIGITS_EN2AN_INIT_AL
    Deprecated.
    Digit shaping option: Replace European digits (U+0030...U+0039) by Arabic-Indic digits if the most recent strongly directional character is an Arabic letter (its Bidi direction value is RIGHT_TO_LEFT_ARABIC).
    static final int
    DIGITS_EN2AN_INIT_LR
    Deprecated.
    Digit shaping option: Replace European digits (U+0030...U+0039) by Arabic-Indic digits if the most recent strongly directional character is an Arabic letter (its Bidi direction value is RIGHT_TO_LEFT_ARABIC).
    protected float
    extraParagraphSpace
    Deprecated.
    The extra space between paragraphs.
    protected float
    fixedLeading
    Deprecated.
    The fixed text leading.
    protected float
    followingIndent
    Deprecated.
    The following paragraph lines indent.
    static final float
    GLOBAL_SPACE_CHAR_RATIO
    Deprecated.
    the space char ratio
    protected float
    indent
    Deprecated.
    The first paragraph line indent.
    protected List<float[]>
    leftWall
    Deprecated.
    The left column bound.
    protected float
    leftX
    Deprecated.
     
    protected static final int
    LINE_STATUS_NOLINE
    Deprecated.
    The line cannot fit this column position.
    protected static final int
    LINE_STATUS_OFFLIMITS
    Deprecated.
    The line is out the column limits.
    protected static final int
    LINE_STATUS_OK
    Deprecated.
    The column is valid.
    protected int
    lineStatus
    Deprecated.
    The line status when trying to fit a line to a column.
    protected int
    listIdx
    Deprecated.
     
    protected float
    maxY
    Deprecated.
    Upper bound of the column.
    protected float
    minY
    Deprecated.
    Lower bound of the column.
    protected float
    multipliedLeading
    Deprecated.
    The text leading that is multiplied by the biggest font size in the line.
    static final int
    NO_MORE_COLUMN
    Deprecated.
    Signals that there is no more column.
    static final int
    NO_MORE_TEXT
    Deprecated.
    Signals that there is no more text available.
    protected boolean
    rectangularMode
    Deprecated.
     
    protected float
    rectangularWidth
    Deprecated.
    The width of the line when the column is defined as a simple rectangle.
    protected float
    rightIndent
    Deprecated.
    The right paragraph lines indent.
    protected List<float[]>
    rightWall
    Deprecated.
    The right column bound.
    protected float
    rightX
    Deprecated.
     
    protected int
    runDirection
    Deprecated.
     
    static final int
    START_COLUMN
    Deprecated.
    Initial value of the status.
    protected Phrase
    waitPhrase
    Deprecated.
     
    protected float
    yLine
    Deprecated.
    The current y line location.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ColumnText(PdfContentByte canvas)
    Deprecated.
    Creates a ColumnText.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addElement(Element element)
    Deprecated.
    Adds an element.
    void
    addText(Chunk chunk)
    Deprecated.
    Adds a Chunk to the current text array.
    void
    addText(Phrase phrase)
    Deprecated.
    Adds a Phrase to the current text array.
    void
    clearChunks()
    Deprecated.
    Clears the chunk array.
    protected List<float[]>
    convertColumn(float[] cLine)
    Deprecated.
    Converts a sequence of lines representing one of the column bounds into an internal format.
    static ColumnText
    duplicate(ColumnText org)
    Deprecated.
    Creates an independent duplicated of the instance org.
    protected float[]
    findLimitsOneLine()
    Deprecated.
    Finds the intersection between the yLine and the two column bounds.
    protected float
    findLimitsPoint(List<float[]> wall)
    Deprecated.
    Finds the intersection between the yLine and the column.
    protected float[]
    findLimitsTwoLines()
    Deprecated.
    Finds the intersection between the yLine, the yLine-leadingand the two column bounds.
    int
    getAlignment()
    Deprecated.
    Gets the alignment.
    int
    getArabicOptions()
    Deprecated.
    Gets the arabic shaping options.
    PdfContentByte
    getCanvas()
    Deprecated.
    Gets the canvas.
    PdfContentByte[]
    getCanvases()
    Deprecated.
    Gets the canvases.
    float
    getDescender()
    Deprecated.
    Gets the biggest descender value of the last line written.
    float
    getExtraParagraphSpace()
    Deprecated.
    Sets the extra space between paragraphs.
    float
    getFilledWidth()
    Deprecated.
    Gets the real width used by the largest line.
    float
    getFollowingIndent()
    Deprecated.
    Gets the following paragraph lines indent.
    float
    getIndent()
    Deprecated.
    Gets the first paragraph line indent.
    float
    getLeading()
    Deprecated.
    Gets the fixed leading.
    int
    getLinesWritten()
    Deprecated.
    Gets the number of lines written.
    float
    getMultipliedLeading()
    Deprecated.
    Gets the variable leading.
    float
    getRightIndent()
    Deprecated.
    Gets the right paragraph lines indent.
    int
    getRunDirection()
    Deprecated.
    Gets the run direction.
    float
    getSpaceCharRatio()
    Deprecated.
    Gets the space/character extra spacing ratio for fully justified text.
    static float
    getWidth(Phrase phrase)
    Deprecated.
    Gets the width that the line will occupy after writing.
    static float
    getWidth(Phrase phrase, int runDirection, int arabicOptions)
    Deprecated.
    Gets the width that the line will occupy after writing.
    float
    getYLine()
    Deprecated.
    Gets the yLine.
    int
    go()
    Deprecated.
    Outputs the lines to the document.
    int
    go(boolean simulate)
    Deprecated.
    Outputs the lines to the document.
    protected int
    goComposite(boolean simulate)
    Deprecated.
     
    static boolean
    hasMoreText(int status)
    Deprecated.
    Checks the status variable and looks if there's still some text.
    boolean
    isAdjustFirstLine()
    Deprecated.
    Gets the first line adjustment property.
    boolean
    isStrictWordWrapping()
    Deprecated.
    Gets the strict word wrapping flag.
    boolean
    isUseAscender()
    Deprecated.
    Checks if UseAscender is enabled/disabled.
    ColumnText
    setACopy(ColumnText org)
    Deprecated.
    Makes this instance an independent copy of org.
    void
    setAdjustFirstLine(boolean adjustFirstLine)
    Deprecated.
    Sets the first line adjustment.
    void
    setAlignment(int alignment)
    Deprecated.
    Sets the alignment.
    void
    setArabicOptions(int arabicOptions)
    Deprecated.
    Sets the arabic shaping options.
    void
    setCanvas(PdfContentByte canvas)
    Deprecated.
    Sets the canvas.
    void
    setCanvases(PdfContentByte[] canvases)
    Deprecated.
    Sets the canvases.
    void
    setColumns(float[] leftLine, float[] rightLine)
    Deprecated.
    Sets the columns bounds.
    void
    setExtraParagraphSpace(float extraParagraphSpace)
    Deprecated.
    Sets the extra space between paragraphs.
    void
    setFilledWidth(float filledWidth)
    Deprecated.
    Sets the real width used by the largest line.
    void
    setFollowingIndent(float indent)
    Deprecated.
    Sets the following paragraph lines indent.
    void
    setIndent(float indent)
    Deprecated.
    Sets the first paragraph line indent.
    void
    setLeading(float leading)
    Deprecated.
    Sets the leading to fixed.
    void
    setLeading(float fixedLeading, float multipliedLeading)
    Deprecated.
    Sets the leading fixed and variable.
    void
    setRightIndent(float indent)
    Deprecated.
    Sets the right paragraph lines indent.
    void
    setRunDirection(int runDirection)
    Deprecated.
    Sets the run direction.
    void
    setSimpleColumn(float llx, float lly, float urx, float ury)
    Deprecated.
    Simplified method for rectangular columns.
    void
    setSimpleColumn(float llx, float lly, float urx, float ury, float leading, int alignment)
    Deprecated.
    Simplified method for rectangular columns.
    void
    setSimpleColumn(Phrase phrase, float llx, float lly, float urx, float ury, float leading, int alignment)
    Deprecated.
    Simplified method for rectangular columns.
    protected void
    setSimpleVars(ColumnText org)
    Deprecated.
     
    void
    setSpaceCharRatio(float spaceCharRatio)
    Deprecated.
    Sets the ratio between the extra word spacing and the extra character spacing when the text is fully justified.
    void
    setStrictWordWrapping(boolean strictWordWrapping)
    Deprecated.
    Sets the strict word wrapping flag.
    void
    setText(Phrase phrase)
    Deprecated.
    Replaces the current text array with this Phrase.
    void
    setUseAscender(boolean useAscender)
    Deprecated.
    Enables/Disables adjustment of first line height based on max ascender.
    void
    setYLine(float yLine)
    Deprecated.
    Sets the yLine.
    static void
    showTextAligned(PdfContentByte canvas, int alignment, Phrase phrase, float x, float y, float rotation)
    Deprecated.
    Shows a line of text.
    static void
    showTextAligned(PdfContentByte canvas, int alignment, Phrase phrase, float x, float y, float rotation, int runDirection, int arabicOptions)
    Deprecated.
    Shows a line of text.
    void
    updateFilledWidth(float w)
    Deprecated.
    Replaces the filledWidth if greater than the existing one.
    boolean
    zeroHeightElement()
    Deprecated.
    Checks if the element has a height of 0.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • AR_NOVOWEL

      public static final int AR_NOVOWEL
      Deprecated.
      Eliminate the arabic vowels
      See Also:

    • AR_COMPOSEDTASHKEEL

      public static final int AR_COMPOSEDTASHKEEL
      Deprecated.
      Compose the tashkeel in the ligatures.
      See Also:

    • AR_LIG

      public static final int AR_LIG
      Deprecated.
      Do some extra double ligatures.
      See Also:

    • DIGITS_EN2AN

      public static final int DIGITS_EN2AN
      Deprecated.
      Digit shaping option: Replace European digits (U+0030...U+0039) by Arabic-Indic digits.
      See Also:

    • DIGITS_AN2EN

      public static final int DIGITS_AN2EN
      Deprecated.
      Digit shaping option: Replace Arabic-Indic digits by European digits (U+0030...U+0039).
      See Also:

    • DIGITS_EN2AN_INIT_LR

      public static final int DIGITS_EN2AN_INIT_LR
      Deprecated.
      Digit shaping option: Replace European digits (U+0030...U+0039) by Arabic-Indic digits if the most recent strongly directional character is an Arabic letter (its Bidi direction value is RIGHT_TO_LEFT_ARABIC). The initial state at the start of the text is assumed to be not an Arabic, letter, so European digits at the start of the text will not change. Compare to DIGITS_ALEN2AN_INIT_AL.
      See Also:

    • DIGITS_EN2AN_INIT_AL

      public static final int DIGITS_EN2AN_INIT_AL
      Deprecated.
      Digit shaping option: Replace European digits (U+0030...U+0039) by Arabic-Indic digits if the most recent strongly directional character is an Arabic letter (its Bidi direction value is RIGHT_TO_LEFT_ARABIC). The initial state at the start of the text is assumed to be an Arabic, letter, so European digits at the start of the text will change. Compare to DIGITS_ALEN2AN_INT_LR.
      See Also:

    • DIGIT_TYPE_AN

      public static final int DIGIT_TYPE_AN
      Deprecated.
      Digit type option: Use Arabic-Indic digits (U+0660...U+0669).
      See Also:

    • DIGIT_TYPE_AN_EXTENDED

      public static final int DIGIT_TYPE_AN_EXTENDED
      Deprecated.
      Digit type option: Use Eastern (Extended) Arabic-Indic digits (U+06f0...U+06f9).
      See Also:

    • GLOBAL_SPACE_CHAR_RATIO

      public static final float GLOBAL_SPACE_CHAR_RATIO
      Deprecated.
      the space char ratio
      See Also:

    • START_COLUMN

      public static final int START_COLUMN
      Deprecated.
      Initial value of the status.
      See Also:

    • NO_MORE_TEXT

      public static final int NO_MORE_TEXT
      Deprecated.
      Signals that there is no more text available.
      See Also:

    • NO_MORE_COLUMN

      public static final int NO_MORE_COLUMN
      Deprecated.
      Signals that there is no more column.
      See Also:

    • LINE_STATUS_OK

      protected static final int LINE_STATUS_OK
      Deprecated.
      The column is valid.
      See Also:

    • LINE_STATUS_OFFLIMITS

      protected static final int LINE_STATUS_OFFLIMITS
      Deprecated.
      The line is out the column limits.
      See Also:

    • LINE_STATUS_NOLINE

      protected static final int LINE_STATUS_NOLINE
      Deprecated.
      The line cannot fit this column position.
      See Also:

    • runDirection

      protected int runDirection
      Deprecated.

    • maxY

      protected float maxY
      Deprecated.
      Upper bound of the column.

    • minY

      protected float minY
      Deprecated.
      Lower bound of the column.

    • leftX

      protected float leftX
      Deprecated.

    • rightX

      protected float rightX
      Deprecated.

    • alignment

      protected int alignment
      Deprecated.
      The column alignment. Default is left alignment.

    • leftWall

      protected List<float[]> leftWall
      Deprecated.
      The left column bound.

    • rightWall

      protected List<float[]> rightWall
      Deprecated.
      The right column bound.

    • bidiLine

      protected BidiLine bidiLine
      Deprecated.
      The chunks that form the text.

    • yLine

      protected float yLine
      Deprecated.
      The current y line location. Text will be written at this line minus the leading.

    • currentLeading

      protected float currentLeading
      Deprecated.
      The leading for the current line.

    • fixedLeading

      protected float fixedLeading
      Deprecated.
      The fixed text leading.

    • multipliedLeading

      protected float multipliedLeading
      Deprecated.
      The text leading that is multiplied by the biggest font size in the line.

    • canvas

      protected PdfContentByte canvas
      Deprecated.
      The PdfContent where the text will be written to.

    • canvases

      protected PdfContentByte[] canvases
      Deprecated.

    • lineStatus

      protected int lineStatus
      Deprecated.
      The line status when trying to fit a line to a column.

    • indent

      protected float indent
      Deprecated.
      The first paragraph line indent.

    • followingIndent

      protected float followingIndent
      Deprecated.
      The following paragraph lines indent.

    • rightIndent

      protected float rightIndent
      Deprecated.
      The right paragraph lines indent.

    • extraParagraphSpace

      protected float extraParagraphSpace
      Deprecated.
      The extra space between paragraphs.

    • rectangularWidth

      protected float rectangularWidth
      Deprecated.
      The width of the line when the column is defined as a simple rectangle.

    • rectangularMode

      protected boolean rectangularMode
      Deprecated.

    • descender

      protected float descender
      Deprecated.

    • composite

      protected boolean composite
      Deprecated.

    • compositeColumn

      protected ColumnText compositeColumn
      Deprecated.

    • compositeElements

      protected LinkedList<Element> compositeElements
      Deprecated.

    • listIdx

      protected int listIdx
      Deprecated.

    • waitPhrase

      protected Phrase waitPhrase
      Deprecated.

  • Constructor Details

    • ColumnText

      public ColumnText(PdfContentByte canvas)
      Deprecated.
      Creates a ColumnText.
      Parameters:
      canvas - the place where the text will be written to. Can be a template.

  • Method Details

    • duplicate

      public static ColumnText duplicate(ColumnText org)
      Deprecated.
      Creates an independent duplicated of the instance org.
      Parameters:
      org - the original ColumnText
      Returns:
      the duplicated

    • getWidth

      public static float getWidth(Phrase phrase, int runDirection, int arabicOptions)
      Deprecated.
      Gets the width that the line will occupy after writing. Only the width of the first line is returned.
      Parameters:
      phrase - the Phrase containing the line
      runDirection - the run direction
      arabicOptions - the options for the arabic shaping
      Returns:
      the width of the line

    • getWidth

      public static float getWidth(Phrase phrase)
      Deprecated.
      Gets the width that the line will occupy after writing. Only the width of the first line is returned.
      Parameters:
      phrase - the Phrase containing the line
      Returns:
      the width of the line

    • showTextAligned

      public static void showTextAligned(PdfContentByte canvas, int alignment, Phrase phrase, float x, float y, float rotation, int runDirection, int arabicOptions)
      Deprecated.
      Shows a line of text. Only the first line is written.
      Parameters:
      canvas - where the text is to be written to
      alignment - the alignment. It is not influenced by the run direction
      phrase - the Phrase with the text
      x - the x reference position
      y - the y reference position
      rotation - the rotation to be applied in degrees counterclockwise
      runDirection - the run direction
      arabicOptions - the options for the arabic shaping

    • showTextAligned

      public static void showTextAligned(PdfContentByte canvas, int alignment, Phrase phrase, float x, float y, float rotation)
      Deprecated.
      Shows a line of text. Only the first line is written.
      Parameters:
      canvas - where the text is to be written to
      alignment - the alignment
      phrase - the Phrase with the text
      x - the x reference position
      y - the y reference position
      rotation - the rotation to be applied in degrees counterclockwise

    • hasMoreText

      public static boolean hasMoreText(int status)
      Deprecated.
      Checks the status variable and looks if there's still some text.
      Parameters:
      status - statues variable
      Returns:
      true if there's still some text else false

    • setACopy

      public ColumnText setACopy(ColumnText org)
      Deprecated.
      Makes this instance an independent copy of org.
      Parameters:
      org - the original ColumnText
      Returns:
      itself

    • setSimpleVars

      protected void setSimpleVars(ColumnText org)
      Deprecated.

    • addText

      public void addText(Phrase phrase)
      Deprecated.
      Adds a Phrase to the current text array. Will not have any effect if addElement() was called before.
      Parameters:
      phrase - the text

    • setText

      public void setText(Phrase phrase)
      Deprecated.
      Replaces the current text array with this Phrase. Anything added previously with addElement() is lost.
      Parameters:
      phrase - the text

    • addText

      public void addText(Chunk chunk)
      Deprecated.
      Adds a Chunk to the current text array. Will not have any effect if addElement() was called before.
      Parameters:
      chunk - the text

    • addElement

      public void addElement(Element element)
      Deprecated.
      Adds an element. Elements supported are Paragraph, List, PdfPTable, Image and Graphic.

      It removes all the text placed with addText().

      Parameters:
      element - the Element

    • convertColumn

      protected List<float[]> convertColumn(float[] cLine)
      Deprecated.
      Converts a sequence of lines representing one of the column bounds into an internal format.

      Each array element will contain a float[4] representing the line x = ax + b.

      Parameters:
      cLine - the column array
      Returns:
      the converted array

    • findLimitsPoint

      protected float findLimitsPoint(List<float[]> wall)
      Deprecated.
      Finds the intersection between the yLine and the column. It will set the lineStatus appropriately.
      Parameters:
      wall - the column to intersect
      Returns:
      the x coordinate of the intersection

    • findLimitsOneLine

      protected float[] findLimitsOneLine()
      Deprecated.
      Finds the intersection between the yLine and the two column bounds. It will set the lineStatus appropriately.
      Returns:
      a float[2]with the x coordinates of the intersection

    • findLimitsTwoLines

      protected float[] findLimitsTwoLines()
      Deprecated.
      Finds the intersection between the yLine, the yLine-leadingand the two column bounds. It will set the lineStatus appropriately.
      Returns:
      a float[4]with the x coordinates of the intersection

    • setColumns

      public void setColumns(float[] leftLine, float[] rightLine)
      Deprecated.
      Sets the columns bounds. Each column bound is described by a float[] with the line points [x1,y1,x2,y2,...]. The array must have at least 4 elements.
      Parameters:
      leftLine - the left column bound
      rightLine - the right column bound

    • setSimpleColumn

      public void setSimpleColumn(Phrase phrase, float llx, float lly, float urx, float ury, float leading, int alignment)
      Deprecated.
      Simplified method for rectangular columns.
      Parameters:
      phrase - a Phrase
      llx - the lower left x corner
      lly - the lower left y corner
      urx - the upper right x corner
      ury - the upper right y corner
      leading - the leading
      alignment - the column alignment

    • setSimpleColumn

      public void setSimpleColumn(float llx, float lly, float urx, float ury, float leading, int alignment)
      Deprecated.
      Simplified method for rectangular columns.
      Parameters:
      llx - the lower left x corner
      lly - the lower left y corner
      urx - the upper right x corner
      ury - the upper right y corner
      leading - the leading
      alignment - the column alignment

    • setSimpleColumn

      public void setSimpleColumn(float llx, float lly, float urx, float ury)
      Deprecated.
      Simplified method for rectangular columns.
      Parameters:
      llx - lower-left-x
      lly - lower-left-y
      urx - upper-right-x
      ury - upper-right-y

    • setLeading

      public void setLeading(float fixedLeading, float multipliedLeading)
      Deprecated.
      Sets the leading fixed and variable. The resultant leading will be fixedLeading+multipliedLeading*maxFontSize where maxFontSize is the size of the biggest font in the line.
      Parameters:
      fixedLeading - the fixed leading
      multipliedLeading - the variable leading

    • getLeading

      public float getLeading()
      Deprecated.
      Gets the fixed leading.
      Returns:
      the leading

    • setLeading

      public void setLeading(float leading)
      Deprecated.
      Sets the leading to fixed.
      Parameters:
      leading - the leading

    • getMultipliedLeading

      public float getMultipliedLeading()
      Deprecated.
      Gets the variable leading.
      Returns:
      the leading

    • getYLine

      public float getYLine()
      Deprecated.
      Gets the yLine.
      Returns:
      the yLine

    • setYLine

      public void setYLine(float yLine)
      Deprecated.
      Sets the yLine. The line will be written to yLine-leading.
      Parameters:
      yLine - the yLine

    • getAlignment

      public int getAlignment()
      Deprecated.
      Gets the alignment.
      Returns:
      the alignment

    • setAlignment

      public void setAlignment(int alignment)
      Deprecated.
      Sets the alignment.
      Parameters:
      alignment - the alignment

    • getIndent

      public float getIndent()
      Deprecated.
      Gets the first paragraph line indent.
      Returns:
      the indent

    • setIndent

      public void setIndent(float indent)
      Deprecated.
      Sets the first paragraph line indent.
      Parameters:
      indent - the indent

    • getFollowingIndent

      public float getFollowingIndent()
      Deprecated.
      Gets the following paragraph lines indent.
      Returns:
      the indent

    • setFollowingIndent

      public void setFollowingIndent(float indent)
      Deprecated.
      Sets the following paragraph lines indent.
      Parameters:
      indent - the indent

    • getRightIndent

      public float getRightIndent()
      Deprecated.
      Gets the right paragraph lines indent.
      Returns:
      the indent

    • setRightIndent

      public void setRightIndent(float indent)
      Deprecated.
      Sets the right paragraph lines indent.
      Parameters:
      indent - the indent

    • go

      public int go() throws DocumentException
      Deprecated.
      Outputs the lines to the document. It is equivalent to go(false).
      Returns:
      returns the result of the operation. It can be NO_MORE_TEXT and/or NO_MORE_COLUMN
      Throws:
      DocumentException - on error

    • go

      public int go(boolean simulate) throws DocumentException
      Deprecated.
      Outputs the lines to the document. The output can be simulated.
      Parameters:
      simulate - true to simulate the writing to the document
      Returns:
      returns the result of the operation. It can be NO_MORE_TEXT and/or NO_MORE_COLUMN
      Throws:
      DocumentException - on error

    • getExtraParagraphSpace

      public float getExtraParagraphSpace()
      Deprecated.
      Sets the extra space between paragraphs.
      Returns:
      the extra space between paragraphs

    • setExtraParagraphSpace

      public void setExtraParagraphSpace(float extraParagraphSpace)
      Deprecated.
      Sets the extra space between paragraphs.
      Parameters:
      extraParagraphSpace - the extra space between paragraphs

    • clearChunks

      public void clearChunks()
      Deprecated.
      Clears the chunk array. A call to go() will always return NO_MORE_TEXT.

    • getSpaceCharRatio

      public float getSpaceCharRatio()
      Deprecated.
      Gets the space/character extra spacing ratio for fully justified text.
      Returns:
      the space/character extra spacing ratio

    • setSpaceCharRatio

      public void setSpaceCharRatio(float spaceCharRatio)
      Deprecated.
      Sets the ratio between the extra word spacing and the extra character spacing when the text is fully justified. Extra word spacing will grow spaceCharRatio times more than extra character spacing. If the ratio is PdfWriter.NO_SPACE_CHAR_RATIO then the extra character spacing will be zero.
      Parameters:
      spaceCharRatio - the ratio between the extra word spacing and the extra character spacing

    • getRunDirection

      public int getRunDirection()
      Deprecated.
      Gets the run direction.
      Returns:
      the run direction

    • setRunDirection

      public void setRunDirection(int runDirection)
      Deprecated.
      Sets the run direction.
      Parameters:
      runDirection - the run direction

    • getLinesWritten

      public int getLinesWritten()
      Deprecated.
      Gets the number of lines written.
      Returns:
      the number of lines written

    • getArabicOptions

      public int getArabicOptions()
      Deprecated.
      Gets the arabic shaping options.
      Returns:
      the arabic shaping options

    • setArabicOptions

      public void setArabicOptions(int arabicOptions)
      Deprecated.
      Sets the arabic shaping options. The option can be AR_NOVOWEL, AR_COMPOSEDTASHKEEL and AR_LIG.
      Parameters:
      arabicOptions - the arabic shaping options

    • getDescender

      public float getDescender()
      Deprecated.
      Gets the biggest descender value of the last line written.
      Returns:
      the biggest descender value of the last line written

    • goComposite

      protected int goComposite(boolean simulate) throws DocumentException
      Deprecated.
      Throws:
      DocumentException

    • getCanvas

      public PdfContentByte getCanvas()
      Deprecated.
      Gets the canvas. If a set of four canvases exists, the TEXTCANVAS is returned.
      Returns:
      a PdfContentByte.

    • setCanvas

      public void setCanvas(PdfContentByte canvas)
      Deprecated.
      Sets the canvas. If before a set of four canvases was set, it is being unset.
      Parameters:
      canvas - an object of PdfContentByte

    • getCanvases

      public PdfContentByte[] getCanvases()
      Deprecated.
      Gets the canvases.
      Returns:
      an array of PdfContentByte

    • setCanvases

      public void setCanvases(PdfContentByte[] canvases)
      Deprecated.
      Sets the canvases.
      Parameters:
      canvases - an array of PdfContentByte

    • zeroHeightElement

      public boolean zeroHeightElement()
      Deprecated.
      Checks if the element has a height of 0.
      Returns:
      true or false
      Since:
      2.1.2

    • isUseAscender

      public boolean isUseAscender()
      Deprecated.
      Checks if UseAscender is enabled/disabled.
      Returns:
      true is the adjustment of the first line height is based on max ascender.

    • setUseAscender

      public void setUseAscender(boolean useAscender)
      Deprecated.
      Enables/Disables adjustment of first line height based on max ascender.
      Parameters:
      useAscender - enable adjustment if true

    • getFilledWidth

      public float getFilledWidth()
      Deprecated.
      Gets the real width used by the largest line.
      Returns:
      the real width used by the largest line

    • setFilledWidth

      public void setFilledWidth(float filledWidth)
      Deprecated.
      Sets the real width used by the largest line. Only used to set it to zero to start another measurement.
      Parameters:
      filledWidth - the real width used by the largest line

    • updateFilledWidth

      public void updateFilledWidth(float w)
      Deprecated.
      Replaces the filledWidth if greater than the existing one.
      Parameters:
      w - the new filledWidth if greater than the existing one

    • isAdjustFirstLine

      public boolean isAdjustFirstLine()
      Deprecated.
      Gets the first line adjustment property.
      Returns:
      the first line adjustment property.

    • setAdjustFirstLine

      public void setAdjustFirstLine(boolean adjustFirstLine)
      Deprecated.
      Sets the first line adjustment. Some objects have properties, like spacing before, that behave differently if the object is the first to be written after go() or not. The first line adjustment is true by default but can be changed if several objects are to be placed one after the other in the same column calling go() several times.
      Parameters:
      adjustFirstLine - true to adjust the first line, false otherwise

    • isStrictWordWrapping

      public boolean isStrictWordWrapping()
      Deprecated.
      Gets the strict word wrapping flag.
      Returns:
      true if strict word wrapping is enabled, false otherwise

    • setStrictWordWrapping

      public void setStrictWordWrapping(boolean strictWordWrapping)
      Deprecated.
      Sets the strict word wrapping flag. When enabled, throws StrictWordWrapException instead of forcing line breaks when text doesn't fit within column width.
      Parameters:
      strictWordWrapping - true to enable strict word wrapping, false to disable