com.qoppa.pdfNotes.settings

Class StickyNoteTool

java.lang.Object

com.qoppa.pdfNotes.settings.StickyNoteTool

public class StickyNoteTool
extends Object

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

Constructor Summary

Constructors

Constructor and Description
StickyNoteTool()

Method Summary

Modifier and Type	Method and Description
static Color	getDefaultColor() Returns the default color.
static String	getDefaultIconName() Returns the default name of the icon for this annotation.
static int	getDefaultTransparency() Gets the default transparency value that is used when new annotations are created.
static int	getShowOption() Returns the option for what this Tool should do after it creates the annotation.
static boolean	isDefaultInitiallyOpen() Returns the initially open flag used when creating a sticky note annotation.
static boolean	isShowPropDialog() Deprecated.
static boolean	isToolSticky() Returns a flag indicating if this tool is sticky.
static void	setDefaultColor(Color defaultColor) Sets the default color.
static void	setDefaultFillColor(Color defaultColor) Sets the default color.
static void	setDefaultIconName(String iconName) Sets the default name of the icon for this annotation.
static void	setDefaultInitiallyOpen(boolean defaultInitiallyOpen) Sets the initially open flag to use when creating new sticky note annotations.
static void	setDefaultProperties(Text text) This is a convenience method to set the Text properties to the Sticky Note Tool default properties.
static void	setDefaultTransparency(int defaultTransparency) Sets the default transparency values when new annotations are created.
static void	setShowOption(int option) Sets the option for what this Tool should do after it creates the annotation.
static void	setShowPropDialog(boolean showPropDialog) Deprecated.
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

SHOW_POPUP

public static int SHOW_POPUP

Constructor Detail

StickyNoteTool

public StickyNoteTool()

Method Detail

setDefaultProperties

public static void setDefaultProperties(Text text)

This is a convenience method to set the Text properties to the Sticky Note Tool 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

getDefaultColor

public static Color getDefaultColor()

Returns the default color. This color is used to paint the icon 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

setDefaultFillColor

public static void setDefaultFillColor(Color defaultColor)

Sets the default color. This color is used to paint the note icon in the annotation. This method is a duplicate of the setDefaultColor() method.

Parameters:

defaultColor - the new default color

isDefaultInitiallyOpen

public static boolean isDefaultInitiallyOpen()

Returns the initially open flag used when creating a sticky note annotation. This flag is used to determine whether the sticky note will be open initially.

Returns:

the default initially open flag

setDefaultInitiallyOpen

public static void setDefaultInitiallyOpen(boolean defaultInitiallyOpen)

Sets the initially open flag to use when creating new sticky note annotations. This flag is used to determine whether the sticky note will be open initially.

Parameters:

defaultInitiallyOpen - The new value of the default initially open

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

@Deprecated
public static boolean isShowPropDialog()

Deprecated.

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

@Deprecated
public static void setShowPropDialog(boolean showPropDialog)

Deprecated.

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

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 -

setDefaultIconName

public static void setDefaultIconName(String iconName)

Sets the default name of the icon for this annotation.

Parameters:

iconName - Name of the icon.

getDefaultIconName

public static String getDefaultIconName()

Returns the default name of the icon for this annotation.

Returns:

Name of the icon.