Class ImageWidget
- java.lang.Object
-
- org.csstudio.display.builder.model.Widget
-
- org.csstudio.display.builder.model.widgets.VisibleWidget
-
- org.csstudio.display.builder.model.widgets.PVWidget
-
- org.csstudio.display.builder.model.widgets.plots.ImageWidget
-
public class ImageWidget extends PVWidget
Widget that displays an image
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ImageWidget.AxisWidgetProperty
Structure for X and Y axesstatic class
ImageWidget.ColorBarProperty
Structure for color bar, the 'legend' that shows the color barstatic class
ImageWidget.ROIWidgetProperty
-
Field Summary
Fields Modifier and Type Field Description static org.csstudio.display.builder.model.WidgetPropertyDescriptor<java.lang.Double>
propHeightValue
static org.csstudio.display.builder.model.ArrayWidgetProperty.Descriptor<ImageWidget.ROIWidgetProperty>
propROIs
'roi' arraystatic org.csstudio.display.builder.model.WidgetPropertyDescriptor<java.lang.Double>
propWidthValue
static org.csstudio.display.builder.model.WidgetPropertyDescriptor<java.lang.Double>
propXValue
static org.csstudio.display.builder.model.WidgetPropertyDescriptor<java.lang.Double>
propYValue
static org.csstudio.display.builder.model.WidgetDescriptor
WIDGET_DESCRIPTOR
Widget descriptor-
Fields inherited from class org.csstudio.display.builder.model.widgets.PVWidget
RUNTIME_VALUE_NO_PV
-
Fields inherited from class org.csstudio.display.builder.model.Widget
BASE_WIDGET_VERSION, USER_DATA_REPRESENTATION, USER_DATA_RUNTIME, USER_DATA_SCRIPT_SUPPORT, USER_DATA_TOOLKIT_PARENT
-
-
Constructor Summary
Constructors Constructor Description ImageWidget()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description org.csstudio.display.builder.model.WidgetConfigurator
getConfigurator(org.csstudio.display.builder.model.Version persisted_version)
Obtain configurator.WidgetProperty<?>
getProperty(java.lang.String name)
Get widget property.WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor>
propBackground()
ImageWidget.ColorBarProperty
propColorbar()
WidgetProperty<java.lang.Boolean>
propCursorCrosshair()
WidgetProperty<java.lang.String>
propCursorInfoPV()
WidgetProperty<java.lang.String>
propCursorXPV()
WidgetProperty<java.lang.String>
propCursorYPV()
WidgetProperty<java.lang.Boolean>
propDataAutoscale()
WidgetProperty<org.csstudio.display.builder.model.properties.ColorMap>
propDataColormap()
WidgetProperty<org.epics.vtype.VImageType>
propDataColorMode()
WidgetProperty<java.lang.Integer>
propDataHeight()
WidgetProperty<org.csstudio.display.builder.model.widgets.plots.InterpolationType>
propDataInterpolation()
WidgetProperty<java.lang.Boolean>
propDataLogscale()
WidgetProperty<java.lang.Double>
propDataMaximum()
WidgetProperty<java.lang.Double>
propDataMinimum()
WidgetProperty<java.lang.Boolean>
propDataUnsigned()
WidgetProperty<java.lang.Integer>
propDataWidth()
WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor>
propForegroundColor()
org.csstudio.display.builder.model.ArrayWidgetProperty<ImageWidget.ROIWidgetProperty>
propROIs()
WidgetProperty<java.lang.Boolean>
propToolbar()
ImageWidget.AxisWidgetProperty
propXAxis()
ImageWidget.AxisWidgetProperty
propYAxis()
org.csstudio.display.builder.model.properties.RuntimeEventProperty
runtimePropConfigure()
WidgetProperty<java.lang.Double[]>
runtimePropCrosshair()
WidgetProperty<org.epics.vtype.VType>
runtimePropCursorInfo()
-
Methods inherited from class org.csstudio.display.builder.model.widgets.PVWidget
propBorderAlarmSensitive, propPVName, runtimePropValue
-
Methods inherited from class org.csstudio.display.builder.model.widgets.VisibleWidget
propTooltip, propVisible, runtimePropConnected
-
Methods inherited from class org.csstudio.display.builder.model.Widget
checkDisplayModel, checkProperty, checkProperty, clearUserData, expandPropertyNames, getDisplayModel, getEffectiveMacros, getID, getMacrosOrProperties, getName, getParent, getProperties, getProperty, getPropertyByPath, getPropertyValue, getPropertyValue, getTopDisplayModel, getType, getUserData, getVersion, getWidgetClass, isClean, propActions, propClass, propHeight, propName, propRules, propScripts, propWidth, propX, propY, setConfiguratorResult, setPropertyValue, setPropertyValue, setUserData, toString
-
-
-
-
Field Detail
-
WIDGET_DESCRIPTOR
public static final org.csstudio.display.builder.model.WidgetDescriptor WIDGET_DESCRIPTOR
Widget descriptor
-
propXValue
public static final org.csstudio.display.builder.model.WidgetPropertyDescriptor<java.lang.Double> propXValue
-
propYValue
public static final org.csstudio.display.builder.model.WidgetPropertyDescriptor<java.lang.Double> propYValue
-
propWidthValue
public static final org.csstudio.display.builder.model.WidgetPropertyDescriptor<java.lang.Double> propWidthValue
-
propHeightValue
public static final org.csstudio.display.builder.model.WidgetPropertyDescriptor<java.lang.Double> propHeightValue
-
propROIs
public static final org.csstudio.display.builder.model.ArrayWidgetProperty.Descriptor<ImageWidget.ROIWidgetProperty> propROIs
'roi' array
-
-
Method Detail
-
getProperty
public WidgetProperty<?> getProperty(java.lang.String name)
Description copied from class:Widget
Get widget property.Meant for rules, scripts and similar code which does not know the exact widget type and thus fetches properties by name.
Supports access to complex properties by path name, for example "y_axes[1].minimum" to get the minimum property of the second Y axis of a plot.
To allow use of legacy scripts and rules, the widget implementation may override to handle deprecated property names.
Caller presumes that the widget actually has the requested property, otherwise throwing Exception.
- Overrides:
getProperty
in classWidget
- Parameters:
name
- Property name- Returns:
WidgetProperty
- See Also:
Widget.checkProperty(String)
-
getConfigurator
public org.csstudio.display.builder.model.WidgetConfigurator getConfigurator(org.csstudio.display.builder.model.Version persisted_version) throws java.lang.Exception
Description copied from class:Widget
Obtain configurator.While typically using the default
WidgetConfigurator
, widget may provide a different configurator for reading older persisted date.- Overrides:
getConfigurator
in classWidget
- Parameters:
persisted_version
- Version of the persisted data.- Returns:
- Widget configurator for that version
- Throws:
java.lang.Exception
- if persisted version cannot be handled
-
propBackground
public WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor> propBackground()
- Returns:
- 'background_color' property
-
propForegroundColor
public WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor> propForegroundColor()
- Returns:
- 'foreground_color' property
-
propToolbar
public WidgetProperty<java.lang.Boolean> propToolbar()
- Returns:
- 'show_toolbar' property
-
propDataColormap
public WidgetProperty<org.csstudio.display.builder.model.properties.ColorMap> propDataColormap()
- Returns:
- 'color_map' property
-
propColorbar
public ImageWidget.ColorBarProperty propColorbar()
- Returns:
- 'color_bar' property
-
propXAxis
public ImageWidget.AxisWidgetProperty propXAxis()
- Returns:
- 'x_axis' property
-
propYAxis
public ImageWidget.AxisWidgetProperty propYAxis()
- Returns:
- 'y_axis' property
-
propDataWidth
public WidgetProperty<java.lang.Integer> propDataWidth()
- Returns:
- 'data_width' property
-
propDataHeight
public WidgetProperty<java.lang.Integer> propDataHeight()
- Returns:
- 'data_height' property
-
propDataInterpolation
public WidgetProperty<org.csstudio.display.builder.model.widgets.plots.InterpolationType> propDataInterpolation()
- Returns:
- 'interpolation' property
-
propDataColorMode
public WidgetProperty<org.epics.vtype.VImageType> propDataColorMode()
- Returns:
- 'color_mode' property
-
propDataUnsigned
public WidgetProperty<java.lang.Boolean> propDataUnsigned()
- Returns:
- 'unsigned' property
-
propDataAutoscale
public WidgetProperty<java.lang.Boolean> propDataAutoscale()
- Returns:
- 'autoscale' property
-
propDataLogscale
public WidgetProperty<java.lang.Boolean> propDataLogscale()
- Returns:
- 'logscale' property
-
propDataMinimum
public WidgetProperty<java.lang.Double> propDataMinimum()
- Returns:
- 'minimum' property
-
propDataMaximum
public WidgetProperty<java.lang.Double> propDataMaximum()
- Returns:
- 'maximum' property
-
propCursorInfoPV
public WidgetProperty<java.lang.String> propCursorInfoPV()
- Returns:
- 'cursor_info_pv' property
-
propCursorXPV
public WidgetProperty<java.lang.String> propCursorXPV()
- Returns:
- 'x_pv' property
-
propCursorYPV
public WidgetProperty<java.lang.String> propCursorYPV()
- Returns:
- 'y_pv' property
-
runtimePropCursorInfo
public WidgetProperty<org.epics.vtype.VType> runtimePropCursorInfo()
- Returns:
- Runtime 'cursor_info' property
-
propCursorCrosshair
public WidgetProperty<java.lang.Boolean> propCursorCrosshair()
- Returns:
- 'cursor_crosshair' property
-
runtimePropCrosshair
public WidgetProperty<java.lang.Double[]> runtimePropCrosshair()
- Returns:
- Runtime property for location of cursor crosshair, holds Double[] { x, y }
-
propROIs
public org.csstudio.display.builder.model.ArrayWidgetProperty<ImageWidget.ROIWidgetProperty> propROIs()
- Returns:
- 'rois' property
-
runtimePropConfigure
public org.csstudio.display.builder.model.properties.RuntimeEventProperty runtimePropConfigure()
- Returns:
- 'configure' property
-
-