com.qoppa.pdfNotes.settings

Class AreaHighlightTool

java.lang.Object

com.qoppa.pdfNotes.settings.AreaHighlightTool

public class AreaHighlightTool
extends Object

This class manages the default properties and settings for the Area Highlight Tool. The method setDefaultProperties() can be used to set the Annotation properties to this Tool's default properties.

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

Constructor Summary

Constructors

Constructor and Description
AreaHighlightTool()

Method Summary

Methods

Modifier and Type	Method and Description
static BasicStroke	getDefaultBasicStroke() Gets the default stroke.
static Color	getDefaultBorderColor() Returns the color used for the border when a new annotation is created.
static int	getDefaultBorderWidth() Deprecated. Replaced with getDefaultBorderWidth2D() for more precise border widths
static double	getDefaultBorderWidth2D() Returns the border width used when a new highlight is created.
static Color	getDefaultFillColor() Returns the color used as the highlight when a new highlight annotation is created.
static int	getDefaultTransparency() Returns the value of the transparency factor used when a new highlight annotation is created.
static Dimension	getMinimumAnnotSize() Gets the minimum size for the annotations created with this Tool.
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	setDefaultBasicStroke(BasicStroke defaultStroke) Sets the default stroke.
static void	setDefaultBorderColor(Color defaultBorderColor) Sets the color used for the border when a new annotation is created.
static void	setDefaultBorderWidth(int defaultBorderWidth) Deprecated. Replaced with setDefaultBorderWidth2D(double) for more precise border widths
static void	setDefaultBorderWidth2D(double defaultBorderWidth) Sets the border width used when a new annotation is created.
static void	setDefaultFillColor(Color defaultFillColor) Sets the color used for highlighting when a new highlight is created.
static void	setDefaultProperties(Square square) This is a convenience method to set the Square-AreaHighlight properties to the AreaHighlightTool default properties.
static void	setDefaultTransparency(int defaultTransparency) Sets the value of the transparency factor used when a new highlight annotation is created.
static void	setMinimumAnnotSize(Dimension minimumAnnotSize) Sets the minimum size for the annotations created with this Tool.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

AreaHighlightTool

public AreaHighlightTool()

Method Detail

setDefaultProperties

public static void setDefaultProperties(Square square)

This is a convenience method to set the Square-AreaHighlight properties to the AreaHighlightTool default properties.

getDefaultTransparency

public static int getDefaultTransparency()

Returns the value of the transparency factor used when a new highlight annotation is created.

Returns:

the defaultTransparency

setDefaultTransparency

public static void setDefaultTransparency(int defaultTransparency)

Sets the value of the transparency factor used when a new highlight annotation is created.

Parameters:

defaultTransparency - the defaultTransparency to set

getDefaultBorderWidth2D

public static double getDefaultBorderWidth2D()

Returns the border width used when a new highlight is created.

Returns:

the default border width

setDefaultBorderWidth2D

public static void setDefaultBorderWidth2D(double defaultBorderWidth)

Sets the border width used when a new annotation is created.

Parameters:

defaultBorderWidth - The new default border width

getDefaultBorderWidth

public static int getDefaultBorderWidth()

Deprecated. Replaced with getDefaultBorderWidth2D() for more precise border widths

Returns the default line width, used when new annotations are created.

Returns:

the default border width value

setDefaultBorderWidth

public static void setDefaultBorderWidth(int defaultBorderWidth)

Deprecated. Replaced with setDefaultBorderWidth2D(double) for more precise border widths

Sets the line width used when a new annotation is created.

Parameters:

defaultBorderWidth - The new default line width

getDefaultBorderColor

public static Color getDefaultBorderColor()

Returns the color used for the border when a new annotation is created.

Returns:

the default border color

setDefaultBorderColor

public static void setDefaultBorderColor(Color defaultBorderColor)

Sets the color used for the border when a new annotation is created.

Parameters:

defaultBorderColor - the defaultBorderColor to set

getDefaultFillColor

public static Color getDefaultFillColor()

Returns the color used as the highlight when a new highlight annotation is created.

Returns:

the defaultFillColor

setDefaultFillColor

public static void setDefaultFillColor(Color defaultFillColor)

Sets the color used for highlighting when a new highlight is created.

Parameters:

defaultFillColor - the defaultFillColor to set

getDefaultBasicStroke

public static BasicStroke getDefaultBasicStroke()

Gets the default stroke. This is the stroke used to draw the annotation.

Returns:

the default stroke

setDefaultBasicStroke

public static void setDefaultBasicStroke(BasicStroke defaultStroke)

Sets the default stroke. This is the stroke used to draw the annotation.

Parameters:

defaultStroke - The new default stroke

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.

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

getMinimumAnnotSize

public static Dimension getMinimumAnnotSize()

Gets the minimum size for the annotations created with this Tool. When the annotation is drawn by a user with a "null size", the annotation size will be automatically set to the annotation's minimum size.

Returns:

the minimumAnnotSize

setMinimumAnnotSize

public static void setMinimumAnnotSize(Dimension minimumAnnotSize)

Sets the minimum size for the annotations created with this Tool. When the annotation is drawn by a user with a "null size", the annotation size will be automatically set to the annotation's minimum size.

Parameters:

minimumAnnotSize - the minimumAnnotSize to set