org.eclipse.nebula.visualization.xygraph.figures

Class Trace

java.lang.Object

org.eclipse.draw2d.Figure

org.eclipse.nebula.visualization.xygraph.figures.Trace

All Implemented Interfaces:

org.eclipse.draw2d.IFigure, IDataProviderListener, IAxisListener

public class Trace
extends org.eclipse.draw2d.Figure
implements IDataProviderListener, IAxisListener

The trace figure.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Trace.BaseLine
static class	Trace.ErrorBarType
static class	Trace.PointStyle
static class	Trace.TraceType The way how the trace will be drawn.

Nested classes/interfaces inherited from class org.eclipse.draw2d.Figure

org.eclipse.draw2d.Figure.FigureIterator, org.eclipse.draw2d.Figure.IdentitySearch

Nested classes/interfaces inherited from interface org.eclipse.draw2d.IFigure

org.eclipse.draw2d.IFigure.NoInsets

Field Summary

Fields inherited from class org.eclipse.draw2d.Figure

bgColor, border, bounds, fgColor, flags, font, MAX_FLAG, maxSize, minSize, NO_MANAGER, prefSize, toolTip

Fields inherited from interface org.eclipse.draw2d.IFigure

MAX_DIMENSION, MIN_DIMENSION, NO_INSETS

Constructor Summary

Constructors

Constructor and Description
Trace(java.lang.String name) init(Axis, Axis, IDataProvider) needs to be called if a trace is created with this constructor
Trace(java.lang.String name, Axis xAxis, Axis yAxis, IDataProvider dataProvider)

Method Summary

Modifier and Type	Method and Description
void	addListener(ITraceListener listener)
void	axisAutoScaleChanged(Axis axis, boolean oldAutoScale, boolean newAutoScale)
void	axisForegroundColorChanged(Axis axis, org.eclipse.swt.graphics.Color oldColor, org.eclipse.swt.graphics.Color newColor)
void	axisLogScaleChanged(Axis axis, boolean old, boolean logScale)
void	axisRangeChanged(Axis axis, Range old_range, Range new_range) This event indicates a change in the axis' value range
void	axisRevalidated(Axis axis) This method will be notified by axis whenever the axis is revalidated.
void	axisTitleChanged(Axis axis, java.lang.String oldTitle, java.lang.String newTitle)
void	dataChanged(IDataProvider dataProvider) This method will be notified by data provider whenever the data changed in data provider
void	dispose() Remove figures and reset fields
void	drawLine(org.eclipse.draw2d.Graphics graphics, org.eclipse.draw2d.geometry.Point p1, org.eclipse.draw2d.geometry.Point p2) Draw line with the line style and line width of the trace.
void	drawPoint(org.eclipse.draw2d.Graphics graphics, org.eclipse.draw2d.geometry.Point pos) Draw point with the pointStyle and size of the trace;
int	getAreaAlpha()
Trace.BaseLine	getBaseLine()
IDataProvider	getDataProvider()
int	getErrorBarCapWidth()
org.eclipse.swt.graphics.Color	getErrorBarColor()
java.util.List<ISample>	getHotSampleList() Hot Sample is the sample on the trace which has been drawn in plot area.
int	getLineWidth()
java.lang.String	getName()
int	getPointSize()
Trace.PointStyle	getPointStyle()
IPointStyleProvider	getPointStyleProvider()
org.eclipse.swt.graphics.Color	getTraceColor()
Trace.TraceType	getTraceType()
Axis	getXAxis()
Trace.ErrorBarType	getXErrorBarType()
IXYGraph	getXYGraph()
Axis	getYAxis()
Trace.ErrorBarType	getYErrorBarType()
void	init(Axis xAxis, Axis yAxis, IDataProvider dataProvider) Must be called if using Trace(String)
boolean	isAntiAliasing()
boolean	isDrawYErrorInArea()
boolean	isErrorBarEnabled()
protected void	paintFigure(org.eclipse.draw2d.Graphics graphics)
boolean	removeListener(ITraceListener listener)
void	setAntiAliasing(boolean antiAliasing)
void	setAreaAlpha(int areaAlpha)
void	setBaseLine(Trace.BaseLine baseLine)
void	setDataProvider(IDataProvider traceDataProvider)
void	setDrawYErrorInArea(boolean drawYErrorInArea)
void	setErrorBarCapWidth(int errorBarCapWidth)
void	setErrorBarColor(org.eclipse.swt.graphics.Color errorBarColor)
void	setErrorBarEnabled(boolean errorBarEnabled)
void	setLineWidth(int lineWidth)
void	setName(java.lang.String name)
void	setName(java.lang.String name, boolean fire)
void	setPointSize(int pointSize)
void	setPointStyle(Trace.PointStyle pointStyle)
void	setPointStyleProvider(IPointStyleProvider pointStyleProvider)
void	setTraceColor(org.eclipse.swt.graphics.Color traceColor)
void	setTraceType(Trace.TraceType traceType)
void	setXAxis(Axis axis)
void	setXErrorBarType(Trace.ErrorBarType errorBarType)
void	setXYGraph(IXYGraph xyGraph)
void	setYAxis(Axis axis)
void	setYErrorBarType(Trace.ErrorBarType errorBarType)
java.lang.String	toString()

