Package uk.ac.gda.client.live.stream.view

Class LivePlottingComposite

java.lang.Object

org.eclipse.swt.widgets.Widget

org.eclipse.swt.widgets.Control

org.eclipse.swt.widgets.Scrollable

org.eclipse.swt.widgets.Composite

uk.ac.gda.client.live.stream.view.LivePlottingComposite

All Implemented Interfaces:

org.eclipse.swt.graphics.Drawable

public class LivePlottingComposite
extends org.eclipse.swt.widgets.Composite

Manages an IPlottingSystem to display a live stream from a camera Publishes PlottingSystemUpdateEvent when starts listening at the inner stream

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LIVE_CAMERA_STREAM

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

embeddedHandle

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

handle

Constructor Summary

Constructors

Constructor	Description
LivePlottingComposite(org.eclipse.swt.widgets.Composite parent, int style, String plotName, org.eclipse.ui.IActionBars actionBars, org.eclipse.ui.IWorkbenchPart part)	Create LivePlottingComposite
LivePlottingComposite(org.eclipse.swt.widgets.Composite parent, int style, String plotName, org.eclipse.ui.IActionBars actionBars, LiveStreamConnection liveStreamConnection, org.eclipse.ui.IWorkbenchPart workbenchPart)
LivePlottingComposite(org.eclipse.swt.widgets.Composite parent, int style, String plotName, LiveStreamConnection liveStreamConnection)	Simple constructor for use in wizard pages etc.

Method Summary

Modifier and Type	Method	Description
void	activatePlottingSystem()	Connect trace to plotting system.
void	disconnect()
void	dispose()
IImageTrace	getITrace()
IPlottingSystem<org.eclipse.swt.widgets.Composite>	getPlottingSystem()
boolean	isShowAxes()
boolean	isShowTitle()	See comment on setShowTitle(boolean)
void	removeCrosshairs()
void	setCrosshairs(double xPos, double yPos)
void	setShowAxes(boolean showAxes)
void	setShowTitle(boolean showTitle)	TODO: Consider whether we should remove this function and specify in the constructor whether the title should be shown. There is probably no reason to allow the title to be added or removed after the view is shown.

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

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

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, 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, isAutoScalable, 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, checkWidget, getData, getData, getDisplay, getListeners, getStyle, isAutoDirection, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, reskin, setData, setData

Methods inherited from class java.lang.Object

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

Field Details

LIVE_CAMERA_STREAM

public static final String LIVE_CAMERA_STREAM

See Also:

• Constant Field Values

Constructor Details

LivePlottingComposite

public LivePlottingComposite(org.eclipse.swt.widgets.Composite parent,
 int style,
 String plotName,
 LiveStreamConnection liveStreamConnection)
                      throws GDAClientException

Simple constructor for use in wizard pages etc. where there are no action bars or workspace part

For a description of parameters, see LivePlottingComposite(Composite parent, int style, String plotName, IActionBars actionBars, IWorkbenchPart part)

Throws:

GDAClientException

LivePlottingComposite

public LivePlottingComposite(org.eclipse.swt.widgets.Composite parent,
 int style,
 String plotName,
 org.eclipse.ui.IActionBars actionBars,
 LiveStreamConnection liveStreamConnection,
 org.eclipse.ui.IWorkbenchPart workbenchPart)
                      throws GDAClientException

Throws:

GDAClientException

LivePlottingComposite

public LivePlottingComposite(org.eclipse.swt.widgets.Composite parent,
 int style,
 String plotName,
 org.eclipse.ui.IActionBars actionBars,
 org.eclipse.ui.IWorkbenchPart part)
                      throws GDAClientException

Create LivePlottingComposite

Parameters:

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

style - style the style of widget to construct

plotName - name of plot (passed to plotting system

actionBars - of the parent: can be null (e.g. if the parent is not a ViewPart)

part - parent ViewPart: can be null (e.g. if the parent is not a ViewPart)

Throws:

GDAClientException - when cannot comunicate with SpringApplicationContextProxy or when cannot prepare IPlottingSystem

Method Details

activatePlottingSystem

public void activatePlottingSystem()
                            throws LiveStreamException

Connect trace to plotting system.

Throws:

LiveStreamException

setCrosshairs

public void setCrosshairs(double xPos,
 double yPos)
                   throws Exception

Throws:

Exception

removeCrosshairs

public void removeCrosshairs()

disconnect

public void disconnect()

dispose

public void dispose()

Overrides:

dispose in class org.eclipse.swt.widgets.Widget

getITrace

public IImageTrace getITrace()

getPlottingSystem

public IPlottingSystem<org.eclipse.swt.widgets.Composite> getPlottingSystem()

isShowAxes

public boolean isShowAxes()

setShowAxes

public void setShowAxes(boolean showAxes)

isShowTitle

public boolean isShowTitle()

See comment on setShowTitle(boolean)

Returns:

true if title is shown, false if it is not shown

setShowTitle

public void setShowTitle(boolean showTitle)

TODO: Consider whether we should remove this function and specify in the constructor whether the title should be shown.
There is probably no reason to allow the title to be added or removed after the view is shown.

Parameters:

showTitle - true to show the title, false to hide it