Package adams.gui.visualization.object.tools

Class Annotator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.gui.visualization.object.tools.AbstractTool

adams.gui.visualization.object.tools.AbstractToolWithParameterPanel

adams.gui.visualization.object.tools.Annotator

All Implemented Interfaces:

CleanUpHandler, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, SizeOfHandler, CustomizableTool, Tool, Serializable

public class Annotator
extends AbstractToolWithParameterPanel

For switching between types of annotator tools.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractAnnotator	m_Annotator	the annotator to use.
protected GenericObjectEditorPanel	m_GOEAnnotator	the GOE for selecting the annotator.

Fields inherited from class adams.gui.visualization.object.tools.AbstractToolWithParameterPanel

m_ButtonApply, m_ButtonFavorites, m_IgnoreOptionsUpdate, m_InitialOptions, m_ParameterPanel

Fields inherited from class adams.gui.visualization.object.tools.AbstractTool

m_CanvasPanel, m_KeyListener, m_Listener, m_Modified, m_MotionListener, m_PanelFullOptions, m_PanelOptions

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
Annotator()

Method Summary

Modifier and Type	Method	Description
void	activate()	Gets called to activate the tool.
protected void	addOptions(ParameterPanel paramPanel)	Fills the parameter panel with the options.
protected Cursor	createCursor()	Creates the mouse cursor to use.
protected ToolMouseAdapter	createMouseListener()	Creates the mouse listener to use.
protected ToolMouseMotionAdapter	createMouseMotionListener()	Creates the mouse motion listener to use.
protected void	doApply()	Applies the settings.
AbstractAnnotator	getAnnotator()	Returns the annotator in use.
Icon	getIcon()	The icon of the tool.
String	getName()	The name of the tool.
String	globalInfo()	Returns a string describing the object.
void	setAnnotator(AbstractAnnotator value)	Sets the annotator to use.

Methods inherited from class adams.gui.visualization.object.tools.AbstractToolWithParameterPanel

apply, applyOptions, applyOptionsQuietly, createOptionPanel, getCurrentOptions, getFavoritesOptions, getOption, getOptionPanel, initialize, postProcessCurrentOptions, retrieveCurrentOptions, setFavoritesOptions, setInitialOptions, setOption, showFavoritesMenu, updateOptions

Methods inherited from class adams.gui.visualization.object.tools.AbstractTool

checkBeforeApply, cleanUp, createApplyButton, createKeyListener, deactivate, getCanvas, getCursor, getImage, getKeyListener, getModifiedIcon, getMouseListener, getMouseMotionListener, getUnmodifiedIcon, getZoom, hasImage, isModified, setApplyButtonState, setCanvas, update

Methods inherited from class adams.core.logging.CustomLoggingLevelObject

setLoggingLevel

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.CleanUpHandler

cleanUp

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel, setLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter

getLogger, isLoggingEnabled

Methods inherited from interface adams.gui.visualization.object.tools.Tool

deactivate, getCanvas, getCursor, getImage, getKeyListener, getMouseListener, getMouseMotionListener, getZoom, hasImage, isModified, setCanvas, update

Field Detail

m_GOEAnnotator

protected GenericObjectEditorPanel m_GOEAnnotator

the GOE for selecting the annotator.

m_Annotator

protected AbstractAnnotator m_Annotator

the annotator to use.

Constructor Detail

Annotator

public Annotator()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Returns:

a description suitable for displaying in the gui

getName

public String getName()

The name of the tool.

Returns:

the name

getIcon

public Icon getIcon()

The icon of the tool.

Returns:

the icon

createCursor

protected Cursor createCursor()

Creates the mouse cursor to use.

Specified by:

createCursor in class AbstractTool

Returns:

the cursor

createMouseListener

protected ToolMouseAdapter createMouseListener()

Creates the mouse listener to use.

Specified by:

createMouseListener in class AbstractTool

Returns:

the listener, null if not applicable

createMouseMotionListener

protected ToolMouseMotionAdapter createMouseMotionListener()

Creates the mouse motion listener to use.

Specified by:

createMouseMotionListener in class AbstractTool

Returns:

the listener, null if not applicable

doApply

protected void doApply()

Applies the settings.

Specified by:

doApply in class AbstractTool

addOptions

protected void addOptions(ParameterPanel paramPanel)

Fills the parameter panel with the options.

Specified by:

addOptions in class AbstractToolWithParameterPanel

Parameters:

paramPanel - for adding the options to

activate

public void activate()

Gets called to activate the tool.

Specified by:

activate in interface Tool

Overrides:

activate in class AbstractTool

setAnnotator

public void setAnnotator(AbstractAnnotator value)

Sets the annotator to use.

Parameters:

value - the annotator

getAnnotator

public AbstractAnnotator getAnnotator()

Returns the annotator in use.

Returns:

the annotator