Package gda.rcp.views

Class ScannableFieldsComposite

java.lang.Object
org.eclipse.swt.widgets.Widget
org.eclipse.swt.widgets.Control
org.eclipse.swt.widgets.Scrollable
org.eclipse.swt.widgets.Composite
gda.rcp.views.AbstractPositionerComposite
gda.rcp.views.ScannableFieldsComposite
All Implemented Interfaces:
org.eclipse.swt.graphics.Drawable
public class ScannableFieldsComposite extends AbstractPositionerComposite
A GUI composite to display values of input and extra names of a scannable. These are displayed as name (Label), value (text box), and unit (Label) if unit is available in a RowLayout.

Only input fields are editable to provide scannable control when it is not busy. Change to any one of the input fields will trigger a motion in the scannable on pressing return key immediately, so you can only do one field change at any one time.

Since:
9.16

  • Field Summary

    Fields inherited from class gda.rcp.views.AbstractPositionerComposite

    checkHoldingBaton, displayNameLabel, reasonForDisallowingMove, unitDisplayOutsideTextBox

    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
    ScannableFieldsComposite(org.eclipse.swt.widgets.Composite parent, int style)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    createPositionerControl()
    Creates the control(s) (drawn between the label and the stop button) to display and/or control the scannable's position.
    void
    setScannable(Scannable scannable)
    This sets the scannable which will be controlled and will automatically configure the control.
    void
    setUserUnits(Map<String,String> userUnits2)
     
    protected void
    updatePositionerControl(Object newPosition, boolean moving)
    Updates the control(s) created at AbstractPositionerComposite.createPositionerControl() to reflect the given scannable position and whether it is currently moving.

    Methods inherited from class gda.rcp.views.AbstractPositionerComposite

    checkBatonHeld, dispose, getCurrentPosition, getDisplayName, getScannable, getScannableOutputFormat, hideStopButton, isCheckHoldingBaton, isStopButtonVisible, move, moveAllowed, scheduleUpdateReadbackJob, setCheckHoldingBaton, setDisplayName, setDisplayNameWidth, setEnabled, setReasonForDisallowingMove, showStopButton

    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, 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

  • Constructor Details

    • ScannableFieldsComposite

      public ScannableFieldsComposite(org.eclipse.swt.widgets.Composite parent, int style)
      Parameters:
      parent - the parent composite on which to draw this one
      style - SWT.HORIZONTAL or SWT.VERTICAL will define a horizontal or vertical (default) layout

  • Method Details