com.qoppa.pdfNotes.settings

Class RedactionTool

java.lang.Object

com.qoppa.pdfNotes.settings.RedactionTool

public class RedactionTool
extends Object

This class manages the default properties and settings for the Redaction Tool.

The Tool's property values can be retrieved and initialized with the methods toXMLString() and setFromXML() in the AnnotationTools class. Please see AnnotationTools.

Author:

Qoppa Software

Field Summary

Fields

Modifier and Type	Field and Description
static int	OVERLAY_ALIGNMENT_CENTER
static int	OVERLAY_ALIGNMENT_LEFT
static int	OVERLAY_ALIGNMENT_RIGHT

Constructor Summary

Constructors

Constructor and Description
RedactionTool()

Method Summary

Methods

Modifier and Type	Method and Description
static Color	getCurrentFillColor() Returns the current fill color.
static Color	getCurrentOverlayFillColor() Returns the current overylay fill color.
static Color	getDefaultFillColor() Returns the default fill color.
static float	getDefaultFillOpacity() Returns the default fill opacity.
static int	getDefaultFillTransparency() Returns the default fill transparency.
static Color	getDefaultOutlineColor() Returns the default outline color.
static Color	getDefaultOverlayFillColor() Returns the default overlay fill color.
static String	getOverlayText() Returns a string specifying the overlay text that should be drawn over the redacted region after the content has been removed.
static int	getOverlayTextAlignment() Returns the alignment used for the overlay text that should be drawn over the redacted region after the content has been removed.
static Color	getOverlayTextColor() Returns the color used for the overlay text that should be drawn over the redacted region after the content has been removed.
static String	getOverlayTextFont() Returns the font used for the overlay text that should be drawn over the redacted region after the content has been removed.
static float	getOverlayTextSize() Returns the size used for the overlay text that should be drawn over the redacted region after the content has been removed.
static boolean	isOverlayTextRepeat() Returns a flag that determines whether or not the overlay text repeats.
static boolean	isShowPropDialog() Gets the flag for this Tool to show or not the annotation properties popup dialog after an annotation has been created.
static boolean	isToolSticky() Returns a flag indicating if this tool is sticky.
static void	setDefaultFillColor(Color c) Sets the default fill color.
static void	setDefaultFillTransparency(int t) Sets the default fill transparency.
static void	setDefaultOutlineColor(Color c) Sets the default outline color.
static void	setDefaultOverlayFillColor(Color c) Sets the default overlay fill color.
static void	setOverlayText(String overlayText) Sets a string specifying the overlay text that should be drawn over the redacted region after the content has been removed.
static void	setOverlayTextAlignment(int alignment) Sets the alignment used for the overlay text that should be drawn over the redacted region after the content has been removed.
static void	setOverlayTextColor(Color color) Sets the color used for the overlay text that should be drawn over the redacted region after the content has been removed.
static void	setOverlayTextFont(String font) Sets the font used for the overlay text that should be drawn over the redacted region after the content has been removed.
static void	setOverlayTextRepeat(boolean repeat) Sets a flag that determines whether or not the overlay text repeats.
static void	setOverlayTextSize(float size) Sets the size used for the overlay text that should be drawn over the redacted region after the content has been removed.
static void	setShowPropDialog(boolean showPropDialog) Sets the flag for this Tool to show or not the annotation properties popup dialog after an annotation has been created.
static void	setToolSticky(boolean toolSticky) Sets the flag that indicates whether this tool is sticky or not.
static void	setUseFill(boolean b) Sets whether to use the default fill color.
static void	setUseOverlay(boolean b) Set whether to use the overlay.
static boolean	useFill() Returns whether or not the fill color will be used.
static boolean	useOverlay() Returns whether or not the overlay will be used.

Methods inherited from class java.lang.Object

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

Field Detail

OVERLAY_ALIGNMENT_LEFT

public static final int OVERLAY_ALIGNMENT_LEFT

See Also:

Constant Field Values

OVERLAY_ALIGNMENT_CENTER

public static final int OVERLAY_ALIGNMENT_CENTER

See Also:

Constant Field Values

OVERLAY_ALIGNMENT_RIGHT

public static final int OVERLAY_ALIGNMENT_RIGHT

See Also:

Constant Field Values

Constructor Detail

RedactionTool

public RedactionTool()

Method Detail

setDefaultOutlineColor

public static void setDefaultOutlineColor(Color c)

Sets the default outline color.

Parameters:

c - the default color

getDefaultOutlineColor

public static Color getDefaultOutlineColor()

Returns the default outline color.

Returns:

the default outline color

setDefaultFillColor

public static void setDefaultFillColor(Color c)

Sets the default fill color.

Parameters:

c - the fill color

getDefaultFillColor

public static Color getDefaultFillColor()

Returns the default fill color.

