com.qoppa.pdfNotes.settings

Class LinkTool

java.lang.Object

com.qoppa.pdfNotes.settings.LinkTool

public class LinkTool
extends Object

This class manages the default properties and settings for the Link 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
LinkTool()

Method Summary

Methods

Modifier and Type	Method and Description
static Color	getDefaultBorderColor() Returns the color used for the border when a new annotation is created.
static char	getDefaultBorderStyle() Return the char signifying the border style when a new annotation is created.
static int	getDefaultBorderWidth() Deprecated. Replaced with getDefaultBorderWidth2D() for more precise border widths
static double	getDefaultBorderWidth2D() Returns the default border width, used when new annotations are 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 void	setDefaultBorderColor(Color defaultBorderColor) Sets the default border color.
static void	setDefaultBorderStyle(char style) Sets the default border style used when new annotations are created.
static void	setDefaultBorderWidth(int defaultBorderWidth) Deprecated. Replaced with setDefaultBorderWidth2D(double) for more precise border widths
static void	setDefaultBorderWidth2D(double defaultBorderWidth) Sets the border line width used when a new annotation is created.
static void	setDefaultProperties(Link link) This is a convenience method to set the Link properties to the LinkTool default properties.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkTool

public LinkTool()

Method Detail

setDefaultProperties

public static void setDefaultProperties(Link link)

This is a convenience method to set the Link properties to the LinkTool default properties.

getDefaultBorderWidth2D

public static double getDefaultBorderWidth2D()

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

Returns:

the default border width value

setDefaultBorderWidth2D

public static void setDefaultBorderWidth2D(double defaultBorderWidth)

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

Parameters:

defaultBorderWidth - The new default border 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 border when a new annotation is created.

Returns:

the default border color

setDefaultBorderColor

public static void setDefaultBorderColor(Color defaultBorderColor)

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

Parameters:

defaultBorderColor - The new default border color.

getDefaultBorderStyle

public static char getDefaultBorderStyle()

Return the char signifying the border style when a new annotation is created. Should be one of:

• Annotation.BORDERSTYLE_SOLID - This is the default
• Annotation.BORDERSTYLE_UNDERLINE
• Annotation.BORDERSTYLE_DASHED

Returns:

the default border style

setDefaultBorderStyle

public static void setDefaultBorderStyle(char style)

Sets the default border style used when new annotations are created. Should be one of:

• Annotation.BORDERSTYLE_SOLID - This is the default
• Annotation.BORDERSTYLE_UNDERLINE
• Annotation.BORDERSTYLE_DASHED

Parameters:

style - The new default border style.

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