Package adams.gui.visualization.sequence

Class MetaDataValuePaintlet

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

All Implemented Interfaces:

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

public class MetaDataValuePaintlet
extends AbstractXYSequenceMetaDataColorPaintlet
implements AntiAliasingSupporter, PaintletWithCustomDataSupport, DiameterBasedPaintlet

Paintlet for painting a meta-data value as text, centered at the specified X-Y position. If value is not present, it simply paints a circle.

-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
 

-meta-data-key <java.lang.String> (property: metaDataKey)
    The key of the meta-data value to paint.
    default:
 

-font <java.awt.Font> (property: font)
    The font to use for the meta-data value.
    default: Display-PLAIN-14
 

-diameter <int> (property: diameter)
    The diameter of the circle in pixels.
    default: 7
    minimum: 1
 

-anti-aliasing-enabled <boolean> (property: antiAliasingEnabled)
    If enabled, uses anti-aliasing for drawing circles.
    default: true
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_AntiAliasingEnabled	whether anti-aliasing is enabled.
protected int	m_Diameter	the diameter of the circle.
protected Map<String,Dimension>	m_DimensionsCache	the dimensions cache (text -> dimension).
protected Font	m_Font	the label font.
protected String	m_MetaDataKey	the meta-data key.

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

Method Summary

Modifier and Type	Method	Description
String	antiAliasingEnabledTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
String	diameterTipText()	Returns the tip text for this property.
protected void	doDrawCustomData(Graphics g, PaintEvent.PaintMoment moment, XYSequence data, Color color)	Draws the custom 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.
String	fontTipText()	Returns the tip text for this property.
int	getDiameter()	Returns the diameter of the circle.
Font	getFont()	Returns the meta-data value font.
String	getMetaDataKey()	Returns the meta-data key.
String	globalInfo()	Returns a string describing the object.
boolean	isAntiAliasingEnabled()	Returns whether anti-aliasing is used.
void	memberChanged()	Executes a repaints only if the changes to members are not ignored.
String	metaDataKeyTipText()	Returns the tip text for this property.
AbstractXYSequencePointHitDetector	newHitDetector()	Returns a new instance of the hit detector to use.
void	setAntiAliasingEnabled(boolean value)	Sets whether to use anti-aliasing.
void	setDiameter(int value)	Sets the circle diameter.
void	setFont(Font value)	Sets the meta-data value font.
void	setMetaDataKey(String value)	Sets the meta-data key.

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, newPointPreprocessor, pointPreprocessorTipText, setCustomContainerManager, setLoggingLevel, setPanel, setPointPreprocessor, supportsPointPreprocessor, updateHitDetector

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_MetaDataKey

protected String m_MetaDataKey

the meta-data key.

m_Font

protected Font m_Font

the label font.

m_Diameter

protected int m_Diameter

the diameter of the circle.

m_AntiAliasingEnabled

protected boolean m_AntiAliasingEnabled

whether anti-aliasing is enabled.

m_DimensionsCache

protected Map<String,Dimension> m_DimensionsCache

the dimensions cache (text -> dimension).

Constructor Detail

MetaDataValuePaintlet

public MetaDataValuePaintlet()

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

memberChanged

public void memberChanged()

Executes a repaints only if the changes to members are not ignored.

Overrides:

memberChanged in class AbstractXYSequencePaintlet

See Also:

AbstractPaintlet.getRepaintOnChange(), AbstractPaintlet.isInitializing(), AbstractPaintlet.repaint()

setMetaDataKey

public void setMetaDataKey(String value)

Sets the meta-data key.

Parameters:

value - the key

getMetaDataKey

public String getMetaDataKey()

Returns the meta-data key.

Returns:

the key

metaDataKeyTipText

public String metaDataKeyTipText()

Returns the tip text for this property.

Returns:

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

setFont

public void setFont(Font value)

Sets the meta-data value font.

Parameters:

value - the font

getFont

public Font getFont()

Returns the meta-data value font.

Returns:

the font

fontTipText

public String fontTipText()

Returns the tip text for this property.

Returns:

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

setDiameter

public void setDiameter(int value)

Sets the circle diameter.

Specified by:

setDiameter in interface DiameterBasedPaintlet

Parameters:

value - the diameter

getDiameter

public int getDiameter()

Returns the diameter of the circle.

Specified by:

getDiameter in interface DiameterBasedPaintlet

Returns:

the diameter

diameterTipText

public String diameterTipText()

Returns the tip text for this property.

Specified by:

diameterTipText in interface DiameterBasedPaintlet

Returns:

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

setAntiAliasingEnabled

public void setAntiAliasingEnabled(boolean value)

Sets whether to use anti-aliasing.

Specified by:

setAntiAliasingEnabled in interface AntiAliasingSupporter

Parameters:

value - if true then anti-aliasing is used

isAntiAliasingEnabled

public boolean isAntiAliasingEnabled()

Returns whether anti-aliasing is used.

Specified by:

isAntiAliasingEnabled in interface AntiAliasingSupporter

Returns:

true if anti-aliasing is used

antiAliasingEnabledTipText

public String antiAliasingEnabledTipText()

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

doDrawCustomData

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

Draws the custom 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