Package org.eclipse.nebula.visualization.xygraph.figures

Class Legend

java.lang.Object

org.eclipse.draw2d.Figure

org.eclipse.draw2d.Shape

org.eclipse.draw2d.RectangleFigure

org.eclipse.nebula.visualization.xygraph.figures.Legend

public class Legend
extends org.eclipse.draw2d.RectangleFigure

The legend to indicate the style and size of the trace line and point. The border color of the legend is same as the traces' Y-Axis color.

Author:

Xihui Chen

Nested Class Summary

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

org.eclipse.draw2d.Figure.FigureIterator

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

org.eclipse.draw2d.IFigure.NoInsets

Field Summary

Fields inherited from interface org.eclipse.draw2d.IFigure

MAX_DIMENSION, MIN_DIMENSION, NO_INSETS

Constructor Summary

Constructors

Constructor	Description
Legend(IXYGraph xyGraph)	Construct a legend

Method Summary

Modifier and Type	Method	Description
void	addTrace(Trace trace)	Add a trace to the axis.
org.eclipse.draw2d.geometry.Dimension	getPreferredSize(int wHint, int hHint)
java.util.List<Trace>	getTraceList()
boolean	removeTrace(Trace trace)	Remove a trace from the axis.

Methods inherited from class org.eclipse.draw2d.Figure

add, add, add, add, addAncestorListener, addCoordinateListener, addFigureListener, addFocusListener, addKeyListener, addLayoutListener, addMouseListener, addMouseMotionListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, containsPoint, containsPoint, erase, findFigureAt, findFigureAt, findFigureAt, findFigureAtExcluding, findMouseEventTargetAt, getBackgroundColor, getBorder, getBounds, getChildren, getClientArea, getClientArea, getClippingStrategy, getCursor, getFont, getForegroundColor, getInsets, getLayoutManager, getLocalBackgroundColor, getLocalForegroundColor, getLocation, getMaximumSize, getMinimumSize, getMinimumSize, getParent, 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, isOpaque, isRequestFocusEnabled, isShowing, isVisible, paint, remove, removeAll, removeAncestorListener, removeCoordinateListener, removeFigureListener, removeFocusListener, removeKeyListener, removeLayoutListener, removeMouseListener, removeMouseMotionListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, revalidate, setBackgroundColor, setBorder, setBounds, setClippingStrategy, setConstraint, setCursor, setEnabled, setFocusTraversable, setFont, setForegroundColor, setLayoutManager, setLocation, setMaximumSize, setMinimumSize, setOpaque, setParent, setPreferredSize, setPreferredSize, setRequestFocusEnabled, setSize, setSize, setToolTip, setValid, setVisible, translate, translateFromParent, translateToAbsolute, translateToParent, translateToRelative, validate

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class org.eclipse.draw2d.Shape

getAlpha, getAntialias, getLineAttributes, getLineCap, getLineDash, getLineDashOffset, getLineJoin, getLineMiterLimit, getLineStyle, getLineWidth, getLineWidthFloat, paintFigure, setAlpha, setAlpha, setAntialias, setAntialias, setFill, setFillXOR, setLineAttributes, setLineCap, setLineDash, setLineDashOffset, setLineJoin, setLineMiterLimit, setLineStyle, setLineWidth, setLineWidthFloat, setOutline, setOutlineXOR, setXOR

Constructor Detail

Legend

public Legend(IXYGraph xyGraph)

Construct a legend

Parameters:

xyGraph - the graph for which the legend is created

Method Detail

addTrace

public void addTrace(Trace trace)

Add a trace to the axis.

Parameters:

trace - the trace to be added.

removeTrace

public boolean removeTrace(Trace trace)

Remove a trace from the axis.

Parameters:

trace -

Returns:

true if this axis contained the specified trace

getPreferredSize

public org.eclipse.draw2d.geometry.Dimension getPreferredSize(int wHint,
                                                              int hHint)

Overrides:

getPreferredSize in class org.eclipse.draw2d.Figure

getTraceList

public java.util.List<Trace> getTraceList()

Returns:

the traceList