Package adams.gui.visualization.stats.scatterplot

Class Diagonal

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.stats.scatterplot.AbstractScatterPlotOverlay

adams.gui.visualization.stats.scatterplot.Diagonal

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, 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$

Author:

msf8

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
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_Data, m_Paintlet, m_Parent, m_Thickness

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
Diagonal()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
boolean	getIndicator()	get whether an indicator should be displayed.
String	globalInfo()	Returns a string describing the object.
String	indicatorTipText()	Tip text for the indicator property.
void	setIndicator(boolean value)	Set whether an indicator should be displayed.
void	setUp()	set up the overlay and its paintlet.

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

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

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_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()

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 AbstractScatterPlotOverlay

setIndicator

public void setIndicator(boolean value)

Set whether an indicator should be displayed.

Parameters:

value - 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

setUp

public void setUp()

set up the overlay and its paintlet.

Specified by:

setUp in class AbstractScatterPlotOverlay