Package adams.gui.visualization.sequence

Class BarPaintlet

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.core.AbstractPaintlet

adams.gui.visualization.core.AbstractStrokePaintlet

adams.gui.visualization.sequence.AbstractXYSequencePaintlet

adams.gui.visualization.sequence.AbstractXYSequenceMetaDataColorPaintlet

adams.gui.visualization.sequence.BarPaintlet

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<Paintlet>, SizeOfHandler, Paintlet, HitDetectorSupporter<AbstractXYSequencePointHitDetector>, MetaDataColorPaintlet, PaintletWithCustomDataSupport, PaintletWithOptionalPointPreprocessor, XYSequencePaintlet, XYSequencePaintletWithCustomerContainerManager, Serializable

public class BarPaintlet
extends AbstractXYSequenceMetaDataColorPaintlet
implements PaintletWithCustomDataSupport

Paintlet for painting a bar plot for a sequence.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-stroke-thickness <float> (property: strokeThickness)
    The thickness of the stroke.
    default: 1.0
    minimum: 0.01
 

-meta-data-color <adams.gui.visualization.sequence.metadatacolor.AbstractMetaDataColor> (property: metaDataColor)
    The scheme to use for extracting the color from the meta-data; ignored if 
    adams.gui.visualization.sequence.metadatacolor.Dummy.
    default: adams.gui.visualization.sequence.metadatacolor.Dummy
 

-width <int> (property: width)
    The width of the bar in pixel.
    default: 20
    minimum: 1
 

-offset <int> (property: offset)
    The X offset for additional sequences in pixel.
    default: 0
 

-paint-all <boolean> (property: paintAll)
    If set to true, all data points will be painted, regardless whether they 
    are visible or not.
    default: false
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_CurrentOffset	the current offset.
protected int	m_Offset	the offset factor.
protected boolean	m_PaintAll	whether to paint all the data points (no optimization).
protected int	m_Width	the width of the bar.

Fields inherited from class adams.gui.visualization.sequence.AbstractXYSequenceMetaDataColorPaintlet

m_MetaDataColor

Fields inherited from class adams.gui.visualization.sequence.AbstractXYSequencePaintlet

m_CustomerContainerManager, m_HitDetector, m_PointPreprocessor

Fields inherited from class adams.gui.visualization.core.AbstractStrokePaintlet

m_StrokeThickness

Fields inherited from class adams.gui.visualization.core.AbstractPaintlet

m_Enabled, m_Initializing, m_Panel, m_RepaintOnChange

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected void	doDrawCustomData(Graphics g, PaintEvent.PaintMoment moment, XYSequence data, Color color)	Draws the data with the given color.
protected void	doPerformPaint(Graphics g, PaintEvent.PaintMoment moment)	The paint routine of the paintlet.
void	drawCustomData(Graphics g, PaintEvent.PaintMoment moment, XYSequence data, Color color)	Draws the data with the given color.
int	getOffset()	Returns the X offset for additional sequences.
boolean	getPaintAll()	Returns whether marker shapes are disabled.
int	getWidth()	Returns the width of the bar.
String	globalInfo()	Returns a string describing the object.
AbstractXYSequencePointHitDetector	newHitDetector()	Returns a new instance of the hit detector to use.
String	offsetTipText()	Returns the tip text for this property.
String	paintAllTipText()	Returns the tip text for this property.
void	setOffset(int value)	Sets the X offset for additional sequences.
void	setPaintAll(boolean value)	Sets whether to draw markers or not.
void	setWidth(int value)	Sets the width of the bar.
protected void	updateHitDetector()	Updates the settings of the hit detector.
String	widthTipText()	Returns the tip text for this property.

Methods inherited from class adams.gui.visualization.sequence.AbstractXYSequenceMetaDataColorPaintlet

getMetaDataColor, metaDataColorTipText, setMetaDataColor

Methods inherited from class adams.gui.visualization.sequence.AbstractXYSequencePaintlet

