IScanUIElement

All Superinterfaces:: INameable

All Known Implementing Classes:: DetectorScanUIElement, MonitorScanUIElement, ScanUIElement

public interface IScanUIElement extends INameable

Represents an UI element with an enablement, a name and an icon path.

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.

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

Method Details
- getIconPath
  
  String getIconPath()
  
  Get the icon path of the scan element.
  
  Returns:
  
  icon path
- isEnabled
  
  boolean isEnabled()
  
  Get whether the scan element is enabled, i.e. will be included in the next scan
  
  Returns:
  
  true if the element will be included in the next scan
- setEnabled
  
  void setEnabled(boolean enabled)
  
  Set the enablement of the scan element.
  
  Parameters:
  
  enabled - true to enable the element, false to disable it