org.jpedal.text

Class TextLines

java.lang.Object

org.jpedal.text.TextLines

public class TextLines
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
Map<Integer,int[][]>	areas Highlight Areas stored here

Constructor Summary

Constructors

Constructor and Description
TextLines()

Method Summary

Modifier and Type	Method and Description
void	addHighlights(int[][] highlights, boolean areaSelect, int page) Method to highlight text on page.
void	addToLineAreas(int[] area, int writingMode, int page)
void	clearHighlights() Clear all highlights that are being displayed
Map	getAllHighlights() Get all the highlights currently stored.
int[][]	getHighlightableInArea(int[] highlights, boolean areaSelect, int page)
int[][]	getHighlightedAreasAs2DArray(int page) Creates a two-dimensional int array containing x,y,width and height values for each rectangle that is stored in the localAreas map, which allows us to create a swing/fx rectangle on these values.
int[][]	getLineAreasAs2DArray(int page) Creates a two-dimensional int array containing x,y,width and height values for each rectangle that is stored in the localLineAreas map, which allows us to create a swing/fx rectangle on these values.
int[]	getLineWritingMode(int page)
boolean	hasHighlightAreasUpdated()
static boolean	intersects(int[] paramsOne, int[] paramsTwo) Checks whether two rectangles intersect Takes the raw x,y,w,h data of the rectangles in array form.
void	removeFoundTextArea(int[] rectArea, int page) remove zone on page for text localAreas if present
void	removeFoundTextAreas(int[][] rectArea, int page) remove highlight zones on page for text localAreas on single pages null value will totally reset
int[]	setFoundParagraphAsArray(int x, int y, int page) Highlights a section of lines that form a paragraph and returns the area that encloses all highlight localAreas.
void	setLineAreas(Map<Integer,int[][]> la)
void	setLineWritingMode(Map<Integer,int[]> lineOrientation)

Methods inherited from class java.lang.Object

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

Field Detail

areas

public Map<Integer,int[][]> areas

Highlight Areas stored here

Constructor Detail

TextLines

public TextLines()

Method Detail

setFoundParagraphAsArray

public int[] setFoundParagraphAsArray(int x,
                                      int y,
                                      int page)

Highlights a section of lines that form a paragraph and returns the area that encloses all highlight localAreas.

Parameters:

x - Coord x value to begin looking for a paragraph

y - Coord y value to begin looking for a paragraph

page - Page number of page to look for a paragraph on

Returns:

int[] that contains x,y,w,h of all localAreas highlighted

addToLineAreas

public void addToLineAreas(int[] area,
                           int writingMode,
                           int page)

removeFoundTextArea

public void removeFoundTextArea(int[] rectArea,
                                int page)

remove zone on page for text localAreas if present

Parameters:

rectArea - Text area to remove

page - Page to check for these localAreas

removeFoundTextAreas

public void removeFoundTextAreas(int[][] rectArea,
                                 int page)

remove highlight zones on page for text localAreas on single pages null value will totally reset

Parameters:

rectArea - Text localAreas to remove

page - Page to check for these localAreas

clearHighlights

public void clearHighlights()

Clear all highlights that are being displayed

addHighlights

public void addHighlights(int[][] highlights,
                          boolean areaSelect,
                          int page)

Method to highlight text on page.

If areaSelect = true then the Rectangle array will be highlgihted on screen unmodified. areaSelect should be true if being when used with values returned from the search as these localAreas are already corrected and modified for display.

If areaSelect = false then all lines between the top left point and bottom right point will be selected including two partial lines the top line starting from the top left point of the rectangle and the bottom line ending at the bottom right point of the rectangle.

Parameters:

highlights - :: The 2DArray contains the raw x,y,w,h params of a set of rectangles that you wish to have highlighted

areaSelect - :: The flag that will either select text as line between points if false or characters within an area if true.

page - :: The page to add highlights to.

getHighlightableInArea

public int[][] getHighlightableInArea(int[] highlights,
                                      boolean areaSelect,
                                      int page)

hasHighlightAreasUpdated

public boolean hasHighlightAreasUpdated()

getAllHighlights

public Map getAllHighlights()

Get all the highlights currently stored. The returned Map using the page numbers as the keys for the values.

Returns:

A Map containing all highlights currently stored.

getHighlightedAreasAs2DArray

public int[][] getHighlightedAreasAs2DArray(int page)

Creates a two-dimensional int array containing x,y,width and height values for each rectangle that is stored in the localAreas map, which allows us to create a swing/fx rectangle on these values.

Parameters:

page - of type int.

Returns:

an int[][] Containing x,y,w,h of Highlights on Page.

setLineAreas

public void setLineAreas(Map<Integer,int[][]> la)

setLineWritingMode

public void setLineWritingMode(Map<Integer,int[]> lineOrientation)

getLineAreasAs2DArray

public int[][] getLineAreasAs2DArray(int page)

Creates a two-dimensional int array containing x,y,width and height values for each rectangle that is stored in the localLineAreas map, which allows us to create a swing/fx rectangle on these values.

Parameters:

page - of type int.

Returns:

an int[][] Containing x,y,w,h of line localAreas on Page.

getLineWritingMode

public int[] getLineWritingMode(int page)

intersects

public static boolean intersects(int[] paramsOne,
                                 int[] paramsTwo)

Checks whether two rectangles intersect Takes the raw x,y,w,h data of the rectangles in array form.

Parameters:

paramsOne -

paramsTwo -

Returns:

boolean