The ButtonElement creates a button which launches another user interface screen if pressed. The screen to be launched may be another user defined screen or a predefined one.
Data Model (extends ScreenElement)
| Key | Type | Value |
|---|---|---|
| type | String | Always "ParameterButtonElement". |
| xpos | Number | see ScreenElement |
| ypos | Number | see ScreenElement |
| width | Number | see ScreenElement |
| height | Number | see ScreenElement |
| privilege | Number | The privilege level required to make a button click send a value |
| label | String | A label shown on the button |
| icon | String | An icon shown on the button |
| enableId | String | The enable ID (may be empty) |
| enableValue | String | The value which must be matched to enable the field |
| font | String | The font to be used |
| color | String | The color used for the label (#RRGGBB) |
| action | String | The action to perform if the button is clicked (see below) |
| par1 | String | A parameter that applies for the action to perform. The meaning of this field depends on the action selected (see below) |
| par2 | String | A second parameter that applies for the action to perform. The meaning of this field depends on the action selected (see below) |
| par3 | String | A third parameter that applies for the action to perform. The meaning of this field depends on the action selected (see below) |
| variableBackgroundColor | Boolean | true = use a variable background color |
| colorId | String | The message ID to listen for the background color |
| colors | Array | of ColorDefinition objects. Defines how to translate values of the colorId parameter to color values. |
The action field of the ButtonElement defines what the button will do when clicked by the operator. The list below shows all known values for action, the meaning of this and a description of the parameters par1 and par2 which will have different meanings for particular action.
CHILD-SCREEN
Launches a new browser tab or window showing the user screen referenced with par1.
REPLACE-SCREEN
Replaces the actual user screen by the one referenced with par1.
LOAD-PRESET
Launches a "Load Preset" dialog which lets the operator select and apply a device preset from a list of presets which are defined for this particular type of device. Device presets are local to each M&C instance, have to be loaded and applied from there.
MYMNC.MYDEVICE (must be set in the screen editor this way).TRACK-VIEW
Launches a tracking view window. This window shows the tracking history of a given antenna controller device. Not all tracking controller devices are capable to report their tracking history.
MYMNC.MYACU (must be set in the screen editor this way).AZEL-VIEW
Launches a Az/El view window. This window shows the tracking history of a given antenna controller device as a cloud of dots in a azimuth over elevation coordinate system. Not all tracking controller devices are capable to report their tracking history.
MYMNC.MYACU (must be set in the screen editor this way).FREC-VIEW
Launches a File-Recorder view window. This window shows the data recorded by the File-Recorder device referenced with par1 or the live data provided by this device.
MYMNC.MY-FREC (must be set in the screen editor this way). In the device screen of the file recorder, the special device name "." denotes this device.SPECTR-VIEW
Launches a Spectrum Display window. This window in fact is a device screen of the CSM-Spectrum-Analyzer device.
MYMNC.MY-FREC (must be set in the screen editor this way).BROWSER-VIEW
Opens a new Browser window and displays a given URL in this window. This function is used to invoke the sat-nms online help and to launch the Web-GUI of certain devices.
VIDEO-VIEW
Launches a VideoLAN video player to show the video stream from a surveillance camera controlled by a M&C. The VIDEO-VIEW ButtonElement may only occur in device screens, the IP address of the camera has to be taken from the address_ parameter of the device.
ROBOT-IMPORT
Launches a Robot Import screen. This screen lets the operator select a Pointing-Robot file from the local PC, the file gets converted to sat-nms format an then transferred to the M&C.
TREE-NAVIGATE
In a tree view UI this button navigates in the tree to the tree path referenced with par1. As the tree view UI with the WebUI is still t.b.d., this description should be considered as preliminary.
UNKNOWN
All ButtonElement definitions in a screen, which have no WebGUI equivalent for their programmed action (like "launching a new Java VM') are translated into an UNKNOWN action. The Frontend may show this e.g. as a disabled button with an "n/a" label.