com.crionics.jpdf.creator
Class ColorSearchPreferences

java.lang.Object
  com.crionics.jpdf.creator.ColorSearchPreferences

public class ColorSearchPreferences
extends java.lang.Object

This class contains various attributes which will be used when checking for color in Documents.

Constructor Summary

ColorSearchPreferences()
Constructor.

Method Summary

int	getGrayThreshold() Returns the Gray Threshold value.
boolean	isCheckingAnnotations() Determines if the annotations (links, Form Fields,...) will be processed or not.
boolean	isCheckingContent() Determines if the elements of the pages other than Annotations and Images will be processed or not.
boolean	isCheckingImages() Determines if the Images will be processed or not.
void	reset() Resets the different attributes of the preferences to their default value.
void	setCheckAnnotations(boolean flag) Specifies if Annotations (Links, Form Fields,...) should be analysed.
void	setCheckContent(boolean flag) Specifies if elements other than Annotations and Images should be analysed.
void	setCheckImages(boolean flag) Specifies if Images should be analysed.
void	setGrayThreshold(int thegrayThreshold) Specifies the maximum difference allowed between each component of a Color (Red - Green, Green - Blue, Red - Blue) before declaring a color an actual color value (understand non gray).

Methods inherited from class java.lang.Object

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

Constructor Detail

ColorSearchPreferences

public ColorSearchPreferences()

Constructor.

Method Detail

getGrayThreshold

public int getGrayThreshold()

Returns the Gray Threshold value. See setGrayThreshold(int)

Returns:

the Gray Threshold value.

isCheckingAnnotations

public boolean isCheckingAnnotations()

Determines if the annotations (links, Form Fields,...) will be processed or not. See setCheckAnnotations(boolean)

Returns:

true if this is the case, false otherwise.

isCheckingContent

public boolean isCheckingContent()

Determines if the elements of the pages other than Annotations and Images will be processed or not. See setCheckContent(boolean)

Returns:

true if this is the case, false otherwise.

isCheckingImages

public boolean isCheckingImages()

Determines if the Images will be processed or not. See setCheckImages(boolean)

Returns:

true if this is the case, false otherwise.

reset

public void reset()

Resets the different attributes of the preferences to their default value.

setCheckAnnotations

public void setCheckAnnotations(boolean flag)

Specifies if Annotations (Links, Form Fields,...) should be analysed. Default value = true.

Parameters:

flag - true to analyse the annotations, false otherwise.

setCheckContent

public void setCheckContent(boolean flag)

Specifies if elements other than Annotations and Images should be analysed. Default value = true.

Parameters:

flag - true to analyse the elements, false otherwise.

setCheckImages

public void setCheckImages(boolean flag)

Specifies if Images should be analysed. Default value = true.

Parameters:

flag - true to analyse the images, false otherwise.

setGrayThreshold

public void setGrayThreshold(int thegrayThreshold)

Specifies the maximum difference allowed between each component of a Color (Red - Green, Green - Blue, Red - Blue) before declaring a color an actual color value (understand non gray). This method was added, as some slight variation might exist in a PDF Document where a color might appear Gray on a screen while not being a real Gray. Example RGB = [32, 31, 35]

Parameters:

thegrayThreshold -