com.qoppa.pdfNotes.settings

Class RubberStampTool

java.lang.Object

com.qoppa.pdfNotes.settings.RubberStampTool

public class RubberStampTool
extends Object

This class manages the default properties and settings for the Rubber Stamp 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
RubberStampTool()

Method Summary

Modifier and Type	Method and Description
static Color	getDefaultColor() Returns the default color that is used when new Stamps are created.
static int	getDefaultTransparency() Gets the default transparency value that is used when new annotations are created.
static ImageCompression	getImageCompression() Gets the default image compression when new Stamps 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	isShowPropDialog() Deprecated.
static boolean	isToolSticky() Returns a flag indicating if this tool is sticky.
static void	setDefaultColor(Color defaultColor) Sets the default color that is used when new Stamps are created.
static void	setDefaultProperties(RubberStamp stamp) This is a convenience method to set the RubberStamp properties to the RubberStampTool default properties.
static void	setDefaultTransparency(int defaultTransparency) Sets the default transparency values when new annotations are created.
static void	setImageCompression(ImageCompression imageCompression) Sets the default image compression when new Stamps 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	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

RubberStampTool

public RubberStampTool()

Method Detail

setDefaultProperties

public static void setDefaultProperties(RubberStamp stamp)

This is a convenience method to set the RubberStamp properties to the RubberStampTool 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 - The new default transparency value

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 -

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

getDefaultColor

public static Color getDefaultColor()

Returns the default color that is used when new Stamps are created.

Returns:

the default color

setDefaultColor

public static void setDefaultColor(Color defaultColor)

Sets the default color that is used when new Stamps are created.

Parameters:

defaultColor - the new default color

setImageCompression

public static void setImageCompression(ImageCompression imageCompression)

Sets the default image compression when new Stamps are created.

Parameters:

imageCompression - The new image compression

getImageCompression

public static ImageCompression getImageCompression()

Gets the default image compression when new Stamps are created.

Returns:

The image compression