Package adams.gui.visualization.image.leftclick

Class AddMetaData

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.image.leftclick.AbstractLeftClickProcessor

adams.gui.visualization.image.leftclick.AddMetaData

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<AbstractLeftClickProcessor>, SizeOfHandler, ImagePanelLeftClickListener, Serializable, EventListener

public class AddMetaData
extends AbstractLeftClickProcessor

Allows the user to add meta-data to the selected objects.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_LastField	the last field name.
protected String	m_LastType	the last field type.
protected String	m_LastValue	the last field value.
protected String	m_Prefix	the prefix for the objects.

Fields inherited from class adams.gui.visualization.image.leftclick.AbstractLeftClickProcessor

m_AltDown, m_CtrlDown, 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
AddMetaData()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected void	doProcessClick(ImagePanel panel, Point position, int modifiersEx)	Process the click that occurred in the image panel.
protected String	getDefaultPrefix()	Returns the default prefix to use for the objects.
String	getPrefix()	Returns the prefix to use for the objects.
String	globalInfo()	Returns a string describing the object.
String	prefixTipText()	Returns the tip text for this property.
void	setPrefix(String value)	Sets the prefix to use for the objects.

Methods inherited from class adams.gui.visualization.image.leftclick.AbstractLeftClickProcessor

altDownTipText, check, clicked, ctrlDownTipText, doImageChanged, getAltDown, getCtrlDown, getMetaDown, getShiftDown, imageChanged, metaDownTipText, processClick, setAltDown, setCtrlDown, setMetaDown, setShiftDown, shallowCopy, shallowCopy, 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_Prefix

protected String m_Prefix

the prefix for the objects.

m_LastField

protected transient String m_LastField

the last field name.

m_LastValue

protected transient String m_LastValue

the last field value.

m_LastType

protected transient String m_LastType

the last field type.

Constructor Detail

AddMetaData

public AddMetaData()

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 AbstractLeftClickProcessor

getDefaultPrefix

protected String getDefaultPrefix()

Returns the default prefix to use for the objects.

Returns:

the default

setPrefix

public void setPrefix(String value)

Sets the prefix to use for the objects.

Parameters:

value - the prefix

getPrefix

public String getPrefix()

Returns the prefix to use for the objects.

Returns:

the prefix

prefixTipText

public String prefixTipText()

Returns the tip text for this property.

Returns:

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

doProcessClick

protected void doProcessClick(ImagePanel panel,
                              Point position,
                              int modifiersEx)

Process the click that occurred in the image panel.

Specified by:

doProcessClick in class AbstractLeftClickProcessor

Parameters:

panel - the origin

position - the position of the click

modifiersEx - the associated modifiers