A ScreenElement object describes the properties of one UI widget contained in a ScreenDefinition. This comprises the type of widget, its location and size and many more parameters which depend on the type of widget this ScreenElement defines. This way ScreenElement is kind of an abstract definition or 'base class' in terms of object oriented programming. ScreenElement defines the parameters which are common to all types of screen elements.
Data Model
| Key | Type | Value |
|---|---|---|
| type | String | The type of the screen element. See the list of screen element types below for details. |
| xpos | Number | X-position of the upper left corner of the element in the screen (pixels in the Java client) |
| ypos | Number | Y-position of the upper left corner of the element in the screen (pixels in the Java client) |
| width | Number | Width of the element (pixels in the Java client) |
| height | Number | Height of the element (pixels in the Java client) |
As mentioned above, a ScreenDefinition will never contain a ScreenElement with only the parameters shown in the table above. All ScreenElement objects will be of a certain screen element type and will contain all parameters defines for this element type. The parameters described for ScreenElement will be always included.
List of screen element types:
| Element Type | Description |
|---|---|
| ArrowElement | Draws a horizontal/vertical line or arrow. |
| AzElElement | A chart showing the tracking history of an antenna controller as a point cloud in an elevation over azimuth coordinate system. |
| ButtonElement | Defines a button which launches another screen, e.g. for detail views. |
| ChartElement | A strip chart element, displaying a numeric parameter as an y/t diagram that automatically advances with 1 pixel / second. |
| DeviceElement | Places an icon into the screen which represents a device. This icon will display the device's operating/fault state by it's color / shape. |
| DisplayElement | A parameter display field which does not allow the parameter to be edited. |
| EditButtonElement | Places an EDIT button into the screen, implicitly forcing the EDIT/TAKE operating method for this screen instead of changing each parameter independently. |
| FaultElement | A special display element to display a fault flag. It shows the textual description of the fault and it's state in an entry field frame. The right mouse button shows a context menu to change the fault's priority |
| FrameElement | Draws a sunken 3D frame, may be used to group parameters. |
| GaugeElement | A gauge element, displaying a numeric parameter as a horizontal bar. |
| IconElement | Places an icon (PNG, GIF or JPG image) into the screen. Optionally the icon can be programmed to change with a parameter value. |
| LatchingButtonElement | A button which displays/controls a 2-state parameter using it's pressed state. |
| LockButtonElement | A button to control the lock state for exclusive operation for a number of devices. |
| MCPElement | The MCP display element integrates the measurement display of a spectrum analyzer device in multi channel measurement mode in a user screen. |
| ParameterButtonElement | A button which sends a certain parameter value when pressed. |
| ParameterElement | Either a parameter entry field or a drop down box, depending on the type of parameter. |
| RadioButtonElement | A parameter entry field specially for CHOICE parameters. |
| RectElement | Draws a rectangle. |
| SpectrumElement | The spectrum display element integrates the spectrum display of a spectrum analyzer device in a user screen. |
| SwitchElement | Like the device icon, but additionally displays the actual position of a switch (Meant to be used for block diagrams showing the true signal path. |
| TakeButtonElement | Places a TAKE button into the screen. |
| TargetListElement | The ODM Target List element shows the list of targets of a SatService-ACU-ODM antenna controller device. It permits to recall, save or delete target definitions of this type of antenna controller. It is specialized to this antenna controller, does not support other types. |
| TextElement | Displays a single line of text. |
| ThumbnailElement | Displays a thumbnail image fetched directly from a video processing device (encoder, decoder, gateway) |
| XYChartElement | This element shows the relation of two numeric variables in an X/Y diagram, featuring a trace which shows the recent history of the values with a configurable depth. The update rate, the diagram scaling and much more is configurable with this screen element. |