org.jpedal.parser

Class DecoderOptions

java.lang.Object

org.jpedal.parser.DecoderOptions

public class DecoderOptions
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
int	altColorThreshold
Color	altDisplayBackground
Color	altPageColor page colour for PDF background
Color	altTextColor
static Color	backgroundColor The colour of the text once highlighted
static boolean	embedWidthData flag to tell software to embed x point after each character so we can merge any overlapping text together
boolean	enhanceFractionalLines
static JPedalHelper	Helper
static Color	highlightColor The colour of the highlighting box around the text
static float	highlightComposite The transparency of the highlighting box around the text stored as a float
int	insetH
int	insetW allow for inset of display
static boolean	isRunningOnAIX
static boolean	isRunningOnLinux
static boolean	isRunningOnMac flag to show if on mac so we can code around certain bugs
static boolean	isRunningOnWindows
static float	javaVersion version number
int	scrollInterval amount we scroll screen to make visible
static boolean	showErrorMessages flag to enable popup of error messages in JPedal
static boolean	showMouseBox

Constructor Summary

Constructors

Constructor and Description
DecoderOptions()

Method Summary

Modifier and Type	Method and Description
PdfGroupingAlgorithms	getBackgroundGroupingObject(PdfData pdfBackgroundData) returns object containing grouped text from background grouping - Please see org.jpedal.examples.text for example code
boolean	getChangeTextAndLine() Flag that shows if shapes should have colours changed when preferences set to change document text colours
PageOffsets	getCurrentOffsets() Get the page offsets and sizes for the whole document for various display modes
Color	getDisplayBackgroundColor() Gets the alternative colour for the display areas background when the option is set.
int	getDisplayView() Get the current display view being used
static int[]	getFormsNoPrint() Get a list of Form types and subtypes that should not be printed
PdfGroupingAlgorithms	getGroupingObject(int lastPageDecoded, PdfData textData) returns object containing grouped text of last decoded page - if no page decoded, a Runtime exception is thrown to warn user Please see org.jpedal.examples.text for example code.
float	getImageDimensions(int pageIndex, PdfPageData pageData) Get the scaling values to be used when converting a page to an image
int	getInsetH() Vertical inset applied to page to move away from the displays edge
int	getInsetW() Horizontal inset applied to page to move away from the displays edge
Boolean	getInstance_allowPagesSmallerThanPageSize() Flag to control if image conversion can create pages smaller than the original
Integer	getInstance_bestQualityMaxScaling() Flag to control the maximum value the scaling for image conversion can be
int[]	getInstance_FormsNoPrint() Get a list of Form types and subtypes that should not be printed
Paint	getNonDrawnPageColor() Gets the Paint to be used when drawing a page that has not been drawn on yet
int	getPageAlignment() Get the alignment of the pages such as left aligned or centred - Please see org.jpedal.display for display view flags
Color	getPageColor() Get the alternative page colour to be used when the option is set.
int	getPageMode() Get the current page mode being used
Boolean	getPageSizeToUse() Flag to check if we should override page size during image conversion
boolean	getRenderPage() Flag to show if pages are being rendered
int	getReplacementColorThreshold() Set the threshold to be used when replacing text and line colours with alternative.
int	getScrollInterval() The scroll interval to be used when scrolling in the viewer
Color	getTextColor() Get the alternative text colour to be used when the option is set.
boolean	isEnhanceFractionalLines() Flag used to control if we enhance thin lines (width of less than 1) to ensure its width never drops below 1.
boolean	isXMLExtraction() Flag to control if text extraction should extract as XML
static void	modifyJPedalParameters(Map values) Allow the modification of various parameters to customise different aspects of rendering and / or extraction
void	set(Map values) Set options to be used in page rendering, printing and image conversion
void	setCurrentOffsets(PageOffsets newOffset) Set the offsets for the current document
void	setDisplayView(int displayView) Set the display view being used in the display
void	setInset(int width, int height) Set an inset so page does not touch the display area edge
void	setPageAlignment(int orientation) Set the alignment of the pages such as left aligned or centred - Please see org.jpedal.display for display view flags
void	setPageMode(int mode) Set the page mode being used
void	setRenderPage(boolean newRender) Controls if pages are being rendered or not
void	setScrollInterval(int scrollInterval) Set the scroll interval to be used when scrolling in the viewer
void	setXMLExtraction(boolean XMLExtraction) Set if future text extractions should output as XML or text
boolean	useHardwareAcceleration() Flag to specify if the viewer should use hardware acceleration when rendering pages
void	useHardwareAcceleration(boolean newValue) Specify if the viewer should use hardware acceleration when rendering pages
void	useXMLExtraction() Set extraction mode to XML extraction - pure text extraction is much faster

