Class LocationTextExtractionStrategy.TextChunkLocationDefaultImp

java.lang.Object

com.itextpdf.text.pdf.parser.LocationTextExtractionStrategy.TextChunkLocationDefaultImp

All Implemented Interfaces:

LocationTextExtractionStrategy.TextChunkLocation, Comparable<LocationTextExtractionStrategy.TextChunkLocation>

Enclosing class:

LocationTextExtractionStrategy

public static class LocationTextExtractionStrategy.TextChunkLocationDefaultImp
extends Object
implements LocationTextExtractionStrategy.TextChunkLocation

Since:

5.0.2

Field Summary

Fields

Modifier and Type	Field	Description
private final float	charSpaceWidth	the width of a single space character in the font of the chunk
private final float	distParallelEnd	distance of the end of the chunk parallel to the orientation unit vector (i.e.
private final float	distParallelStart	distance of the start of the chunk parallel to the orientation unit vector (i.e.
private final int	distPerpendicular	perpendicular distance to the orientation unit vector (i.e.
private final Vector	endLocation	the ending location of the chunk
private final int	orientationMagnitude	the orientation as a scalar for quick sorting
private final Vector	orientationVector	unit vector in the orientation of the chunk
private final Vector	startLocation	the starting location of the chunk

Constructor Summary

Constructors

Constructor	Description
TextChunkLocationDefaultImp(Vector startLocation, Vector endLocation, float charSpaceWidth)

Method Summary

Modifier and Type	Method	Description
int	compareTo(LocationTextExtractionStrategy.TextChunkLocation other)
float	distanceFromEndOf(LocationTextExtractionStrategy.TextChunkLocation other)	Computes the distance between the end of 'other' and the beginning of this chunk in the direction of this chunk's orientation vector.
float	distParallelEnd()
float	distParallelStart()
int	distPerpendicular()
float	getCharSpaceWidth()
Vector	getEndLocation()
Vector	getStartLocation()
boolean	isAtWordBoundary(LocationTextExtractionStrategy.TextChunkLocation previous)
int	orientationMagnitude()
boolean	sameLine(LocationTextExtractionStrategy.TextChunkLocation as)

Methods inherited from class Object

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

Field Details

startLocation

private final Vector startLocation

the starting location of the chunk

endLocation

private final Vector endLocation

the ending location of the chunk

orientationVector

private final Vector orientationVector

unit vector in the orientation of the chunk

orientationMagnitude

private final int orientationMagnitude

the orientation as a scalar for quick sorting

distPerpendicular

private final int distPerpendicular

perpendicular distance to the orientation unit vector (i.e. the Y position in an unrotated coordinate system) we round to the nearest integer to handle the fuzziness of comparing floats

distParallelStart

private final float distParallelStart

distance of the start of the chunk parallel to the orientation unit vector (i.e. the X position in an unrotated coordinate system)

distParallelEnd

private final float distParallelEnd

distance of the end of the chunk parallel to the orientation unit vector (i.e. the X position in an unrotated coordinate system)

charSpaceWidth

private final float charSpaceWidth

the width of a single space character in the font of the chunk

Constructor Details

TextChunkLocationDefaultImp

public TextChunkLocationDefaultImp(Vector startLocation,
 Vector endLocation,
 float charSpaceWidth)

Method Details

orientationMagnitude

public int orientationMagnitude()

Specified by:

orientationMagnitude in interface LocationTextExtractionStrategy.TextChunkLocation

distPerpendicular

public int distPerpendicular()

Specified by:

distPerpendicular in interface LocationTextExtractionStrategy.TextChunkLocation

distParallelStart

public float distParallelStart()

Specified by:

distParallelStart in interface LocationTextExtractionStrategy.TextChunkLocation

distParallelEnd

public float distParallelEnd()

Specified by:

distParallelEnd in interface LocationTextExtractionStrategy.TextChunkLocation

getStartLocation

public Vector getStartLocation()

Specified by:

getStartLocation in interface LocationTextExtractionStrategy.TextChunkLocation

Returns:

the start location of the text

getEndLocation

public Vector getEndLocation()

Specified by:

getEndLocation in interface LocationTextExtractionStrategy.TextChunkLocation

Returns:

the end location of the text

getCharSpaceWidth

public float getCharSpaceWidth()

Specified by:

getCharSpaceWidth in interface LocationTextExtractionStrategy.TextChunkLocation

Returns:

the width of a single space character as rendered by this chunk

sameLine

public boolean sameLine(LocationTextExtractionStrategy.TextChunkLocation as)

Specified by:

sameLine in interface LocationTextExtractionStrategy.TextChunkLocation

Parameters:

as - the location to compare to

Returns:

true is this location is on the the same line as the other

distanceFromEndOf

public float distanceFromEndOf(LocationTextExtractionStrategy.TextChunkLocation other)

Computes the distance between the end of 'other' and the beginning of this chunk in the direction of this chunk's orientation vector. Note that it's a bad idea to call this for chunks that aren't on the same line and orientation, but we don't explicitly check for that condition for performance reasons.

Specified by:

distanceFromEndOf in interface LocationTextExtractionStrategy.TextChunkLocation

Parameters:

other -

Returns:

the number of spaces between the end of 'other' and the beginning of this chunk

isAtWordBoundary

public boolean isAtWordBoundary(LocationTextExtractionStrategy.TextChunkLocation previous)

Specified by:

isAtWordBoundary in interface LocationTextExtractionStrategy.TextChunkLocation

compareTo

public int compareTo(LocationTextExtractionStrategy.TextChunkLocation other)

Specified by:

compareTo in interface Comparable<LocationTextExtractionStrategy.TextChunkLocation>