Methods inherited from class org.eclipse.draw2d.Figure

add, add, add, add, addAncestorListener, addCoordinateListener, addFigureListener, addFocusListener, addKeyListener, addLayoutListener, addListener, addMouseListener, addMouseMotionListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, containsPoint, containsPoint, erase, findDescendantAtExcluding, findFigureAt, findFigureAt, findFigureAt, findFigureAtExcluding, findMouseEventTargetAt, findMouseEventTargetInDescendantsAt, fireCoordinateSystemChanged, fireFigureMoved, fireMoved, firePropertyChange, firePropertyChange, firePropertyChange, getBackgroundColor, getBorder, getBounds, getChildren, getClientArea, getClientArea, getClippingStrategy, getCursor, getFlag, getFont, getForegroundColor, getInsets, getLayoutManager, getListeners, getLocalBackgroundColor, getLocalFont, getLocalForegroundColor, getLocation, getMaximumSize, getMinimumSize, getMinimumSize, getParent, getPreferredSize, getPreferredSize, getSize, getToolTip, getUpdateManager, handleFocusGained, handleFocusLost, handleKeyPressed, handleKeyReleased, handleMouseDoubleClicked, handleMouseDragged, handleMouseEntered, handleMouseExited, handleMouseHover, handleMouseMoved, handleMousePressed, handleMouseReleased, hasFocus, internalGetEventDispatcher, intersects, invalidate, invalidateTree, isCoordinateSystem, isEnabled, isFocusTraversable, isMirrored, isMouseEventTarget, isOpaque, isRequestFocusEnabled, isShowing, isValid, isValidationRoot, isVisible, layout, paint, paintBorder, paintChildren, paintClientArea, primTranslate, remove, removeAll, removeAncestorListener, removeCoordinateListener, removeFigureListener, removeFocusListener, removeKeyListener, removeLayoutListener, removeListener, removeMouseListener, removeMouseMotionListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, revalidate, setBackgroundColor, setBorder, setBounds, setChildrenDirection, setChildrenEnabled, setChildrenOrientation, setClippingStrategy, setConstraint, setCursor, setEnabled, setFlag, setFocusTraversable, setFont, setForegroundColor, setLayoutManager, setLocation, setMaximumSize, setMinimumSize, setOpaque, setParent, setPreferredSize, setPreferredSize, setRequestFocusEnabled, setSize, setSize, setToolTip, setValid, setVisible, translate, translateFromParent, translateToAbsolute, translateToParent, translateToRelative, useLocalCoordinates, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

