BidiLine (root 5.5.9-SNAPSHOT API)

java.lang.Object
- com.itextpdf.text.pdf.BidiLine

```
public class BidiLine
extends Object
```
Does all the line bidirectional processing with PdfChunk assembly.

Author:

Paulo Soares

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`arabicOptions`
`protected ArrayList<PdfChunk>`	`chunks`
`protected int`	`currentChar`
`protected PdfChunk[]`	`detailChunks`
`protected int[]`	`indexChars`
`protected int`	`indexChunk`
`protected int`	`indexChunkChar`
`protected boolean`	`isWordSplit`
`protected static IntHashtable`	`mirrorChars`
`protected byte[]`	`orderLevels`
`protected int`	`pieceSize`
`protected int`	`runDirection`
`protected boolean`	`shortStore`
`protected int`	`storedCurrentChar`
`protected PdfChunk[]`	`storedDetailChunks`
`protected int[]`	`storedIndexChars`
`protected int`	`storedIndexChunk`
`protected int`	`storedIndexChunkChar`
`protected byte[]`	`storedOrderLevels`
`protected int`	`storedRunDirection`
`protected char[]`	`storedText`
`protected int`	`storedTotalTextLength`
`protected char[]`	`text`
`protected int`	`totalTextLength`

Constructor Summary

Constructors
Constructor and Description
`BidiLine()` Creates new BidiLine
`BidiLine(BidiLine org)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChunk(PdfChunk chunk)`
`void`	`addChunks(ArrayList<PdfChunk> chunks)`
`void`	`addPiece(char c, PdfChunk chunk)`
`void`	`clearChunks()`
`ArrayList<PdfChunk>`	`createArrayOfPdfChunks(int startIdx, int endIdx)`
`ArrayList<PdfChunk>`	`createArrayOfPdfChunks(int startIdx, int endIdx, PdfChunk extraPdfChunk)`
`void`	`doArabicShapping()`
`void`	`flip(int start, int end)`
`boolean`	`getParagraph(int runDirection)`
`float`	`getWidth(int startIdx, int lastIdx)` Gets the width of a range of characters.
`float`	`getWidth(int startIdx, int lastIdx, float originalWidth)` Gets the width of a range of characters.
`int[]`	`getWord(int startIdx, int idx)`
`boolean`	`isEmpty()`
`boolean`	`isWordSplit()` Call this after processLine() to know if any word was split into several lines.
`static boolean`	`isWS(char c)`
`void`	`mirrorGlyphs()`
`PdfLine`	`processLine(float leftX, float width, int alignment, int runDirection, int arabicOptions, float minY, float yLine, float descender)`
`static String`	`processLTR(String s, int runDirection, int arabicOptions)` Method that changes a String with Arabic characters into a String in which the ligatures are made.
`void`	`reorder(int start, int end)`
`void`	`restore()`
`void`	`save()`
`int`	`trimLeft(int startIdx, int endIdx)`
`int`	`trimLeftEx(int startIdx, int endIdx)`
`int`	`trimRight(int startIdx, int endIdx)`
`int`	`trimRightEx(int startIdx, int endIdx)`

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

Field Detail

runDirection
```
protected int runDirection
```

pieceSize
```
protected int pieceSize
```

text
```
protected char[] text
```

detailChunks
```
protected PdfChunk[] detailChunks
```

totalTextLength
```
protected int totalTextLength
```

orderLevels
```
protected byte[] orderLevels
```

indexChars
```
protected int[] indexChars
```

chunks
```
protected ArrayList<PdfChunk> chunks
```

indexChunk
```
protected int indexChunk
```

indexChunkChar
```
protected int indexChunkChar
```

currentChar
```
protected int currentChar
```

storedRunDirection
```
protected int storedRunDirection
```

storedText
```
protected char[] storedText
```

storedDetailChunks

protected PdfChunk[] storedDetailChunks

storedTotalTextLength
```
protected int storedTotalTextLength
```

storedOrderLevels
```
protected byte[] storedOrderLevels
```

storedIndexChars
```
protected int[] storedIndexChars
```

