ScanUIElement

java.lang.Object

org.eclipse.scanning.api.AbstractNameable

org.eclipse.scanning.api.scan.ui.ScanUIElement

All Implemented Interfaces:: INameable, IScanUIElement

Direct Known Subclasses:: DetectorScanUIElement, MonitorScanUIElement

public class ScanUIElement extends AbstractNameable implements IScanUIElement

A default implemementation of IScanUIElement, an element in the scan ui.

Constructor Summary

Constructors

Constructor

Description

ScanUIElement()

ScanUIElement(String name, String iconPath)
Method Summary

Modifier and Type

Method

Description

String

getIconPath()

Get the icon path of the scan element.

boolean

isEnabled()

Get whether the scan element is enabled, i.e.

void

setEnabled(boolean enabled)

Set the enablement of the scan element.

void

setIconPath(String iconPath)

String

toString()

Methods inherited from class org.eclipse.scanning.api.AbstractNameable
equals, getName, hashCode, setName

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.scanning.api.INameable
getName, setName

Constructor Details
- ScanUIElement
  
  public ScanUIElement()
- ScanUIElement
  
  public ScanUIElement(String name, String iconPath)
Method Details
- getIconPath
  
  public String getIconPath()
  
  Description copied from interface: IScanUIElement
  
  Get the icon path of the scan element.
  
  Specified by:
  
  getIconPath in interface IScanUIElement
  
  Returns:
  
  icon path
- setIconPath
  
  public void setIconPath(String iconPath)
- isEnabled
  
  public boolean isEnabled()
  
  Description copied from interface: IScanUIElement
  
  Get whether the scan element is enabled, i.e. will be included in the next scan
  
  Specified by:
  
  isEnabled in interface IScanUIElement
  
  Returns:
  
  true if the element will be included in the next scan
- setEnabled
  
  public void setEnabled(boolean enabled)
  
  Description copied from interface: IScanUIElement
  
  Set the enablement of the scan element.
  
  Specified by:
  
  setEnabled in interface IScanUIElement
  
  Parameters:
  
  enabled - true to enable the element, false to disable it
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class AbstractNameable