Returns:

the default fill color

setDefaultFillTransparency

public static void setDefaultFillTransparency(int t)

Sets the default fill transparency.

Parameters:

t - the default fill transparency

getDefaultFillTransparency

public static int getDefaultFillTransparency()

Returns the default fill transparency.

Returns:

the default fill transparency

isShowPropDialog

public static boolean isShowPropDialog()

Gets the flag for this Tool to show or not the annotation properties popup dialog after an annotation has been created.

Returns:

the showPropDialog

setShowPropDialog

public static void setShowPropDialog(boolean showPropDialog)

Sets the flag for this Tool to show or not the annotation properties popup dialog after an annotation has been created.

Parameters:

showPropDialog - the showPropDialog to set

setDefaultOverlayFillColor

public static void setDefaultOverlayFillColor(Color c)

Sets the default overlay fill color.

Parameters:

c - the default overlay fill color

getDefaultOverlayFillColor

public static Color getDefaultOverlayFillColor()

Returns the default overlay fill color.

Returns:

the default overlay fill color

getDefaultFillOpacity

public static float getDefaultFillOpacity()

Returns the default fill opacity.

Returns:

the default fill opacity

setUseFill

public static void setUseFill(boolean b)

Sets whether to use the default fill color.

Parameters:

b -

useFill

public static boolean useFill()

Returns whether or not the fill color will be used.

Returns:

true if the fill color is used, false otherwise

setUseOverlay

public static void setUseOverlay(boolean b)

Set whether to use the overlay.

Parameters:

b -

useOverlay

public static boolean useOverlay()

Returns whether or not the overlay will be used.

Returns:

true if the overylay will be used, false otherwise

getCurrentFillColor

public static Color getCurrentFillColor()

Returns the current fill color.

Returns:

The current fill color

getCurrentOverlayFillColor

public static Color getCurrentOverlayFillColor()

Returns the current overylay fill color.

Returns:

The current overlay fill color

isToolSticky

public static boolean isToolSticky()

Returns a flag indicating if this tool is sticky. When a tool is sticky, it will remain active after a user finishes adding a comment.

Returns:

the toolSticky flag

setToolSticky

public static void setToolSticky(boolean toolSticky)

Sets the flag that indicates whether this tool is sticky or not. When a tool is sticky, it will remain active after a user finishes adding a comment.

Parameters:

toolSticky - The new value of the sticky flag.

setOverlayText

public static void setOverlayText(String overlayText)

Sets a string specifying the overlay text that should be drawn over the redacted region after the content has been removed.

Parameters:

overlayText - the overlay text string

getOverlayText

public static String getOverlayText()

Returns a string specifying the overlay text that should be drawn over the redacted region after the content has been removed.

Returns:

The overlay text string

setOverlayTextFont

public static void setOverlayTextFont(String font)

Sets the font used for the overlay text that should be drawn over the redacted region after the content has been removed.

Parameters:

font - the overlay text font

getOverlayTextFont

public static String getOverlayTextFont()

Returns the font used for the overlay text that should be drawn over the redacted region after the content has been removed.

Returns:

The overlay text font

setOverlayTextSize

public static void setOverlayTextSize(float size)

Sets the size used for the overlay text that should be drawn over the redacted region after the content has been removed.

Parameters:

size - the overlay text size

getOverlayTextSize

public static float getOverlayTextSize()

Returns the size used for the overlay text that should be drawn over the redacted region after the content has been removed.

Returns:

The overlay text size

setOverlayTextColor

public static void setOverlayTextColor(Color color)

Sets the color used for the overlay text that should be drawn over the redacted region after the content has been removed.

Parameters:

color - the overlay text color

getOverlayTextColor

public static Color getOverlayTextColor()

Returns the color used for the overlay text that should be drawn over the redacted region after the content has been removed.

Returns:

The overlay text color

setOverlayTextAlignment

public static void setOverlayTextAlignment(int alignment)

Sets the alignment used for the overlay text that should be drawn over the redacted region after the content has been removed.

Parameters:

alignment - an int designating the text alignment: OVERLAY_ALIGNMENT_LEFT, OVERLAY_ALIGNMENT_CENTER, OVERLAY_ALIGNMENT_RIGHT

getOverlayTextAlignment

public static int getOverlayTextAlignment()

Returns the alignment used for the overlay text that should be drawn over the redacted region after the content has been removed.

Returns:

The overlay text alignment

setOverlayTextRepeat

public static void setOverlayTextRepeat(boolean repeat)

Sets a flag that determines whether or not the overlay text repeats.

Parameters:

repeat - the new value of the overlay text repeat flag

isOverlayTextRepeat

public static boolean isOverlayTextRepeat()

Returns a flag that determines whether or not the overlay text repeats.

Returns:

True if the overlay text repeats, otherwise false