Package adams.gui.visualization.object.mouseclick

Class ViewObjects

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.object.mouseclick.AbstractMouseClickProcessor

adams.gui.visualization.object.mouseclick.ViewObjects

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable

public class ViewObjects
extends AbstractMouseClickProcessor

Displays the annotated objects in a dialog that contain the click position.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class adams.gui.visualization.object.mouseclick.AbstractMouseClickProcessor

AbstractMouseClickProcessor.MouseButton

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseString[]	m_MetaDataKeys	the keys in the meta-data.

Fields inherited from class adams.gui.visualization.object.mouseclick.AbstractMouseClickProcessor

m_AltDown, m_Button, m_ClickCount, m_CtrlDown, m_Enabled, m_MetaDown, m_ShiftDown

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
ViewObjects()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected void	doProcess(ObjectAnnotationPanel panel, MouseEvent e)	Processes the mouse event.
protected BaseString[]	getDefaultMetaDataKeys()	Returns the default meta-data keys.
BaseString[]	getMetaDataKeys()	Returns the meta-data keys to display in separate columns.
String	globalInfo()	Returns a string describing the object.
String	metaDataKeysTipText()	Returns the tip text for this property.
void	setMetaDataKeys(BaseString[] value)	Sets the meta-data keys to display in separate columns.

Methods inherited from class adams.gui.visualization.object.mouseclick.AbstractMouseClickProcessor

altDownTipText, buttonTipText, clickCountTipText, ctrlDownTipText, determineHits, enabledTipText, getAltDown, getButton, getClickCount, getCtrlDown, getEnabled, getMetaDown, getShiftDown, metaDownTipText, process, setAltDown, setButton, setClickCount, setCtrlDown, setEnabled, setMetaDown, setShiftDown, shiftDownTipText

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

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, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_MetaDataKeys

protected BaseString[] m_MetaDataKeys

the keys in the meta-data.

Constructor Detail

ViewObjects

public ViewObjects()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractMouseClickProcessor

getDefaultMetaDataKeys

protected BaseString[] getDefaultMetaDataKeys()

Returns the default meta-data keys.

Returns:

the default

setMetaDataKeys

public void setMetaDataKeys(BaseString[] value)

Sets the meta-data keys to display in separate columns.

Parameters:

value - the keys

getMetaDataKeys

public BaseString[] getMetaDataKeys()

Returns the meta-data keys to display in separate columns.

Returns:

the keys

metaDataKeysTipText

public String metaDataKeysTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

doProcess

protected void doProcess(ObjectAnnotationPanel panel,
                         MouseEvent e)

Processes the mouse event.

Specified by:

doProcess in class AbstractMouseClickProcessor

Parameters:

panel - the owning panel

e - the event