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

All Implemented Interfaces:

org.eclipse.draw2d.IFigure

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.

Nested Class Summary

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

lineStyle, lineWidth

Fields inherited from class org.eclipse.draw2d.Figure

bgColor, border, bounds, fgColor, flags, 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
Legend(IXYGraph xyGraph) Construct a legend

Method Summary

Modifier and Type	Method and Description
void	addTrace(Trace trace) Add a trace to the axis.
protected void	fillShape(org.eclipse.draw2d.Graphics graphics)
org.eclipse.swt.graphics.Font	getFont()
int	getPreferredHeight()
org.eclipse.draw2d.geometry.Dimension	getPreferredSize(int wHint, int hHint)
java.util.List<Trace>	getTraceList()
boolean	isDrawBorder()
protected void	outlineShape(org.eclipse.draw2d.Graphics graphics)
boolean	removeTrace(Trace trace) Remove a trace from the axis.
void	setDrawBorder(boolean displayDrawBorderAround)
void	setPreferredHeight(int preferredHeight)
void	setTextFont(org.eclipse.swt.graphics.Font textFont)

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

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, getForegroundColor, getInsets, getLayoutManager, getListeners, getLocalBackgroundColor, getLocalFont, 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, 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, toString, wait, wait, wait

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

outlineShape

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

Overrides:

outlineShape in class org.eclipse.draw2d.RectangleFigure

fillShape

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

Overrides:

fillShape in class org.eclipse.draw2d.RectangleFigure

getPreferredSize

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

Specified by:

getPreferredSize in interface org.eclipse.draw2d.IFigure

Overrides:

getPreferredSize in class org.eclipse.draw2d.Figure

getTraceList

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

Returns:

the traceList

isDrawBorder

public boolean isDrawBorder()

Returns:

true if a border is displayed around the legend

setDrawBorder

public void setDrawBorder(boolean displayDrawBorderAround)

Parameters:

displayDrawBorderAround - if true a border is displayed around the legend

getPreferredHeight

public int getPreferredHeight()

Returns:

the preferred height of this legend. If this value is -1, the height will be computed with the elements

setPreferredHeight

public void setPreferredHeight(int preferredHeight)

Parameters:

preferredHeight - the preferred height of this legend. If this value is -1, the height will be computed with default values

getFont

public org.eclipse.swt.graphics.Font getFont()

Specified by:

getFont in interface org.eclipse.draw2d.IFigure

Overrides:

getFont in class org.eclipse.draw2d.Figure

Returns:

the initialised text font

setTextFont

public void setTextFont(org.eclipse.swt.graphics.Font textFont)

Parameters:

textFont - new font used for the text