storedIndexChunk
```
protected int storedIndexChunk
```

storedIndexChunkChar
```
protected int storedIndexChunkChar
```

storedCurrentChar
```
protected int storedCurrentChar
```

isWordSplit
```
protected boolean isWordSplit
```

shortStore
```
protected boolean shortStore
```

mirrorChars

protected static final IntHashtable mirrorChars

arabicOptions
```
protected int arabicOptions
```

Constructor Detail
- BidiLine
```
public BidiLine()
```
  Creates new BidiLine
- BidiLine
```
public BidiLine(BidiLine org)
```

Method Detail

isEmpty
```
public boolean isEmpty()
```

clearChunks
```
public void clearChunks()
```

getParagraph

public boolean getParagraph(int runDirection)

addChunk
```
public void addChunk(PdfChunk chunk)
```

addChunks

public void addChunks(ArrayList<PdfChunk> chunks)

addPiece

public void addPiece(char c,
                     PdfChunk chunk)

save
```
public void save()
```

restore
```
public void restore()
```

mirrorGlyphs
```
public void mirrorGlyphs()
```

doArabicShapping
```
public void doArabicShapping()
```

processLine

public PdfLine processLine(float leftX,
                           float width,
                           int alignment,
                           int runDirection,
                           int arabicOptions,
                           float minY,
                           float yLine,
                           float descender)

isWordSplit
```
public boolean isWordSplit()
```
Call this after processLine() to know if any word was split into several lines.

Returns:

getWidth
```
public float getWidth(int startIdx,
                      int lastIdx)
```
Gets the width of a range of characters.

Parameters:

startIdx - the first index to calculate

lastIdx - the last inclusive index to calculate

Returns:

the sum of all widths

getWidth
```
public float getWidth(int startIdx,
                      int lastIdx,
                      float originalWidth)
```
Gets the width of a range of characters.

Parameters:

startIdx - the first index to calculate

lastIdx - the last inclusive index to calculate

originalWidth - the full width of the line. It is used in case of RTL and tab stops

Returns:

the sum of all widths

createArrayOfPdfChunks

public ArrayList<PdfChunk> createArrayOfPdfChunks(int startIdx,
                                                  int endIdx)

createArrayOfPdfChunks

public ArrayList<PdfChunk> createArrayOfPdfChunks(int startIdx,
                                                  int endIdx,
                                                  PdfChunk extraPdfChunk)

getWord

public int[] getWord(int startIdx,
                     int idx)

trimRight

public int trimRight(int startIdx,
                     int endIdx)

trimLeft

public int trimLeft(int startIdx,
                    int endIdx)

trimRightEx

public int trimRightEx(int startIdx,
                       int endIdx)

trimLeftEx

public int trimLeftEx(int startIdx,
                      int endIdx)

reorder

public void reorder(int start,
                    int end)

flip

public void flip(int start,
                 int end)

isWS
```
public static boolean isWS(char c)
```

processLTR
```
public static String processLTR(String s,
                                int runDirection,
                                int arabicOptions)
```
Method that changes a String with Arabic characters into a String in which the ligatures are made.

Parameters:

s - the original String

runDirection -

arabicOptions -

Returns:

the String with the ligatures

Class BidiLine

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

runDirection

pieceSize

text

detailChunks

totalTextLength

orderLevels

indexChars

chunks

indexChunk

indexChunkChar

currentChar

storedRunDirection

storedText

storedDetailChunks

storedTotalTextLength

storedOrderLevels

storedIndexChars

storedIndexChunk

storedIndexChunkChar

storedCurrentChar

isWordSplit

shortStore

mirrorChars

arabicOptions

Constructor Detail

BidiLine

BidiLine

Method Detail

isEmpty

clearChunks

getParagraph

addChunk

addChunks

addPiece

save

restore

mirrorGlyphs

doArabicShapping

processLine

isWordSplit

getWidth

getWidth

createArrayOfPdfChunks

createArrayOfPdfChunks

getWord

trimRight

trimLeft

trimRightEx

trimLeftEx

reorder

flip

isWS

processLTR