Package adams.gui.visualization.jfreechart.shape

Class Cross

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.jfreechart.shape.AbstractShapeGenerator

adams.gui.visualization.jfreechart.shape.Cross

All Implemented Interfaces:

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

public class Cross
extends AbstractShapeGenerator

Generates a cross.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Cross.Type	Enumeration of type of cross.

Field Summary

Fields

Modifier and Type	Field	Description
protected float	m_Length	the length of the arms.
protected float	m_Thickness	the thickness of the arms.
protected Cross.Type	m_Type	the type of cross.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected Shape	doGenerate()	Generates the shape.
float	getLength()	Returns the length of the arms of the cross.
float	getThickness()	Returns the thickness of the arms of the cross.
Cross.Type	getType()	Returns the type of the cross.
String	globalInfo()	Returns a string describing the object.
String	lengthTipText()	Returns the tip text for this property.
void	setLength(float value)	Sets the length of the arms of the cross.
void	setThickness(float value)	Sets the thickness of the arms of the cross.
void	setType(Cross.Type value)	Sets the type of the cross.
String	thicknessTipText()	Returns the tip text for this property.
String	typeTipText()	Returns the tip text for this property.

Methods inherited from class adams.gui.visualization.jfreechart.shape.AbstractShapeGenerator

check, generate

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_Type

protected Cross.Type m_Type

the type of cross.

m_Length

protected float m_Length

the length of the arms.

m_Thickness

protected float m_Thickness

the thickness of the arms.

Constructor Detail

Cross

public Cross()

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 AbstractOptionHandler

setType

public void setType(Cross.Type value)

Sets the type of the cross.

Parameters:

value - the type

getType

public Cross.Type getType()

Returns the type of the cross.

Returns:

the type

typeTipText

public String typeTipText()

Returns the tip text for this property.

Returns:

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

setLength

public void setLength(float value)

Sets the length of the arms of the cross.

Parameters:

value - the length

getLength

public float getLength()

Returns the length of the arms of the cross.

Returns:

the length

lengthTipText

public String lengthTipText()

Returns the tip text for this property.

Returns:

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

setThickness

public void setThickness(float value)

Sets the thickness of the arms of the cross.

Parameters:

value - the thickness

getThickness

public float getThickness()

Returns the thickness of the arms of the cross.

Returns:

the thickness

thicknessTipText

public String thicknessTipText()

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 Shape doGenerate()

Generates the shape.

Specified by:

doGenerate in class AbstractShapeGenerator

Returns:

the shape, null if none generated