adams.gui.visualization.stats.scatterplot
Class Diagonal

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.gui.visualization.stats.scatterplot.AbstractScatterPlotOverlay
              adams.gui.visualization.stats.scatterplot.Diagonal

All Implemented Interfaces:

Debuggable, Destroyable, OptionHandler, SizeOfHandler, Serializable

public class Diagonal
extends AbstractScatterPlotOverlay

Display a diagonal line overlay

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 

-line-thickness <float> (property: thickness)
    Thickness of the overlay line
    default: 2.0
    minimum: 1.0
    maximum: 5.0
 

-color <java.awt.Color> (property: color)
    Color of the overlay line
    default: #0000ff
 

-indicator (property: indicator)
    Display indicator lines on the axis to show what side diagonal on
 

Version:

$Revision: 4584 $

Author:

msf8

See Also:

Serialized Form

Field Summary

protected boolean

m_Indicator Whether an indicator should be displayed on the side of the plot showing where the diagonal is and at what gradient

Fields inherited from class adams.gui.visualization.stats.scatterplot.AbstractScatterPlotOverlay

m_Color, m_Instances, m_Paintlet, m_Parent, m_Thickness

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

Diagonal()

Method Summary

void	defineOptions()
boolean	getIndicator() get whether an indicator should be displayed
String	globalInfo()
String	indicatorTipText() Tip text for the indicator property
void	setIndicator(boolean val) Set whether an indicator should be displayed
void	setUp() set up the overlay and it's paintlet

Methods inherited from class adams.gui.visualization.stats.scatterplot.AbstractScatterPlotOverlay

colorTipText, getColor, getPaintlet, getParent, getThickness, inst, name, setColor, setParent, setThickness, shallowCopy, shallowCopy, thicknessTipText

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debug, debugLevelTipText, destroy, finishInit, getDebugLevel, getOptionManager, initialize, isDebugOn, newOptionManager, reset, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_Indicator

protected boolean m_Indicator

Whether an indicator should be displayed on the side of the plot showing where the diagonal is and at what gradient

Constructor Detail

Diagonal

public Diagonal()

Method Detail

globalInfo

public String globalInfo()

Specified by:

globalInfo in class AbstractOptionHandler

setUp

public void setUp()

Description copied from class: AbstractScatterPlotOverlay

set up the overlay and it's paintlet

Specified by:

setUp in class AbstractScatterPlotOverlay

defineOptions

public void defineOptions()

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractScatterPlotOverlay

setIndicator

public void setIndicator(boolean val)

Set whether an indicator should be displayed

Parameters:

val - True if indicator displayed

getIndicator

public boolean getIndicator()

get whether an indicator should be displayed

Returns:

True if indicator displayed

indicatorTipText

public String indicatorTipText()

Tip text for the indicator property

Returns:

String describing the property