Package adams.gui.visualization.xchart.chart

Class AbstractChartGeneratorWithAxisLabels<C extends org.knowm.xchart.internal.chartpart.Chart,D extends Dataset>

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.xchart.chart.AbstractChartGenerator<C,D>

adams.gui.visualization.xchart.chart.AbstractChartGeneratorWithAxisLabels<C,D>

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, Serializable

Direct Known Subclasses:

AbstractXYChartGenerator, DensityScatterPlotChart

public abstract class AbstractChartGeneratorWithAxisLabels<C extends org.knowm.xchart.internal.chartpart.Chart,D extends Dataset>
extends AbstractChartGenerator<C,D>

Ancestor for chart generators that support axis labels.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_LabelX	the label for the X axis.
protected String	m_LabelY	the label for the Y axis.

Fields inherited from class adams.gui.visualization.xchart.chart.AbstractChartGenerator

m_Legend, m_LegendPosition, m_Title

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
String	getLabelX()	Returns the label for the X axis.
String	getLabelY()	Returns the label for the Y axis.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String	labelXTipText()	Returns the tip text for this property.
String	labelYTipText()	Returns the tip text for this property.
void	setLabelX(String value)	Sets the label for the X axis.
void	setLabelY(String value)	Sets the label for the Y axis.

Methods inherited from class adams.gui.visualization.xchart.chart.AbstractChartGenerator

addData, buildChart, check, doGenerate, generate, getLegend, getLegendPosition, getTitle, legendPositionTipText, legendTipText, postGenerate, setLegend, setLegendPosition, setTitle, styleChart, titleTipText

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_LabelX

protected String m_LabelX

the label for the X axis.

m_LabelY

protected String m_LabelY

the label for the Y axis.

Constructor Detail

AbstractChartGeneratorWithAxisLabels

public AbstractChartGeneratorWithAxisLabels()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractChartGenerator<C extends org.knowm.xchart.internal.chartpart.Chart,D extends Dataset>

setLabelX

public void setLabelX(String value)

Sets the label for the X axis.

Parameters:

value - the label

getLabelX

public String getLabelX()

Returns the label for the X axis.

Returns:

the label

labelXTipText

public String labelXTipText()

Returns the tip text for this property.

Returns:

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

setLabelY

public void setLabelY(String value)

Sets the label for the Y axis.

Parameters:

value - the label

getLabelY

public String getLabelY()

Returns the label for the Y axis.

Returns:

the label

labelYTipText

public String labelYTipText()

Returns the tip text for this property.

Returns:

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

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractChartGenerator<C extends org.knowm.xchart.internal.chartpart.Chart,D extends Dataset>

Returns:

null if no info available, otherwise short string