PdfTextFormatter (Gnostice PDFOne (for Java) API Docs)

java.lang.Object
- com.gnostice.pdfone.PdfTextFormatter

All Implemented Interfaces:

Cloneable
```
public class PdfTextFormatter
extends Object
implements Cloneable
```
This class is used to retrieve and specify settings related to text formatting. A single instance of the class can be associated with multiple PdfPage objects. An object of this class is returned when getTextFormatter method is used on a PdfPage object. Formatting settings specified on the PdfTextFormatter object will affect subsequent calls to writeText method for the page.
The text formatting attributes supported by this class are as follows:
- alignment of text to
  - left margin,
  - right margin,
  - both left and right margins, and
  - center.
- wrapping of text
- position of first line inside a rectangle
- alignment of last line to both left and right margins
An object of the PdfTextFormatter class has the following settings as default:
- text wraps
- text is aligned to left margin
- first line is positioned at 0 measurement units inside rectangles
- last line is not aligned to both margins (that is aligned only to the left margin)
Since:

1.0

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CENTER` Constant to align text to center.
`static int`	`HORIZONTAL`
`static int`	`JUSTIFIED` Constant to align text to both left and right margins.
`static int`	`LEFT` Constant to align text to left margin.
`static int`	`LEFT_TO_RIGHT`
`static boolean`	`NO_WRAP` Constant to prevent text wrapping.
`static int`	`RIGHT` Constant to align text to right margin.
`static int`	`RIGHT_TO_LEFT`
`static int`	`VERTICAL`
`static boolean`	`WRAP` Constant to wrap text.

Constructor Summary

Constructors
Constructor and Description

PdfTextFormatter()
Zero-argument default constructor.

Constructors
Constructor and Description
`PdfTextFormatter()` Zero-argument default constructor.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Object`	`clone()`
`int`	`getAlignment()` Retrieves text alignment.
`double`	`getCharSpacing()`
`int`	`getDirection()`
`double`	`getFirstLinePosition()` Retrieves default position where first line of text is set to be written inside rectangles.
`double`	`getHorizontalScaling()`
`double`	`getLineSpacing()`
`double`	`getRise()` Deprecated.
`double`	`getScaling()` Deprecated.
`double`	`getWordSpacing()`
`int`	`getWritingMode()`
`boolean`	`isJustifyLastLine()` Retrieves whether last line is aligned to both left and right margins.
`boolean`	`isWrap()` Retrieves whether text is set to wrap.
`void`	`setAlignment(int alignment)` Specifies text alignment.
`void`	`setCharSpacing(double charSpacing)`
`void`	`setDirection(int direction)`
`void`	`setFirstLinePosition(double firstLinePosition)` Specifies default position where first line of text should be written inside rectangles.
`void`	`setHorizontalScaling(double horizontalScaleInPercentage)`
`void`	`setJustifyLastLine(boolean justifyLastLine)` Specifies whether last line should be aligned to both left and right margins.
`void`	`setLineSpacing(double lineSpacing)`
`void`	`setRise(double rise)` Deprecated.
`void`	`setScaling(double scaling)` Deprecated.
`void`	`setWordSpacing(double wordSpacing)`
`void`	`setWrap(boolean wrap)` Specifies whether text should wrap.
`void`	`setWritingMode(int writingMode)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - WRAP
```
public static final boolean WRAP
```
    Constant to wrap text.
    
    See Also:
    
    Constant Field Values
  - NO_WRAP
```
public static final boolean NO_WRAP
```
    Constant to prevent text wrapping.
    
    See Also:
    
    Constant Field Values
  - LEFT
```
public static final int LEFT
```
    Constant to align text to left margin.
    
    See Also:
    
    Constant Field Values
  - RIGHT
```
public static final int RIGHT
```
    Constant to align text to right margin.
    
    See Also:
    
    Constant Field Values
  - CENTER
```
public static final int CENTER
```
    Constant to align text to center.
    
    See Also:
    
    Constant Field Values
  - JUSTIFIED
```
public static final int JUSTIFIED
```
    Constant to align text to both left and right margins.
    
    See Also:
    
    Constant Field Values
  - HORIZONTAL
```
public static final int HORIZONTAL
```
    See Also:
    
    Constant Field Values
  - VERTICAL
```
public static final int VERTICAL
```
    See Also:
    
    Constant Field Values
  - LEFT_TO_RIGHT
```
public static final int LEFT_TO_RIGHT
```
    See Also:
    
    Constant Field Values
  - RIGHT_TO_LEFT
```
public static final int RIGHT_TO_LEFT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PdfTextFormatter
```
public PdfTextFormatter()
```
    Zero-argument default constructor.
- Method Detail
  - clone
```
public Object clone()
```
    Overrides:
    
    clone in class Object
  - getAlignment
