User Tools

Site Tools


mistudio:design_editor:more_layout:buttons_inputs:indicatorbutton

This is an old revision of the document!


IndicatorButton

com.ergotech.vib.graphics.IndicatorButton

Image Examples

IndicatorButton in the graphics palette IndicatorButton graphic example
IndicatorButton in the graphics palette. IndicatorButton graphic example.

Overview

The IndicatorButton graphic is a More Layout button control that combines a button with a two-part indicator display.

The upper part of the graphic displays static text, and the lower part displays a boolean-style on/off state. The lower section changes label and color based on the current state.

IndicatorButton is used when an application needs both a clickable control and a clear visual status display in the same graphic.

Common Uses

  • Creating an on/off control with a built-in status display
  • Displaying operator control status
  • Showing two lines of static text above a boolean indicator
  • Sending a value into application logic
  • Creating a labeled control for equipment, devices, or functions

Input Behavior

IndicatorButton accepts a numeric input through updateDisplayedValue.

The input value is displayed as a boolean state in the lower part of the graphic.

Any non-zero input is treated as on, and zero is treated as off.

Output Behavior

IndicatorButton sends its output through PrimaryOutPort.

When the user interacts with the IndicatorButton, it sends the current button state as the output value.

IndicatorButton-Specific Behavior

IndicatorButton combines indicator-style display behavior with button-style control behavior.

The upper part of the graphic displays text, and the lower part displays the on/off state.

IndicatorButton-specific settings include:

  • Name Sets the name of the IndicatorButton graphic.
  • Bottom Font Controls the font used in the lower indicator section.
  • Color For Off Sets the lower section color used for the off state.
  • Color For On Sets the lower section color used for the on state.
  • Font Controls the font used for the upper text area.
  • Text Color Sets the text color.
  • Line 1 Text Sets the first line of text in the upper section.
  • Line 2 Text Sets the second line of text in the upper section.
  • Label For Off Sets the label shown in the lower section when the state is off.
  • Label For On Sets the label shown in the lower section when the state is on.
  • Color Top Sets the background color of the upper section.
  • Color Top Text Sets the text color used in the upper section.
  • Arc Height Sets the corner arc height.
  • Arc Width Sets the corner arc width.
  • Bad Qual. Indicator Controls the indicator used when bad quality data is received.
  • Bezel Sets the bezel style.
  • Bezel Color Sets the outside bezel color.
  • Bezel Inside Color Sets the inside bezel color.
  • Bezel Thickness Sets the thickness of the bezel.
  • Cursor Sets the cursor shown when the pointer is over the IndicatorButton.
  • Enabled Controls whether the user can interact with the IndicatorButton.
  • Rotation Sets the IndicatorButton rotation.
  • SplitPercent Controls how the space is divided between the upper and lower sections.
  • Visible Controls whether the IndicatorButton is shown.
  • Warning Qual. Indicator Controls the indicator used when warning or transitional quality data is received.

Logic Ports

In the Logic Editor, IndicatorButton includes these default ports:

  • PrimaryOutPort
  • updateDisplayedValue

The PrimaryOutPort sends the current output value.

The updateDisplayedValue port updates the displayed on/off state.

Notes

Use IndicatorButton when a control needs both an interactive output and a clear built-in on/off indicator.

For a simpler button-style control, see Button.

For a non-button status display, see Indicator if that page is created in your More Layout section.

mistudio/design_editor/more_layout/buttons_inputs/indicatorbutton.1789753007.txt.gz · Last modified: by tputman

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki