com.compdfkit.core.page

Class CPDFTextPage

java.lang.Object

com.compdfkit.core.page.CPDFTextPage

public class CPDFTextPage
extends java.lang.Object

This class is about PDF page text content.

Method Summary

Modifier and Type	Method and Description
void	close() When the object is no longer in use, call this method to release resources.
java.lang.String	getBoundedText(android.graphics.RectF boundRect) Gets the text enclosed within the specified rectangle.
android.graphics.RectF	getCharBox(int index) Gets bounding box of the character by index.
int	getCharIndexAtPos(android.graphics.PointF point, float toleranceHor, float toleranceVer) Gets index of the character at or nearby a certain position on the page.
CPDFTextRange	getCharsRangeAtPos(android.graphics.PointF first, android.graphics.PointF second, float toleranceHor, float toleranceVer) Gets a range representing text between first and second.
int	getCountChars() Gets the count of all the characters on the page.
CPDFTextSelection	getSelectionForLineAtPos(android.graphics.PointF position) Given a point in page-space, gets a selection representing a whole line at that point.
CPDFTextSelection	getSelectionForWordPos(android.graphics.PointF position) Given a point in page-space, gets a selection representing a whole word at that point.
CPDFTextSelection[]	getSelectionsByLineForRange(CPDFTextRange textRange) Gets all the lines selection enclosed within the specified range.
CPDFTextSelection[]	getSelectionsByLineForRect(android.graphics.RectF rect) Gets all the lines selection enclosed within the specified rectangle, more: CPDFTextSelection
CPDFTextSelection[]	getSelectionsByTextForRange(CPDFTextRange textRange) Gets all the words selection enclosed within the specified range, more: CPDFTextSelection
java.lang.String	getText(CPDFTextRange range) Gets the text enclosed within the specified range.
boolean	isValid() Whether CPDFTextPage is valid.

Methods inherited from class java.lang.Object

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

Method Detail

isValid

public boolean isValid()

Whether CPDFTextPage is valid.

Returns:

Returns whether CPDFTextPage is valid.

getCountChars

public int getCountChars()

Gets the count of all the characters on the page.

Returns:

Returns the count of all the characters on the page.

getCharBox

public android.graphics.RectF getCharBox(int index)

Gets bounding box of the character by index.

Parameters:

index - Character index on the page.

Returns:

Returns bounding box of the character by index.

getText

public java.lang.String getText(CPDFTextRange range)

Gets the text enclosed within the specified range.

Parameters:

range - Text range, more: CPDFTextRange

Returns:

Returns the text enclosed within the specified range.

getBoundedText

public java.lang.String getBoundedText(android.graphics.RectF boundRect)

Gets the text enclosed within the specified rectangle.

Parameters:

boundRect - Rectangle for the given range of characters.

Returns:

Returns the text enclosed within the specified rectangle.

getCharIndexAtPos

public int getCharIndexAtPos(android.graphics.PointF point,
                             float toleranceHor,
                             float toleranceVer)

Gets index of the character at or nearby a certain position on the page.

Parameters:

point - The specified point in page-space.

toleranceHor - x-axis tolerance value for character hit detection, in point units.

toleranceVer - y-axis tolerance value for character hit detection, in point units.

Returns:

Returns index of the character at or nearby a certain position on the page.

getCharsRangeAtPos

public CPDFTextRange getCharsRangeAtPos(android.graphics.PointF first,
                                        android.graphics.PointF second,
                                        float toleranceHor,
                                        float toleranceVer)

Gets a range representing text between first and second. Points are sorted first top to bottom, left to right.

Parameters:

first - The first point between the two points.

second - The second point between the two points.

toleranceHor - x-axis tolerance value for character hit detection, in point units.

toleranceVer - y-axis tolerance value for character hit detection, in point units.

Returns:

Returns TextRange, more: CPDFTextRange Returns the text range of the two points.

getSelectionForWordPos

public CPDFTextSelection getSelectionForWordPos(android.graphics.PointF position)

Given a point in page-space, gets a selection representing a whole word at that point.

Parameters:

position - A point in page-space.

Returns:

Given a point in page-space, returns a selection representing a whole word at that point.

getSelectionForLineAtPos

public CPDFTextSelection getSelectionForLineAtPos(android.graphics.PointF position)

Given a point in page-space, gets a selection representing a whole line at that point.

Parameters:

position - A point in page-space.

Returns:

Given a point in page-space, returns a selection representing a whole line at that point, more: CPDFTextSelection

getSelectionsByLineForRange

public CPDFTextSelection[] getSelectionsByLineForRange(CPDFTextRange textRange)

Gets all the lines selection enclosed within the specified range.

Parameters:

textRange - Text range

Returns:

Returns all the lines selection enclosed within the specified range, more: CPDFTextSelection

getSelectionsByLineForRect

public CPDFTextSelection[] getSelectionsByLineForRect(android.graphics.RectF rect)

Gets all the lines selection enclosed within the specified rectangle, more: CPDFTextSelection

Parameters:

rect - Text rectangle.

Returns:

Returns all the lines selection enclosed within the specified rectangle.

getSelectionsByTextForRange

public CPDFTextSelection[] getSelectionsByTextForRange(CPDFTextRange textRange)

Gets all the words selection enclosed within the specified range, more: CPDFTextSelection

Parameters:

textRange - Text range, more: CPDFTextRange

Returns:

Returns all the words selection enclosed within the specified range.

close

public void close()

When the object is no longer in use, call this method to release resources.