```
public int getAlignment()
```
    Retrieves text alignment.
    
    Returns:
    
    constant identifying text alignment
    
    Since:
    
    1.0
    
    See Also:
    
    setAlignment(int)
    
    Example
    
    See example.
  - setAlignment
```
public void setAlignment(int alignment)
```
    Specifies text alignment.
    
    Parameters:
    
    alignment - constant specifying text alignment
    
    Since:
    
    1.0
    
    See Also:
    
    getAlignment()
    
    Example
    
    See example.
  - getCharSpacing
```
public double getCharSpacing()
```
  - setCharSpacing
```
public void setCharSpacing(double charSpacing)
```
  - getDirection
```
public int getDirection()
```
  - setDirection
```
public void setDirection(int direction)
```
  - getLineSpacing
```
public double getLineSpacing()
```
  - setLineSpacing
```
public void setLineSpacing(double lineSpacing)
```
  - getRise
```
public double getRise()
```
    Deprecated.
  - setRise
```
public void setRise(double rise)
```
    Deprecated.
  - getScaling
```
public double getScaling()
```
    Deprecated.
  - setScaling
```
public void setScaling(double scaling)
```
    Deprecated.
  - getHorizontalScaling
```
public double getHorizontalScaling()
```
  - setHorizontalScaling
```
public void setHorizontalScaling(double horizontalScaleInPercentage)
```
  - getWordSpacing
```
public double getWordSpacing()
```
  - setWordSpacing
```
public void setWordSpacing(double wordSpacing)
```
  - isWrap
```
public boolean isWrap()
```
    Retrieves whether text is set to wrap.
    
    Returns:
    
    constant identifying whether text is set to wrap
    
    Since:
    
    1.0
    
    See Also:
    
    setWrap(boolean)
    
    Example
    
    See example.
  - setWrap
```
public void setWrap(boolean wrap)
```
    Specifies whether text should wrap.
    
    Parameters:
    
    wrap - constant specifying whether text needs to wrapped
    
    Since:
    
    1.0
    
    See Also:
    
    isWrap()
    
    Example
    
    See example.
  - getWritingMode
```
public int getWritingMode()
```
  - setWritingMode
```
public void setWritingMode(int writingMode)
```
  - getFirstLinePosition
```
public double getFirstLinePosition()
```
    Retrieves default position where first line of text is set to be written inside rectangles.
    
    Returns:
    
    default position inside rectangles where the first line of text is set to begin (Expressed in current measurement unit)
    
    Since:
    
    1.0
    
    See Also:
    
    setFirstLinePosition(double)
    
    Example
    
    See example.
  - setFirstLinePosition
```
public void setFirstLinePosition(double firstLinePosition)
```
    Specifies default position where first line of text should be written inside rectangles. firstLinePosition must be less than the total width of the rectangle. Else, the first line defaults to the first position on the second line.
    
    Parameters:
    
    firstLinePosition - default position inside rectangles where the first line of text should begin (Applied in current measurement unit)
    
    Since:
    
    1.0
    
    See Also:
    
    getFirstLinePosition()
    
    Example
    
    See example.
  - isJustifyLastLine
```
public boolean isJustifyLastLine()
```
    Retrieves whether last line is aligned to both left and right margins.
    
    Returns:
    
    true if last line is aligned to both left and right margins. false if otherwise.
    
    Since:
    
    1.0
    
    See Also:
    
    setJustifyLastLine(boolean)
    
    Example
    
    See example.
  - setJustifyLastLine
```
public void setJustifyLastLine(boolean justifyLastLine)
```
    Specifies whether last line should be aligned to both left and right margins. When text is aligned to both margins, it can suffer from poor readability. When there is not enough text on the last line, words might be written far apart from each other.
    
    Parameters:
    
    justifyLastLine - true aligns last line text to both left and right margins. false defaults the alignment to the left margin.
    
    Since:
    
    1.0
    
    See Also:
    
    isJustifyLastLine()
    
    Example
    
    See example.

Class PdfTextFormatter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

WRAP

NO_WRAP

LEFT

RIGHT

CENTER

JUSTIFIED

HORIZONTAL

VERTICAL

LEFT_TO_RIGHT

RIGHT_TO_LEFT

Constructor Detail

PdfTextFormatter

Method Detail

clone

getAlignment

setAlignment

getCharSpacing

setCharSpacing

getDirection

setDirection

getLineSpacing

setLineSpacing

getRise

setRise

getScaling

setScaling

getHorizontalScaling

setHorizontalScaling

getWordSpacing

setWordSpacing

isWrap

setWrap

getWritingMode

setWritingMode

getFirstLinePosition

setFirstLinePosition

isJustifyLastLine

setJustifyLastLine