com.qoppa.pdf

Interface TextSelection

All Known Implementing Classes:

TextPosition, TextPositionWithContext

public interface TextSelection

Interface that describes selected text. The interface provides methods to get a Shape object and a quadrilateral that encloses the text selection on the page as well as a method to retrieve the selected text as a string.

Author:

Qoppa Software

Method Summary

Modifier and Type	Method and Description
List<Point2D[]>	getPDFQuadrilaterals() Returns a list of quadrilaterals for the text selection areas.
Shape	getPDFSelectionShape() Returns the entire shape that encloses all different word groups in this selection.
Vector<Point2D[]>	getQuadrilaterals() Deprecated. replaced by getPDFQuadrilaterals().
Shape	getSelectionShape() Deprecated. replaced by getViewSelectionShape().
String	getText() Returns a string containing all the selected text.
String	getText(boolean lineBreaks) Returns a string containing all the selected text.
List<Point2D[]>	getViewQuadrilaterals() Returns a list of quadrilaterals for the text selection areas.
Shape	getViewSelectionShape() Returns the entire shape that encloses all different word groups in this selection.

Method Detail

getSelectionShape

@Deprecated
Shape getSelectionShape()

Deprecated. replaced by getViewSelectionShape().

Returns the entire shape that encloses all different word groups in this selection. The shape's coordinate system is in 'display' coordinates: The origin of the coordinates are page.getCropBox().getX() and page.getCropBox().getY().

Returns:

A Shape, possibly composed of a number of subshapes, that holds all the selection area.

getPDFSelectionShape

Shape getPDFSelectionShape()

Returns the entire shape that encloses all different word groups in this selection. The shape's coordinate system is in MediaBox coordinates.

Returns:

A Shape, possibly composed of a number of subshapes, that holds all the selection area.

getViewSelectionShape

Shape getViewSelectionShape()

Returns the entire shape that encloses all different word groups in this selection. The shape's coordinate system is in 'display' coordinates: The origin of the coordinates are page.getCropBox().getX() and page.getCropBox().getY().

Returns:

A Shape, possibly composed of a number of subshapes, that holds all the selection area.

getText

String getText()

Returns a string containing all the selected text. Lines within paragraphs will be separated with spaces.

Returns:

A string containing all the selected text. Lines within paragraphs will be separated with spaces.

getText

String getText(boolean lineBreaks)

Returns a string containing all the selected text.

Parameters:

lineBreaks - If set to true, lines within paragraphs will be split into separate lines. If set to false, lines within paragraphs will be separated with spaces.

Returns:

A string containing all the selected text.

getQuadrilaterals

@Deprecated
Vector<Point2D[]> getQuadrilaterals()

Deprecated. replaced by getPDFQuadrilaterals().

Returns a list of quadrilaterals for the text selection areas. The coordinates of the quadrilaterals is in MediaBox space.

Returns:

A vector of Point2D arrays, each array containing 4 points. The points in each array can be connected by lines in the array order to form the quadrilateral enclosing each selection area.

getPDFQuadrilaterals

List<Point2D[]> getPDFQuadrilaterals()

Returns a list of quadrilaterals for the text selection areas. The coordinates of the quadrilaterals is in MediaBox space.

Returns:

A vector of Point2D arrays, each array containing 4 points. The points in each array can be connected by lines in the array order to form the quadrilateral enclosing each selection area.

getViewQuadrilaterals

List<Point2D[]> getViewQuadrilaterals()

Returns a list of quadrilaterals for the text selection areas. The coordinates of the quadrilaterals is in display space.

Returns:

A vector of Point2D arrays, each array containing 4 points. The points in each array can be connected by lines in the array order to form the quadrilateral enclosing each selection area.