getActualContainerManager, getColor, getCustomerContainerManager, getHitDetector, getPaintMoment, getPointPreprocessor, getSequencePanel, initialize, memberChanged, newPointPreprocessor, pointPreprocessorTipText, setCustomContainerManager, setLoggingLevel, setPanel, setPointPreprocessor, supportsPointPreprocessor

Methods inherited from class adams.gui.visualization.core.AbstractStrokePaintlet

applyStroke, getStrokeThickness, getStrokeWidth, performPaint, setStrokeThickness, strokeThicknessTipText

Methods inherited from class adams.gui.visualization.core.AbstractPaintlet

canPaint, finishInit, forCommandLine, forName, getPaintlets, getPanel, getPlot, getRepaintOnChange, hasPanel, isEnabled, isInitializing, memberChanged, paint, repaint, setEnabled, setPanel, setRepaintOnChange, shallowCopy, shallowCopy, updatePanel

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, reset, 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

Methods inherited from interface adams.gui.visualization.core.Paintlet

canPaint, getPaintMoment, getPanel, getPlot, getRepaintOnChange, hasPanel, isEnabled, paint, performPaint, setEnabled, setPanel, setPanel, setRepaintOnChange

Methods inherited from interface adams.core.ShallowCopySupporter

shallowCopy, shallowCopy

Methods inherited from interface adams.gui.visualization.sequence.XYSequencePaintlet

getSequencePanel

Field Detail

m_PaintAll

protected boolean m_PaintAll

whether to paint all the data points (no optimization).

m_Width

protected int m_Width

the width of the bar.

m_Offset

protected int m_Offset

the offset factor.

m_CurrentOffset

protected int m_CurrentOffset

the current offset.

Constructor Detail

BarPaintlet

public BarPaintlet()

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 AbstractXYSequenceMetaDataColorPaintlet

setWidth

public void setWidth(int value)

Sets the width of the bar.

Parameters:

value - width in pixel

getWidth

public int getWidth()

Returns the width of the bar.

Returns:

width in pixel

widthTipText

public String widthTipText()

Returns the tip text for this property.

Returns:

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

setOffset

public void setOffset(int value)

Sets the X offset for additional sequences.

Parameters:

value - offset in pixel

getOffset

public int getOffset()

Returns the X offset for additional sequences.

Returns:

offset in pixel

offsetTipText

public String offsetTipText()

Returns the tip text for this property.

Returns:

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

setPaintAll

public void setPaintAll(boolean value)

Sets whether to draw markers or not.

Parameters:

value - if true then marker shapes won't be drawn

getPaintAll

public boolean getPaintAll()

Returns whether marker shapes are disabled.

Returns:

true if marker shapes are disabled

paintAllTipText

public String paintAllTipText()

Returns the tip text for this property.

Returns:

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

newHitDetector

public AbstractXYSequencePointHitDetector newHitDetector()

Returns a new instance of the hit detector to use.

Specified by:

newHitDetector in interface XYSequencePaintlet

Specified by:

newHitDetector in class AbstractXYSequencePaintlet

Returns:

the hit detector

updateHitDetector

protected void updateHitDetector()

Updates the settings of the hit detector.

Overrides:

updateHitDetector in class AbstractXYSequencePaintlet

doDrawCustomData

protected void doDrawCustomData(Graphics g,
                                PaintEvent.PaintMoment moment,
                                XYSequence data,
                                Color color)

Draws the data with the given color.

Parameters:

g - the graphics context

moment - the paint moment

data - the data to draw

color - the color to draw in

drawCustomData

public void drawCustomData(Graphics g,
                           PaintEvent.PaintMoment moment,
                           XYSequence data,
                           Color color)

Draws the data with the given color.

Specified by:

drawCustomData in interface PaintletWithCustomDataSupport

Parameters:

g - the graphics context

moment - the paint moment

data - the data to draw

color - the color to draw in

doPerformPaint

protected void doPerformPaint(Graphics g,
                              PaintEvent.PaintMoment moment)

The paint routine of the paintlet.

Specified by:

doPerformPaint in class AbstractStrokePaintlet

Parameters:

g - the graphics context to use for painting

moment - what PaintEvent.PaintMoment is currently being painted