Trace

public Trace(java.lang.String name)

init(Axis, Axis, IDataProvider) needs to be called if a trace is created with this constructor

Trace

public Trace(java.lang.String name,
             Axis xAxis,
             Axis yAxis,
             IDataProvider dataProvider)

Method Detail

addListener

public void addListener(ITraceListener listener)

removeListener

public boolean removeListener(ITraceListener listener)

setPointStyleProvider

public void setPointStyleProvider(IPointStyleProvider pointStyleProvider)

getPointStyleProvider

public IPointStyleProvider getPointStyleProvider()

init

public void init(Axis xAxis,
                 Axis yAxis,
                 IDataProvider dataProvider)

Must be called if using Trace(String)

Parameters:

xAxis -

yAxis -

dataProvider -

drawPoint

public void drawPoint(org.eclipse.draw2d.Graphics graphics,
                      org.eclipse.draw2d.geometry.Point pos)

Draw point with the pointStyle and size of the trace;

Parameters:

graphics -

pos -

drawLine

public void drawLine(org.eclipse.draw2d.Graphics graphics,
                     org.eclipse.draw2d.geometry.Point p1,
                     org.eclipse.draw2d.geometry.Point p2)

Draw line with the line style and line width of the trace.

Parameters:

graphics -

p1 -

p2 -

paintFigure

protected void paintFigure(org.eclipse.draw2d.Graphics graphics)

Overrides:

paintFigure in class org.eclipse.draw2d.Figure

setXAxis

public void setXAxis(Axis axis)

Parameters:

axis - the xAxis to set

getXAxis

public Axis getXAxis()

Returns:

the xAxis

setYAxis

public void setYAxis(Axis axis)

Parameters:

axis - the yAxis to set

setDataProvider

public void setDataProvider(IDataProvider traceDataProvider)

Parameters:

traceDataProvider - the traceDataProvider to set

getTraceType

public Trace.TraceType getTraceType()

Returns:

the traceType

setTraceColor

public void setTraceColor(org.eclipse.swt.graphics.Color traceColor)

Parameters:

traceColor - Desired trace color

getTraceColor

public org.eclipse.swt.graphics.Color getTraceColor()

Returns:

the traceColor

setTraceType

public void setTraceType(Trace.TraceType traceType)

Parameters:

traceType - the traceType to set

setBaseLine

public void setBaseLine(Trace.BaseLine baseLine)

Parameters:

baseLine - the baseLine to set

setPointStyle

public void setPointStyle(Trace.PointStyle pointStyle)

Parameters:

pointStyle - the pointStyle to set

setLineWidth

public void setLineWidth(int lineWidth)

Parameters:

lineWidth - the lineWidth to set

setPointSize

public void setPointSize(int pointSize)

Parameters:

pointSize - the pointSize to set

setAreaAlpha

public void setAreaAlpha(int areaAlpha)

Parameters:

areaAlpha - the areaAlpha to set

setAntiAliasing

public void setAntiAliasing(boolean antiAliasing)

Parameters:

antiAliasing - the antiAliasing to set

setName

public void setName(java.lang.String name)

Parameters:

name - the name of the trace to set

setName

public void setName(java.lang.String name,
                    boolean fire)

Parameters:

name - the name of the trace to set

fire - if true, a traceNameChanged event is fired

getName

public java.lang.String getName()

Returns:

the name of the trace

getPointSize

public int getPointSize()

Returns:

the pointSize

getAreaAlpha

public int getAreaAlpha()

Returns:

the areaAlpha

getYAxis

public Axis getYAxis()

Returns:

the yAxis

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

dataChanged

public void dataChanged(IDataProvider dataProvider)

Description copied from interface: IDataProviderListener

This method will be notified by data provider whenever the data changed in data provider

Specified by:

dataChanged in interface IDataProviderListener

axisRevalidated

