com.qoppa.pdfNotes.settings

Class AreaTool

java.lang.Object

com.qoppa.pdfNotes.settings.AreaTool

public class AreaTool
extends Object

This class manages the default properties and settings for the Area 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

Field Summary

Fields

Modifier and Type	Field and Description
static int	SQ_UNITS Display the units as "sq units".
static int	UNITS_2 Display the units as "units^2".

Constructor Summary

Constructors

Constructor and Description
AreaTool()

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 lines when a new annotation is created.
static int	getDefaultBorderWidth() Deprecated. Replaced with getDefaultBorderWidth2D() for more precise border widths
static double	getDefaultBorderWidth2D() Returns the default line width, used when new annotations are created.
static Color	getDefaultFillColor() Gets the default fill color.
static int	getDefaultTransparency() Gets the default transparency value that is used when new annotations are created.
static int	getDefaultUnitsStringType() Returns the default units string display type.
static Dimension	getMinimumAnnotSize() Gets the minimum size for the annotations created with this Tool.
static boolean	isShowMeasurement() Returns the setting for whether to display the measurement on the annotation itself.
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 default line color.
static void	setDefaultBorderWidth(int defaultBorderWidth) Deprecated. Replaced with setDefaultBorderWidth2D(double) for more precise border widths
static void	setDefaultBorderWidth2D(double defaultBorderWidth) Sets the line width used when a new annotation is created.
static void	setDefaultFillColor(Color defaultFillColor) Sets the default fill color.
static void	setDefaultProperties(Polygon polygon) This is a convenience method to set the Polyline properties to the PolygonTool default properties.
static void	setDefaultTransparency(int defaultTransparency) Sets the default transparency values when new annotations are created.
static void	setDefaultUnitsStringType(int defaultUnitsString) Sets the default units display type to use when creating new area measurements.
static void	setMinimumAnnotSize(Dimension minimumAnnotSize) Sets the minimum size for the annotations created with this Tool.
static void	setShowMeasurement(boolean showMeasurement) Set whether to display the measurement on the annotation itself.
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

Field Detail

SQ_UNITS

public static final int SQ_UNITS

Display the units as "sq units".

See Also:

Constant Field Values

UNITS_2

public static final int UNITS_2

Display the units as "units^2".

See Also:

Constant Field Values

Constructor Detail

AreaTool

public AreaTool()

Method Detail

setDefaultProperties

public static void setDefaultProperties(Polygon polygon)

This is a convenience method to set the Polyline properties to the PolygonTool default properties.

getDefaultTransparency

public static int getDefaultTransparency()

Gets the default transparency value that is used when new annotations are created.

Returns:

the default transparency value

setDefaultTransparency

public static void setDefaultTransparency(int defaultTransparency)

Sets the default transparency values when new annotations are created.

Parameters:

defaultTransparency - Thew new default transparency value

getDefaultBorderWidth2D

public static double getDefaultBorderWidth2D()

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

Returns:

the default border width value

setDefaultBorderWidth2D

public static void setDefaultBorderWidth2D(double defaultBorderWidth)

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

Parameters:

defaultBorderWidth - The new default line 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 lines when a new annotation is created. This property is called the border color because internally, the PDF format defines the color as the border color.

Returns:

the default area color

setDefaultBorderColor

public static void setDefaultBorderColor(Color defaultBorderColor)

Sets the default line color. This color will be used when new annotations are created.

Parameters:

defaultBorderColor - The new default line color.

getDefaultFillColor

public static Color getDefaultFillColor()

Gets the default fill color. This color is used to fill in the annotation when a new annotation is created.

Returns:

the default fill color

setDefaultFillColor

public static void setDefaultFillColor(Color defaultFillColor)

Sets the default fill color. This color is used to fill in the annotation when a new annotation is created.

Parameters:

defaultFillColor - The new default fill color

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

getDefaultUnitsStringType

public static int getDefaultUnitsStringType()

Returns the default units string display type.

Returns:

the default units string display type

setDefaultUnitsStringType

public static void setDefaultUnitsStringType(int defaultUnitsString)

Sets the default units display type to use when creating new area measurements.

Parameters:

defaultUnitsString - the new value of the default units string type

isShowMeasurement

public static boolean isShowMeasurement()

Returns the setting for whether to display the measurement on the annotation itself.

Returns:

the setting for displaying the measurement

setShowMeasurement

public static void setShowMeasurement(boolean showMeasurement)

Set whether to display the measurement on the annotation itself.

Parameters:

showMeasurement - boolean controlling whether to display the measurement on the annotation