adams.gui.visualization.instance
Class InstanceLinePaintlet

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.gui.visualization.core.AbstractPaintlet
              adams.gui.visualization.core.AbstractStrokePaintlet
                  adams.gui.visualization.container.AbstractDataContainerPaintlet
                      adams.gui.visualization.instance.InstanceLinePaintlet

All Implemented Interfaces:

Debuggable, Destroyable, OptionHandler, ShallowCopySupporter<Paintlet>, SizeOfHandler, AntiAliasingPaintlet, Paintlet, Serializable

public class InstanceLinePaintlet
extends AbstractDataContainerPaintlet
implements AntiAliasingPaintlet

Paintlet for generating a line plot for Instance objects.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 

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

-markers-extent <int> (property: markerExtent)
    default: 7
    minimum: 0
 

-markers-disabled (property: markersDisabled)
    If set to true, the markers are disabled.
 

Version:

$Revision: 5341 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

static class

InstanceLinePaintlet.MarkerShape Enum for the marker shape to plot around the data points.

Field Summary

protected boolean	m_AntiAliasingEnabled whether anti-aliasing is enabled.
protected int	m_MarkerExtent the maximum width/height of the shape to plot around the points (= data point marker), if there's enough space.
protected boolean	m_MarkersEnabled indicates whether marker shapes are painted or not.

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_DebugLevel, m_OptionManager

Constructor Summary

InstanceLinePaintlet()

Method Summary

String	antiAliasingEnabledTipText() Returns the tip text for this property.
void	defineOptions() Adds options to the internal list of options.
protected void	drawData(Graphics g, Instance data, Color color, InstanceLinePaintlet.MarkerShape marker) Draws the data with the given color.
Color	getColor(int index) Returns the color for the data with the given index.
InstancePanel	getInstancePanel() Returns the sequence panel currently in use.
int	getMarkerExtent() Returns the current marker extent (which is the width and height of the shape).
protected InstanceLinePaintlet.MarkerShape	getMarkerShape(int index) Determines the shape to paint around the data points, based on the index of the data.
PaintEvent.PaintMoment	getPaintMoment() Returns when this paintlet is to be executed.
String	globalInfo() Returns a string describing the object.
boolean	isAntiAliasingEnabled() Returns whether anti-aliasing is used.
boolean	isMarkersDisabled() Returns whether marker shapes are disabled.
String	markersDisabledTipText() Returns the tip text for this property.
String	markersExtentTipText() Returns the tip text for this property.
void	performPaint(Graphics g, PaintEvent.PaintMoment moment) The paint routine of the paintlet.
void	setAntiAliasingEnabled(boolean value) Sets whether to use anti-aliasing.
void	setMarkerExtent(int value) Sets the extent (width and height of the shape around the plotted point).
void	setMarkersDisabled(boolean value) Sets whether to draw markers or not.

Methods inherited from class adams.gui.visualization.container.AbstractDataContainerPaintlet

getDataContainerPanel

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

getStrokeThickness, paint, setStrokeThickness, strokeThicknessTipText

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

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

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debug, debugLevelTipText, destroy, getDebugLevel, getOptionManager, isDebugOn, newOptionManager, reset, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_MarkerExtent

protected int m_MarkerExtent

the maximum width/height of the shape to plot around the points (= data point marker), if there's enough space.

m_MarkersEnabled

protected boolean m_MarkersEnabled

indicates whether marker shapes are painted or not.

m_AntiAliasingEnabled

protected boolean m_AntiAliasingEnabled

whether anti-aliasing is enabled.

Constructor Detail

InstanceLinePaintlet

public InstanceLinePaintlet()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

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 AbstractStrokePaintlet

getInstancePanel

public InstancePanel getInstancePanel()

Returns the sequence panel currently in use.

Returns:

the panel in use

getPaintMoment

public PaintEvent.PaintMoment getPaintMoment()

Returns when this paintlet is to be executed.

Specified by:

getPaintMoment in interface Paintlet

Specified by:

getPaintMoment in class AbstractPaintlet

Returns:

when this paintlet is to be executed

getColor

public Color getColor(int index)

Returns the color for the data with the given index.

Parameters:

index - the index of the chromatogram

Returns:

the color for the chromatogram

isMarkersDisabled

public boolean isMarkersDisabled()

Returns whether marker shapes are disabled.

Returns:

true if marker shapes are disabled

setMarkersDisabled

public void setMarkersDisabled(boolean value)

Sets whether to draw markers or not.

Parameters:

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

markersDisabledTipText

public String markersDisabledTipText()

Returns the tip text for this property.

Returns:

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

setMarkerExtent

public void setMarkerExtent(int value)

Sets the extent (width and height of the shape around the plotted point). 0 turns the plotting off. Should be an odd number for centering the shape.

Parameters:

value - the new extent

getMarkerExtent

public int getMarkerExtent()

Returns the current marker extent (which is the width and height of the shape).

Returns:

the current extent

markersExtentTipText

public String markersExtentTipText()

Returns the tip text for this property.

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 AntiAliasingPaintlet

Parameters:

value - if true then anti-aliasing is used

isAntiAliasingEnabled

public boolean isAntiAliasingEnabled()

Returns whether anti-aliasing is used.

Specified by:

isAntiAliasingEnabled in interface AntiAliasingPaintlet

Returns:

true if anti-aliasing is used

antiAliasingEnabledTipText

public String antiAliasingEnabledTipText()

Returns the tip text for this property.

Specified by:

antiAliasingEnabledTipText in interface AntiAliasingPaintlet

Returns:

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

drawData

protected void drawData(Graphics g,
                        Instance data,
                        Color color,
                        InstanceLinePaintlet.MarkerShape marker)

Draws the data with the given color.

Parameters:

g - the graphics context

data - the data to draw

color - the color to draw in

marker - the type of marker to draw

getMarkerShape

protected InstanceLinePaintlet.MarkerShape getMarkerShape(int index)

Determines the shape to paint around the data points, based on the index of the data.

Parameters:

index - the index of the spectrum

Returns:

the marker shape

performPaint

public void performPaint(Graphics g,
                         PaintEvent.PaintMoment moment)

The paint routine of the paintlet.

Specified by:

performPaint in interface Paintlet

Specified by:

performPaint in class AbstractPaintlet

Parameters:

g - the graphics context to use for painting

moment - what PaintEvent.PaintMoment is currently being painted