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

Interface LiveStreamViewCustomUi

All Known Implementing Classes:
AbstractLiveStreamViewCustomUi, CustomCameraLiveControls, EdeDetectorCustomUI, EpicsNDArrayStreamView, ExampleCustomUi, LiveStreamViewAxisCameraControls, LiveStreamViewCameraControls, LiveStreamViewCameraControlsScanListener, LiveStreamViewLightHistogramControl, LiveStreamViewRoiControls, LiveStreamViewStartStopStream, LiveStreamWithHistogramBottomUI, LiveStreamWithHistogramTopUI, SisaLiveStreamCustomUi
public interface LiveStreamViewCustomUi

This interface allows you to define a custom UI class for use with an LiveStreamView.

Instead of implementing this directly it is recommended to extend AbstractLiveStreamViewCustomUi

Since:
GDA 9.11

  • Method Details

    • createUi

      void createUi(org.eclipse.swt.widgets.Composite composite)
      Called when the LiveStreamView is drawing this custom UI. At this point the IPlottingSystem and LiveStreamConnection will be setup so then can be used in this method.
      Parameters:
      composite - The composite to draw custom UI onto.

    • dispose

      void dispose()
      Called when the composite is being disposed to allow listeners to be removed, resources disposed etc.

    • setPlottingSystem

      void setPlottingSystem(IPlottingSystem<org.eclipse.swt.widgets.Composite> plottingSystem)
      Called by LiveStreamView when creating the custom UI to inject the IPlottingSystem
      Parameters:
      plottingSystem - the plotting system displaying the live stream.

    • setLiveStreamConnection

      void setLiveStreamConnection(LiveStreamConnection liveStreamConnection)
      Called by LiveStreamView when creating the custom UI to inject LiveStreamConnection
      Parameters:
      liveStreamConnection - the connection to the live stream displayed.

    • setImageTrace

      void setImageTrace(IImageTrace iTrace)
      Called by LiveStreamView when creating the custom UI to inject the IImageTrace
      Parameters:
      iTrace - trace of the live stream displayed.

    • setActionBars

      void setActionBars(org.eclipse.ui.IActionBars actionBars)
      Called by LiveStreamView when creating the custom UI to inject the IActionBars
      Parameters:
      actionBars - toolbar of the LiveStreamView