Class AbstractScatterPlotOverlay
- java.lang.Object
-
- adams.core.logging.LoggingObject
-
- adams.core.logging.CustomLoggingLevelObject
-
- adams.core.option.AbstractOptionHandler
-
- adams.gui.visualization.stats.scatterplot.AbstractScatterPlotOverlay
-
- All Implemented Interfaces:
Destroyable
,GlobalInfoSupporter
,LoggingLevelHandler
,LoggingSupporter
,OptionHandler
,SizeOfHandler
,Serializable
- Direct Known Subclasses:
Coordinates
,Diagonal
,Lowess
,PolygonSelection
public abstract class AbstractScatterPlotOverlay extends AbstractOptionHandler
Abstract superclass for overlays on the scatterplot graph.- Version:
- $Revision$
- Author:
- msf8
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected Color
m_Color
Color of the overlayprotected SpreadSheet
m_Data
Instances object containing dataprotected AbstractOverlayPaintlet
m_Paintlet
Paintlet to do the drawingprotected AbstractScatterPlot
m_Parent
parent scatter plot to plot data onprotected float
m_Thickness
Thickness for overlay line-
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 AbstractScatterPlotOverlay()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description String
colorTipText()
Tip text for the color propertyvoid
defineOptions()
Adds options to the internal list of options.Color
getColor()
Get the color for this overlay.protected Color
getDefaultColor()
Returns the default color.protected float
getDefaultThickness()
Returns the default thickness.AbstractOverlayPaintlet
getPaintlet()
Get the paintlet that is doing the drawingprotected AbstractScatterPlot
getParent()
Return the scatter plot parent the overlay is being drawn on.float
getThickness()
Get the thickness of the overlay.void
inst(SpreadSheet inst)
Pass the instances to the overlay objectString
name()
Returns a string to display info on the overlayvoid
setColor(Color value)
Set the color for this overlay.void
setParent(AbstractScatterPlot val)
Set the scatterplot that this overlay is being drawn on.void
setThickness(float value)
Set the thickness of the overlay.abstract void
setUp()
set up the overlay and its paintlet.AbstractScatterPlotOverlay
shallowCopy()
Returns a shallow copy of itself, i.e., based on the commandline options.AbstractScatterPlotOverlay
shallowCopy(boolean expand)
Returns a shallow copy of itself, i.e., based on the commandline options.String
thicknessTipText()
Return a tip text for the thickness property.-
Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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_Parent
protected transient AbstractScatterPlot m_Parent
parent scatter plot to plot data on
-
m_Data
protected SpreadSheet m_Data
Instances object containing data
-
m_Paintlet
protected AbstractOverlayPaintlet m_Paintlet
Paintlet to do the drawing
-
m_Thickness
protected float m_Thickness
Thickness for overlay line
-
m_Color
protected Color m_Color
Color of the overlay
-
-
Method Detail
-
defineOptions
public void defineOptions()
Adds options to the internal list of options.- Specified by:
defineOptions
in interfaceOptionHandler
- Overrides:
defineOptions
in classAbstractOptionHandler
-
getDefaultThickness
protected float getDefaultThickness()
Returns the default thickness.- Returns:
- the default
-
setThickness
public void setThickness(float value)
Set the thickness of the overlay.- Parameters:
value
- Thickness in pixels
-
getThickness
public float getThickness()
Get the thickness of the overlay.- Returns:
- Thickness in pixels
-
thicknessTipText
public String thicknessTipText()
Return a tip text for the thickness property.- Returns:
- Tip text string
-
getDefaultColor
protected Color getDefaultColor()
Returns the default color.- Returns:
- the default
-
setColor
public void setColor(Color value)
Set the color for this overlay.- Parameters:
value
- Color of overlay
-
getColor
public Color getColor()
Get the color for this overlay.- Returns:
- Color used for overlay
-
colorTipText
public String colorTipText()
Tip text for the color property- Returns:
- String describing the property
-
setUp
public abstract void setUp()
set up the overlay and its paintlet.
-
getParent
protected AbstractScatterPlot getParent()
Return the scatter plot parent the overlay is being drawn on.- Returns:
- scatter plot
-
setParent
public void setParent(AbstractScatterPlot val)
Set the scatterplot that this overlay is being drawn on.
-
inst
public void inst(SpreadSheet inst)
Pass the instances to the overlay object- Parameters:
inst
- Instances to be plotted
-
getPaintlet
public AbstractOverlayPaintlet getPaintlet()
Get the paintlet that is doing the drawing- Returns:
- paintlet doing the drawing
-
name
public String name()
Returns a string to display info on the overlay
-
shallowCopy
public AbstractScatterPlotOverlay shallowCopy()
Returns a shallow copy of itself, i.e., based on the commandline options.- Returns:
- the shallow copy
-
shallowCopy
public AbstractScatterPlotOverlay shallowCopy(boolean expand)
Returns a shallow copy of itself, i.e., based on the commandline options.- Returns:
- the shallow copy
-
-