Package adams.gui.visualization.core.axis

Class PeriodicityTickGenerator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.core.axis.AbstractTickGenerator

adams.gui.visualization.core.axis.PeriodicityTickGenerator

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<TickGenerator>, SizeOfHandler, TickGenerator, Serializable

public class PeriodicityTickGenerator
extends AbstractTickGenerator

A periodicity tick generator.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Formatter	m_Formatter	the format for outputting the values (SimpleDateFormat or DecimalFormat).
protected PeriodicityType	m_Periodicity	the periodicity type.

Fields inherited from class adams.gui.visualization.core.axis.AbstractTickGenerator

m_Labels, m_Parent, m_Ticks

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected void	doGenerate()	Generate the ticks of this axis.
String	formatTipText()	Returns the tip text for this property.
protected String	getDefaultFormat()	Returns the default format.
String	getFormat()	Returns the format used for the ticks.
PeriodicityType	getPeriodicity()	Returns the type of periodicity to use.
String	globalInfo()	Returns a string describing the object.
protected void	initialize()	Initializes the members.
String	periodicityTipText()	Returns the tip text for this property.
void	setFormat(String value)	Sets the format used for the ticks.
void	setPeriodicity(PeriodicityType value)	Sets the type of periodicity to use.

Methods inherited from class adams.gui.visualization.core.axis.AbstractTickGenerator

addLabel, fixLabel, forCommandLine, forName, getGenerators, getParent, getTicks, hasLabel, postGenerate, preGenerate, reset, setParent, shallowCopy, shallowCopy

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.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_Periodicity

protected PeriodicityType m_Periodicity

the periodicity type.

m_Formatter

protected Formatter m_Formatter

the format for outputting the values (SimpleDateFormat or DecimalFormat).

Constructor Detail

PeriodicityTickGenerator

public PeriodicityTickGenerator()

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

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractTickGenerator

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setPeriodicity

public void setPeriodicity(PeriodicityType value)

Sets the type of periodicity to use.

Parameters:

value - the type

getPeriodicity

public PeriodicityType getPeriodicity()

Returns the type of periodicity to use.

Returns:

the type

periodicityTipText

public String periodicityTipText()

Returns the tip text for this property.

Returns:

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

getDefaultFormat

protected String getDefaultFormat()

Returns the default format.

Returns:

the format

setFormat

public void setFormat(String value)

Sets the format used for the ticks.

Parameters:

value - the format

getFormat

public String getFormat()

Returns the format used for the ticks.

Returns:

the format

formatTipText

public String formatTipText()

Returns the tip text for this property.

Returns:

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

doGenerate

protected void doGenerate()

Generate the ticks of this axis.

Specified by:

doGenerate in class AbstractTickGenerator