Methods inherited from class java.lang.Object

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

Field Detail

javaVersion

public static float javaVersion

version number

highlightComposite

public static float highlightComposite

The transparency of the highlighting box around the text stored as a float

showMouseBox

public static boolean showMouseBox

showErrorMessages

public static boolean showErrorMessages

flag to enable popup of error messages in JPedal

isRunningOnMac

public static boolean isRunningOnMac

flag to show if on mac so we can code around certain bugs

isRunningOnWindows

public static boolean isRunningOnWindows

isRunningOnAIX

public static boolean isRunningOnAIX

isRunningOnLinux

public static boolean isRunningOnLinux

embedWidthData

public static boolean embedWidthData

flag to tell software to embed x point after each character so we can merge any overlapping text together

Helper

public static JPedalHelper Helper

scrollInterval

public int scrollInterval

amount we scroll screen to make visible

insetW

public int insetW

allow for inset of display

insetH

public int insetH

highlightColor

public static Color highlightColor

The colour of the highlighting box around the text

backgroundColor

public static Color backgroundColor

The colour of the text once highlighted

altPageColor

public Color altPageColor

page colour for PDF background

altTextColor

public Color altTextColor

altDisplayBackground

public Color altDisplayBackground

altColorThreshold

public int altColorThreshold

enhanceFractionalLines

public boolean enhanceFractionalLines

Constructor Detail

DecoderOptions

public DecoderOptions()

Method Detail

isXMLExtraction

public boolean isXMLExtraction()

Flag to control if text extraction should extract as XML

Returns:

True if extraction should output XML, false otherwise

setXMLExtraction

public void setXMLExtraction(boolean XMLExtraction)

Set if future text extractions should output as XML or text

Parameters:

XMLExtraction - True if extraction should output XML, false otherwise

setPageMode

public void setPageMode(int mode)

Set the page mode being used

Parameters:

mode - int value representing the current display view - Please see org.jpedal.display for display view flags

getPageMode

public int getPageMode()

Get the current page mode being used

Returns:

int value representing the current display view - Please see org.jpedal.display for display view flags

getInsetH

public int getInsetH()

Vertical inset applied to page to move away from the displays edge

Returns:

int value representing the vertical inset

getInsetW

public int getInsetW()

Horizontal inset applied to page to move away from the displays edge

Returns:

int value representing the horizontal inset

getScrollInterval

public int getScrollInterval()

The scroll interval to be used when scrolling in the viewer

Returns:

int value presenting the interval to move per scroll unit

setScrollInterval

public void setScrollInterval(int scrollInterval)

Set the scroll interval to be used when scrolling in the viewer

Parameters:

scrollInterval - int value presenting the interval to move per scroll unit

setInset

public final void setInset(int width,
                           int height)

Set an inset so page does not touch the display area edge

Parameters:

width - int value representing the horizontal inset

height - int value representing the vertical inset

useXMLExtraction

public void useXMLExtraction()

Set extraction mode to XML extraction - pure text extraction is much faster

getGroupingObject

public PdfGroupingAlgorithms getGroupingObject(int lastPageDecoded,
                                               PdfData textData)
                                        throws PdfException

returns object containing grouped text of last decoded page - if no page decoded, a Runtime exception is thrown to warn user Please see org.jpedal.examples.text for example code.

Parameters:

lastPageDecoded - int value of the last page decoded

textData - PdfData object holding the text data from the file

Returns:

PdfGroupingAlgorithms object build from the provided PdfData object

Throws:

PdfException - if no page has been decoded

getBackgroundGroupingObject

public PdfGroupingAlgorithms getBackgroundGroupingObject(PdfData pdfBackgroundData)

returns object containing grouped text from background grouping - Please see org.jpedal.examples.text for example code

Parameters:

pdfBackgroundData -

set

public void set(Map values)
         throws PdfException

Set options to be used in page rendering, printing and image conversion

Parameters:

values - Map Object containing various parameters to modify

Throws:

PdfException - if key or value data type is not recognised

modifyJPedalParameters

public static void modifyJPedalParameters(Map values)
                                   throws PdfException

Allow the modification of various parameters to customise different aspects of rendering and / or extraction

Parameters:

values - Map Object containing various parameters to modify

Throws:

PdfException - if key or value data type is not recognised

getPageColor

public Color getPageColor()

