pspdfkit/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

annotation

@Nullable

val annotation: Annotation

Annotation that contains the text.

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

create

open fun create(@NonNull document: PdfDocument, @NonNull annotation: Annotation, @NonNull range: Range): TextBlock

Creates TextBlock from textual annotation.

open fun create(@NonNull document: PdfDocument, @IntRange(from = 0) pageIndex: Int, @NonNull range: Range): TextBlock

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.

getTextForBlocks

@NonNull

open fun getTextForBlocks(@NonNull document: PdfDocument, @NonNull textBlocks: List<TextBlock>): String

Returns page text for a list of text blocks.

toString

open fun toString(): String