nutrient/com.pspdfkit.datastructures/TextBlock

TextBlock

Represents a text located on a document page. This model contains the actual text the range (i.e. the start and end index of the text on the page), and a list of pageRects holding the PDF coordinates of the text.

Properties

pageIndex

@IntRange(from = 0)

val pageIndex: Int

Number of the page that this text block resides on.

pageRects

@NonNull

val pageRects: List<RectF>

PDF rects represented by this text block.

range

@NonNull

val range: Range

Actual text range (i.e.

text

@NonNull

val text: String

The represented string on the document.

Functions

compareTo

open fun compareTo(@NonNull another: TextBlock): Int

Compares this text block to another for ordering.

create

open fun create(@IntRange(from = 0) pageIndex: Int, @NonNull range: Range, @NonNull pageRects: List<RectF>, @NonNull text: String): TextBlock

Creates a TextBlock from the given page.

toString

open fun toString(): String

Returns a string representation of this text block, including the text, page index, range, and page rectangles.