Class SimplePointAnnotator
- java.lang.Object
-
- adams.core.logging.LoggingObject
-
- adams.core.logging.CustomLoggingLevelObject
-
- adams.core.option.AbstractOptionHandler
-
- adams.gui.visualization.object.annotator.AbstractAnnotator
-
- adams.gui.visualization.object.annotator.AbstractReportBasedAnnotator
-
- adams.gui.visualization.object.annotator.AbstractPointAnnotator
-
- adams.gui.visualization.object.annotator.SimplePointAnnotator
-
- All Implemented Interfaces:
CleanUpHandler
,Destroyable
,GlobalInfoSupporter
,LoggingLevelHandler
,LoggingSupporter
,OptionHandler
,SizeOfHandler
,ObjectPrefixHandler
,AutoAdvanceAnnotator
,LabelSuffixHandler
,Serializable
public class SimplePointAnnotator extends AbstractPointAnnotator implements LabelSuffixHandler, AutoAdvanceAnnotator
For annotating single points.- Author:
- FracPete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected boolean
m_AutoAdvanceLabels
whether to automatically advance to the next label once one has been clicked.protected Color
m_Color
the color to use.protected boolean
m_Dragged
whether dragging has happened at all.protected String
m_LabelSuffix
the label suffix to use.protected MouseListener
m_MouseListener
the mouse listener to install.protected MouseMotionListener
m_MouseMotionListener
the mouse motion listener to install.protected Point
m_SelectionFrom
the starting corner of the selection box.protected Point
m_SelectionTo
the finishing corner of the selection box.protected float
m_StrokeThickness
the thickness of the stroke.-
Fields inherited from class adams.gui.visualization.object.annotator.AbstractPointAnnotator
m_Locations, m_NumDigits
-
Fields inherited from class adams.gui.visualization.object.annotator.AbstractReportBasedAnnotator
m_Prefix
-
Fields inherited from class adams.gui.visualization.object.annotator.AbstractAnnotator
m_Owner, m_Selecting
-
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 SimplePointAnnotator()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
autoAdvanceLabelsTipText()
Returns the tip text for this property.String
colorTipText()
Returns the tip text for this property.protected MouseListener
createMouseListener()
Creates the listener for mouse events.protected MouseMotionListener
createMouseMotionListener()
Creates the listener for mouse motion events.void
defineOptions()
Adds options to the internal list of options.protected void
doInstall()
Installs the annotator with the owner.protected void
doPaintSelection(Graphics g)
Paints the selection.protected void
doUninstall()
Uninstalls the annotator with the owner.boolean
getAutoAdvanceLabels()
Returns whether to auto advance labels once one has been applied.Color
getColor()
Returns the color to use.protected String
getDefaultLabel()
Returns the default label to use for the objects.protected String
getDefaultLabelSuffix()
Returns the default suffix to use for the label.String
getLabelSuffix()
Returns the suffix to use for the label.float
getStrokeThickness()
Returns the current stroke thickness.String
globalInfo()
Returns a string describing the object.protected void
initialize()
Initializes the members.String
labelSuffixTipText()
Returns the tip text for this property.protected void
processSelection(int modifiersEx)
Processes the selection.void
setAutoAdvanceLabels(boolean value)
Sets whether to auto advance labels once one has been applied.void
setColor(Color value)
Sets the color to use.void
setLabelSuffix(String value)
Sets the suffix to use for the label.void
setStrokeThickness(float value)
Sets the stroke thickness to use.String
strokeThicknessTipText()
Returns the tip text for this property.-
Methods inherited from class adams.gui.visualization.object.annotator.AbstractPointAnnotator
annotationsChanged, getDefaultNumDigits, getDefaultPrefix, getLocations, getNumDigits, numDigitsTipText, reset, setNumDigits
-
Methods inherited from class adams.gui.visualization.object.annotator.AbstractReportBasedAnnotator
findLastIndex, getPrefix, prefixTipText, removeIndex, setPrefix, valuesForIndex
-
Methods inherited from class adams.gui.visualization.object.annotator.AbstractAnnotator
applyStroke, cleanUp, getCurrentLabel, getOwner, getStrokeWidth, hasCurrentLabel, install, labelChanged, paintSelection, setOwner, uninstall
-
Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, 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_Color
protected Color m_Color
the color to use.
-
m_StrokeThickness
protected float m_StrokeThickness
the thickness of the stroke.
-
m_LabelSuffix
protected String m_LabelSuffix
the label suffix to use.
-
m_MouseListener
protected MouseListener m_MouseListener
the mouse listener to install.
-
m_Dragged
protected boolean m_Dragged
whether dragging has happened at all.
-
m_MouseMotionListener
protected MouseMotionListener m_MouseMotionListener
the mouse motion listener to install.
-
m_SelectionFrom
protected Point m_SelectionFrom
the starting corner of the selection box.
-
m_SelectionTo
protected Point m_SelectionTo
the finishing corner of the selection box.
-
m_AutoAdvanceLabels
protected boolean m_AutoAdvanceLabels
whether to automatically advance to the next label once one has been clicked.
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfo
in interfaceGlobalInfoSupporter
- Specified by:
globalInfo
in classAbstractOptionHandler
- 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 interfaceOptionHandler
- Overrides:
defineOptions
in classAbstractPointAnnotator
-
setColor
public void setColor(Color value)
Sets the color to use.- Parameters:
value
- the color
-
getColor
public Color getColor()
Returns the color to use.- Returns:
- the color
-
colorTipText
public String colorTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setStrokeThickness
public void setStrokeThickness(float value)
Sets the stroke thickness to use.- Parameters:
value
- the thickness
-
getStrokeThickness
public float getStrokeThickness()
Returns the current stroke thickness.- Returns:
- the thickness
-
strokeThicknessTipText
public String strokeThicknessTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
getDefaultLabel
protected String getDefaultLabel()
Returns the default label to use for the objects.- Returns:
- the default
-
getDefaultLabelSuffix
protected String getDefaultLabelSuffix()
Returns the default suffix to use for the label.- Returns:
- the default
-
setLabelSuffix
public void setLabelSuffix(String value)
Sets the suffix to use for the label.- Specified by:
setLabelSuffix
in interfaceLabelSuffixHandler
- Parameters:
value
- the suffix
-
getLabelSuffix
public String getLabelSuffix()
Returns the suffix to use for the label.- Specified by:
getLabelSuffix
in interfaceLabelSuffixHandler
- Returns:
- the suffix
-
labelSuffixTipText
public String labelSuffixTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setAutoAdvanceLabels
public void setAutoAdvanceLabels(boolean value)
Sets whether to auto advance labels once one has been applied.- Specified by:
setAutoAdvanceLabels
in interfaceAutoAdvanceAnnotator
- Parameters:
value
- true if to auto advance
-
getAutoAdvanceLabels
public boolean getAutoAdvanceLabels()
Returns whether to auto advance labels once one has been applied.- Specified by:
getAutoAdvanceLabels
in interfaceAutoAdvanceAnnotator
- Returns:
- true if auto advance
-
autoAdvanceLabelsTipText
public String autoAdvanceLabelsTipText()
Returns the tip text for this property.- Specified by:
autoAdvanceLabelsTipText
in interfaceAutoAdvanceAnnotator
- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
initialize
protected void initialize()
Initializes the members.- Overrides:
initialize
in classAbstractAnnotator
-
createMouseListener
protected MouseListener createMouseListener()
Creates the listener for mouse events.- Returns:
- the instance
-
createMouseMotionListener
protected MouseMotionListener createMouseMotionListener()
Creates the listener for mouse motion events.- Returns:
- the instance
-
processSelection
protected void processSelection(int modifiersEx)
Processes the selection.- Parameters:
modifiersEx
- the associated modifiers
-
doInstall
protected void doInstall()
Installs the annotator with the owner.- Specified by:
doInstall
in classAbstractAnnotator
-
doUninstall
protected void doUninstall()
Uninstalls the annotator with the owner.- Specified by:
doUninstall
in classAbstractAnnotator
-
doPaintSelection
protected void doPaintSelection(Graphics g)
Paints the selection.- Specified by:
doPaintSelection
in classAbstractAnnotator
- Parameters:
g
- the graphics context
-
-