public void axisRevalidated(Axis axis)

Description copied from interface: IAxisListener

This method will be notified by axis whenever the axis is revalidated.

Specified by:

axisRevalidated in interface IAxisListener

axisRangeChanged

public void axisRangeChanged(Axis axis,
                             Range old_range,
                             Range new_range)

Description copied from interface: IAxisListener

This event indicates a change in the axis' value range

Specified by:

axisRangeChanged in interface IAxisListener

getDataProvider

public IDataProvider getDataProvider()

Returns:

the traceDataProvider

setErrorBarEnabled

public void setErrorBarEnabled(boolean errorBarEnabled)

Parameters:

errorBarEnabled - the errorBarEnabled to set

setYErrorBarType

public void setYErrorBarType(Trace.ErrorBarType errorBarType)

Parameters:

errorBarType - the yErrorBarType to set

setXErrorBarType

public void setXErrorBarType(Trace.ErrorBarType errorBarType)

Parameters:

errorBarType - the xErrorBarType to set

setDrawYErrorInArea

public void setDrawYErrorInArea(boolean drawYErrorInArea)

Parameters:

drawYErrorInArea - the drawYErrorArea to set

setErrorBarCapWidth

public void setErrorBarCapWidth(int errorBarCapWidth)

Parameters:

errorBarCapWidth - the errorBarCapWidth to set

setErrorBarColor

public void setErrorBarColor(org.eclipse.swt.graphics.Color errorBarColor)

Parameters:

errorBarColor - Desired color for error bars, or null to use trace color

getHotSampleList

public java.util.List<ISample> getHotSampleList()

Hot Sample is the sample on the trace which has been drawn in plot area.

Returns:

the hotPointList

getBaseLine

public Trace.BaseLine getBaseLine()

Returns:

the baseLine

getPointStyle

public Trace.PointStyle getPointStyle()

Returns:

the pointStyle

getLineWidth

public int getLineWidth()

Returns:

the lineWidth

isAntiAliasing

public boolean isAntiAliasing()

Returns:

the antiAliasing

isErrorBarEnabled

public boolean isErrorBarEnabled()

Returns:

the errorBarEnabled

getYErrorBarType

public Trace.ErrorBarType getYErrorBarType()

Returns:

the yErrorBarType

getXErrorBarType

public Trace.ErrorBarType getXErrorBarType()

Returns:

the xErrorBarType

getErrorBarCapWidth

public int getErrorBarCapWidth()

Returns:

the errorBarCapWidth

getErrorBarColor

public org.eclipse.swt.graphics.Color getErrorBarColor()

Returns:

Color used for error bars or 'area'

isDrawYErrorInArea

public boolean isDrawYErrorInArea()

Returns:

the drawYErrorInArea

setXYGraph

public void setXYGraph(IXYGraph xyGraph)

Parameters:

xyGraph - the xyGraph to set

getXYGraph

public IXYGraph getXYGraph()

Returns:

the xyGraph

axisForegroundColorChanged

public void axisForegroundColorChanged(Axis axis,
                                       org.eclipse.swt.graphics.Color oldColor,
                                       org.eclipse.swt.graphics.Color newColor)

Specified by:

axisForegroundColorChanged in interface IAxisListener

axisTitleChanged

public void axisTitleChanged(Axis axis,
                             java.lang.String oldTitle,
                             java.lang.String newTitle)

Specified by:

axisTitleChanged in interface IAxisListener

axisAutoScaleChanged

public void axisAutoScaleChanged(Axis axis,
                                 boolean oldAutoScale,
                                 boolean newAutoScale)

Specified by:

axisAutoScaleChanged in interface IAxisListener

axisLogScaleChanged

public void axisLogScaleChanged(Axis axis,
                                boolean old,
                                boolean logScale)

Specified by:

axisLogScaleChanged in interface IAxisListener

dispose

public void dispose()

Remove figures and reset fields