com.qoppa.pdfNotes.settings

Class TypewriterTool

java.lang.Object

com.qoppa.pdfNotes.settings.TypewriterTool

public class TypewriterTool
extends Object

This class manages the default properties and settings for the Typewriter 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	SHOW_NOTHING
static int	SHOW_PROPS_DIALOG

Constructor Summary

Constructors

Constructor and Description
TypewriterTool()

Method Summary

Modifier and Type	Method and Description
static Color	getDefaultColor() Returns the default color.
static String	getDefaultFontName() Returns the name of the default font.
static float	getDefaultFontSize() Returns the point size of the default font
static boolean	getDefaultStrikethrough() Gets the default strikethrough value that is used when new annotations are created.
static int	getDefaultTransparency() Gets the default transparency value that is used when new annotations are created.
static boolean	getDefaultUnderline() Gets the default underline value that is used when new annotations are created.
static Dimension	getMinimumAnnotSize() Gets the minimum size for the annotations created with this Tool.
static int	getShowOption() Returns the option for what this Tool should do after it creates the annotation.
static boolean	isToolSticky() Returns a flag indicating if this tool is sticky.
static void	setDefaultColor(Color defaultColor) Sets the default color.
static void	setDefaultFontName(String fontName) Sets the name of the default font.
static void	setDefaultFontSize(float fontSize) Sets the point size of the default font.
static void	setDefaultProperties(FreeText freeText) This is a convenience method to set the FreeText properties to the TypewriterTool default properties.
static void	setDefaultStrikethrough(boolean defaultStrikethrough) Sets the default strikethrough value that is used when new annotations are created.
static void	setDefaultTransparency(int defaultTransparency) Sets the default transparency values when new annotations are created.
static void	setDefaultUnderline(boolean defaultUnderline) Sets the default underline value that is used when new annotations are created.
static void	setMinimumAnnotSize(Dimension minimumAnnotSize) Sets the minimum size for the annotations created with this Tool.
static void	setShowOption(int option) Sets the option for what this Tool should do after it creates the annotation.
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

SHOW_NOTHING

public static int SHOW_NOTHING

SHOW_PROPS_DIALOG

public static int SHOW_PROPS_DIALOG

Constructor Detail

TypewriterTool

public TypewriterTool()

Method Detail

setDefaultProperties

public static void setDefaultProperties(FreeText freeText)

This is a convenience method to set the FreeText properties to the TypewriterTool default properties.

getDefaultColor

public static Color getDefaultColor()

Returns the default color. This color is used to paint the text in the annotation.

Returns:

the default color

setDefaultColor

public static void setDefaultColor(Color defaultColor)

Sets the default color. This color is used to paint the text in the annotation.

Parameters:

defaultColor - the new default 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.

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

getDefaultFontName

public static String getDefaultFontName()

Returns the name of the default font.

Returns:

The default font name.

setDefaultFontName

public static void setDefaultFontName(String fontName)

Sets the name of the default font.

The supported fonts are Helvetica, Helvetica-Bold, Helvetica-Oblique, Helvetica-BoldOblique, Courier, Courier-Bold, Courier-Oblique, Courier-BoldOblique, Times-Roman, Times-Bold, Times-Italic, Times-BoldItalic.

The font will default to Courier.

Parameters:

fontName - The default font name.

getDefaultFontSize

public static float getDefaultFontSize()

Returns the point size of the default font

Returns:

The default font size.

setDefaultFontSize

public static void setDefaultFontSize(float fontSize)

Sets the point size of the default font.

Parameters:

fontSize - The default font size.

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 - The new default transparency value

getDefaultStrikethrough

public static boolean getDefaultStrikethrough()

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

Returns:

the default strikethrough value

setDefaultStrikethrough

public static void setDefaultStrikethrough(boolean defaultStrikethrough)

Sets the default strikethrough value that is used when new annotations are created.

Parameters:

defaultStrikethrough - The new default strikethrough value

getDefaultUnderline

public static boolean getDefaultUnderline()

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

Returns:

the default underline value

setDefaultUnderline

public static void setDefaultUnderline(boolean defaultUnderline)

Sets the default underline value that is used when new annotations are created.

Parameters:

defaultUnderline - The new default underline value

getShowOption

public static int getShowOption()

Returns the option for what this Tool should do after it creates the annotation. The options are SHOW_NOTHING, SHOW_PROPS_DIALOG, or .

Returns:

setShowOption

public static void setShowOption(int option)

Sets the option for what this Tool should do after it creates the annotation. The options are SHOW_NOTHING, SHOW_PROPS_DIALOG, or .

Parameters:

option -