Package adams.gui.visualization.object.tools

Class Move

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.Move

All Implemented Interfaces:

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

public class Move
extends AbstractToolWithParameterPanel

For editing existing annotations.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Point	m_DragEnd	the end point of the drag.
protected boolean	m_Dragging	whether the mouse is being dragged.
protected Point	m_DragStart	the starting point of the drag.
protected PolygonVertices	m_PolygonVertices	the polygon plotter to use.
protected String	m_Prefix	the object prefix to use.
protected List<LocatedObject>	m_SelectedObjects	the currently selected object.
protected BaseTextField	m_TextPrefix	the object prefix to use.

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
Move()

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 ToolKeyAdapter	createKeyListener()	Creates the key listener to use.
protected ToolMouseAdapter	createMouseListener()	Creates the mouse listener to use.
protected ToolMouseMotionAdapter	createMouseMotionListener()	Creates the mouse motion listener to use.
void	deactivate()	Gets called to deactivate the tool.
protected void	doApply()	Applies the settings.
Icon	getIcon()	The icon of the tool.
String	getName()	The name of the tool.
String	globalInfo()	Returns a string describing the object.
protected void	initialize()	Initializes the members.
protected boolean	moveObjects(Point start, Point end)	Moves the selected objects from starting point to end point.
protected void	selectObjects(Point p)	Attempts to select the object(s) at the specified location.
protected void	updateVertexOverlays()	Updates overlay(s) for the vertices.

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

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

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

checkBeforeApply, cleanUp, createApplyButton, 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

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

Field Detail

m_TextPrefix

protected BaseTextField m_TextPrefix

the object prefix to use.

m_Prefix

protected String m_Prefix

the object prefix to use.

m_SelectedObjects

protected List<LocatedObject> m_SelectedObjects

the currently selected object.

m_Dragging

protected boolean m_Dragging

whether the mouse is being dragged.

m_DragStart

protected Point m_DragStart

the starting point of the drag.

m_DragEnd

protected Point m_DragEnd

the end point of the drag.

m_PolygonVertices

protected PolygonVertices m_PolygonVertices

the polygon plotter to use.

Constructor Detail

Move

public Move()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Returns:

a description suitable for displaying in the gui

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractToolWithParameterPanel

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

updateVertexOverlays

protected void updateVertexOverlays()

Updates overlay(s) for the vertices.

selectObjects

protected void selectObjects(Point p)

Attempts to select the object(s) at the specified location.

Parameters:

p - the image location to select the annotation(s) from

moveObjects

protected boolean moveObjects(Point start,
                              Point end)

Moves the selected objects from starting point to end point.

Parameters:

start - the start point

end - the end point

Returns:

whether the objects got moved

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

createKeyListener

protected ToolKeyAdapter createKeyListener()

Description copied from class: AbstractTool

Creates the key listener to use.
Default implementation just returns null.

Overrides:

createKeyListener 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

deactivate

public void deactivate()

Gets called to deactivate the tool.

Specified by:

deactivate in interface Tool

Overrides:

deactivate in class AbstractTool