com.qoppa.pdfNotes.settings
Class SoundTool

java.lang.Object
  com.qoppa.pdfNotes.settings.SoundTool

public class SoundTool
extends Object

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

SoundTool()

Method Summary

static Color	getDefaultColor() Returns the default color.
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	setDefaultColor(Color defaultColor) Sets the default color.
static void	setDefaultProperties(Sound sound) This is a convenience method to set the Sound properties to the SoundTool 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

SoundTool

public SoundTool()

Method Detail

setDefaultProperties

public static void setDefaultProperties(Sound sound)

This is a convenience method to set the Sound properties to the SoundTool default properties.

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

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