Get the alternative page colour to be used when the option is set.

Returns:

Color object representing the alternative page colour

getTextColor

public Color getTextColor()

Get the alternative text colour to be used when the option is set.

Returns:

Color object representing the alternative text colour

getReplacementColorThreshold

public int getReplacementColorThreshold()

Set the threshold to be used when replacing text and line colours with alternative. This value is designed to allow you to replace only black colours but a problem arises with slightly off black colours. In some cases this can result in black text changing but other 1 value of black colours not changing.

The threshold sets a value all RGB components must be under in order to be replaced. 0 would only covert pure black, 255 would convert all colours.

Returns:

int value representing the threshold to use when replacing colours

isEnhanceFractionalLines

public boolean isEnhanceFractionalLines()

Flag used to control if we enhance thin lines (width of less than 1) to ensure its width never drops below 1.

Returns:

True if we enhance thin lines, false otherwise

getDisplayBackgroundColor

public Color getDisplayBackgroundColor()

Gets the alternative colour for the display areas background when the option is set.

Returns:

Color object representing the colour to be used.

getChangeTextAndLine

public boolean getChangeTextAndLine()

Flag that shows if shapes should have colours changed when preferences set to change document text colours

Returns:

true if shape colours are changes, false otherwise

getNonDrawnPageColor

public Paint getNonDrawnPageColor()

Gets the Paint to be used when drawing a page that has not been drawn on yet

Returns:

Paint object to be used when displaying pages before rendering

getInstance_allowPagesSmallerThanPageSize

public Boolean getInstance_allowPagesSmallerThanPageSize()

Flag to control if image conversion can create pages smaller than the original

Returns:

True if scaling can be less than 100%, false otherwise

getInstance_bestQualityMaxScaling

public Integer getInstance_bestQualityMaxScaling()

Flag to control the maximum value the scaling for image conversion can be

Returns:

Integer object representing the largest scaling factor to be used in image conversion

getFormsNoPrint

public static int[] getFormsNoPrint()

Get a list of Form types and subtypes that should not be printed

Returns:

int array containing type values of forms to ignore

getInstance_FormsNoPrint

public int[] getInstance_FormsNoPrint()

Get a list of Form types and subtypes that should not be printed

Returns:

int array containing type values of forms to ignore

getPageSizeToUse

public Boolean getPageSizeToUse()

Flag to check if we should override page size during image conversion

Returns:

True is page size can be scaled, flase otherwise

getImageDimensions

public float getImageDimensions(int pageIndex,
                                PdfPageData pageData)

Get the scaling values to be used when converting a page to an image

Parameters:

pageIndex - int value of a page

pageData - PdfPageData object holding page size data for the document

Returns:

float value of the multiplier to be used when converting to an image

getRenderPage

public boolean getRenderPage()

Flag to show if pages are being rendered

Returns:

flag to show if pages are being rendered (true) or only extraction taking place (false).

setRenderPage

public void setRenderPage(boolean newRender)

Controls if pages are being rendered or not

Parameters:

newRender - flag to show if pages are being rendered (true) or only extraction taking place (false).

useHardwareAcceleration

public boolean useHardwareAcceleration()

Flag to specify if the viewer should use hardware acceleration when rendering pages

Returns:

True if acceleration should be used, false otherwise

useHardwareAcceleration

public void useHardwareAcceleration(boolean newValue)

Specify if the viewer should use hardware acceleration when rendering pages

Parameters:

newValue - True if acceleration should be used, false otherwise

getPageAlignment

public int getPageAlignment()

Get the alignment of the pages such as left aligned or centred - Please see org.jpedal.display for display view flags

Returns:

int value representing the page alignment

setPageAlignment

public void setPageAlignment(int orientation)

Set the alignment of the pages such as left aligned or centred - Please see org.jpedal.display for display view flags

Parameters:

orientation - int value to use for page alignment

setDisplayView

public void setDisplayView(int displayView)

Set the display view being used in the display

Parameters:

displayView - int value for the display view - Please see org.jpedal.display for display view flags

getDisplayView

public int getDisplayView()

Get the current display view being used

Returns:

int value representing the current display view - Please see org.jpedal.display for display view flags

getCurrentOffsets

public PageOffsets getCurrentOffsets()

Get the page offsets and sizes for the whole document for various display modes

Returns:

PageOffsets object containing offset information

setCurrentOffsets

public void setCurrentOffsets(PageOffsets newOffset)

Set the offsets for the current document

Parameters:

newOffset - PageOffsets object containing offset information to be used for the document