adams.gui.visualization.stats.paintlet
Class VsOrderPaintlet

java.lang.Object
  extended by adams.core.ConsoleObject
      extended by adams.core.option.AbstractOptionHandler
          extended by adams.gui.visualization.core.AbstractPaintlet
              extended by adams.gui.visualization.core.AbstractStrokePaintlet
                  extended by adams.gui.visualization.stats.paintlet.AbstractColorPaintlet
                      extended by adams.gui.visualization.stats.paintlet.VsOrderPaintlet
All Implemented Interfaces:
Debuggable, Destroyable, OptionHandler, ShallowCopySupporter<Paintlet>, SizeOfHandler, AntiAliasingPaintlet, Paintlet, Serializable

public class VsOrderPaintlet
extends AbstractColorPaintlet
implements AntiAliasingPaintlet

Paints the data for the versus order graph

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
 
-color <java.awt.Color> (property: color)
    Stroke color for the paintlet
    default: #000000
 
-size <int> (property: size)
    Size of the data points
    default: 5
 
-fill-point (property: fillPoint)
    Whether to fill the data point with solid color
 
-fill-color <java.awt.Color> (property: fillColor)
    color for filling the data points
    default: #ff0000
 

Version:
$Revision: 6341 $
Author:
msf8
See Also:
Serialized Form

Field Summary
protected  boolean m_AntiAliasingEnabled
          whether anti-aliasing is enabled.
protected  boolean m_Fill
          Whether to fill the data points
protected  Color m_FillColor
          Color to fill the data points
protected  int m_Index
          Index of residuals attribute in the instances
protected  int m_Size
          Size of the data points
 
Fields inherited from class adams.gui.visualization.stats.paintlet.AbstractColorPaintlet
m_Color, m_Instances
 
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
VsOrderPaintlet()
           
 
Method Summary
 String antiAliasingEnabledTipText()
          Returns the tip text for this property.
 void defineOptions()
          Adds options to the internal list of options.
 String fillColorTipText()
          Tip text for the color property
 String fillPointTipText()
          Tip text for the fill point property
 Color getFillColor()
          Get the color to fill the points
 boolean getFillPoint()
          get whether the data points should be filled
 PaintEvent.PaintMoment getPaintMoment()
          Returns when this paintlet is to be executed.
 int getSize()
          Get the size of the data points
 String globalInfo()
           
 boolean isAntiAliasingEnabled()
          Returns whether anti-aliasing is used.
 void performPaint(Graphics g, PaintEvent.PaintMoment moment)
          The paint routine of the paintlet.
 void setAntiAliasingEnabled(boolean value)
          Sets whether to use anti-aliasing.
 void setFillColor(Color val)
          Set the color for filling the points
 void setFillPoint(boolean val)
          Set whether the data points should be filled
 void setIndex(int val)
          Set the index of the residuals attribute in the instances
 void setSize(int val)
          Set the size for the data points
 String sizeTipText()
          Tip text for the size property
 
Methods inherited from class adams.gui.visualization.stats.paintlet.AbstractColorPaintlet
colorTipText, getColor, getInstances, setColor, setInstances
 
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_Index

protected int m_Index
Index of residuals attribute in the instances


m_FillColor

protected Color m_FillColor
Color to fill the data points


m_Fill

protected boolean m_Fill
Whether to fill the data points


m_Size

protected int m_Size
Size of the data points


m_AntiAliasingEnabled

protected boolean m_AntiAliasingEnabled
whether anti-aliasing is enabled.

Constructor Detail

VsOrderPaintlet

public VsOrderPaintlet()
Method Detail

globalInfo

public String globalInfo()
Specified by:
globalInfo in class AbstractOptionHandler

defineOptions

public void defineOptions()
Description copied from class: AbstractColorPaintlet
Adds options to the internal list of options.

Specified by:
defineOptions in interface OptionHandler
Overrides:
defineOptions in class AbstractColorPaintlet

setFillPoint

public void setFillPoint(boolean val)
Set whether the data points should be filled

Parameters:
val - True if points filled

getFillPoint

public boolean getFillPoint()
get whether the data points should be filled

Returns:
true if data points filled

fillPointTipText

public String fillPointTipText()
Tip text for the fill point property

Returns:
String describing the property

setFillColor

public void setFillColor(Color val)
Set the color for filling the points

Parameters:
val - Fill color

getFillColor

public Color getFillColor()
Get the color to fill the points

Returns:
Color to fill

fillColorTipText

public String fillColorTipText()
Tip text for the color property

Returns:
String describing the property

setSize

public void setSize(int val)
Set the size for the data points

Parameters:
val - Size in pixels

getSize

public int getSize()
Get the size of the data points

Returns:
Size in pixels

sizeTipText

public String sizeTipText()
Tip text for the size property

Returns:
String describing the property

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.

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

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

setIndex

public void setIndex(int val)
Set the index of the residuals attribute in the instances

Parameters:
val - Index of residuals


Copyright © 2013 University of Waikato, Hamilton, NZ. All Rights Reserved.