org.eclipse.eavp.viz.service.widgets

Class PlotComposite

java.lang.Object

org.eclipse.swt.widgets.Widget

org.eclipse.swt.widgets.Control

org.eclipse.swt.widgets.Scrollable

org.eclipse.swt.widgets.Composite

org.eclipse.eavp.viz.service.widgets.PlotComposite

All Implemented Interfaces:

org.eclipse.swt.graphics.Drawable

Direct Known Subclasses:

ConnectionPlotComposite, CSVPlotComposite

public abstract class PlotComposite
extends org.eclipse.swt.widgets.Composite

This is a base class for creating customized renderings of IPlots.

Certain methods are suggested for sub-classes to override, in particular the following methods:

1. createPlotContent(Composite, int) - fill the composite with customized content
2. updatePlotContent(Composite) - refresh the customized content
3. disposePlotContent(Composite) - clear the customized content
4. showSeries(ISeries) - add the selected series to the custom content
5. hideSeries(ISeries) - remove the series from the custom content

The life-cycle of these method calls can be found in performRefresh(), and each method may be called multiple times.

Additional room for customization includes a context (right-click) menu that can be added to nested composites via addContextMenu(Composite). The context menu's content can be updated or replaced by overriding getPlotActions().

Another simple customization includes the ability to prohibit multiple series from being selected by overriding canShowMultipleSeries().

Author:

Jordan

Field Summary

Fields inherited from class org.eclipse.swt.widgets.Control

view

Constructor Summary

Constructors

Constructor and Description
PlotComposite(org.eclipse.swt.widgets.Composite parent, int style) The default constructor.

Method Summary

Modifier and Type	Method and Description
void	refresh() Refreshes the composite based on the plot's current content.
boolean	setPlot(IPlot plot) Sets the current plot associated with this plot composite.

Methods inherited from class org.eclipse.swt.widgets.Composite

changed, computeSize, drawBackground, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList

Methods inherited from class org.eclipse.swt.widgets.Scrollable

computeTrim, getClientArea, getHorizontalBar, getScrollbarsMode, getVerticalBar

Methods inherited from class org.eclipse.swt.widgets.Control

addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTouchListener, addTraverseListener, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBorderWidth, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getRegion, getShell, getSize, getTextDirection, getToolTipText, getTouchEnabled, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTouchListener, removeTraverseListener, requestLayout, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRedraw, setRegion, setSize, setSize, setTextDirection, setToolTipText, setTouchEnabled, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, traverse, traverse, update

Methods inherited from class org.eclipse.swt.widgets.Widget

addDisposeListener, addListener, dispose, getData, getData, getDisplay, getListeners, getStyle, isAutoDirection, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, reskin, setData, setData, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PlotComposite

public PlotComposite(org.eclipse.swt.widgets.Composite parent,
                     int style)

The default constructor.

Parameters:

parent - a widget which will be the parent of the new instance (cannot be null)

style - the style of widget to construct

Method Detail

refresh

public void refresh()

Refreshes the composite based on the plot's current content.

This method is safe to call from off the UI thread.

setPlot

public boolean setPlot(IPlot plot)

Sets the current plot associated with this plot composite.

Note: This method will not refresh the composite automatically. If the plot changes, the calling code should call refresh() afterward.

Parameters:

plot - The new plot shown in this composite, or null to clear it.

Returns:

True if the plot changed, false otherwise.