Toolbar module

The Toolbar module used to create a 2D toolbar menu. The toolbar is made up of a set of sections containing buttons. Each section is composed of one or more buttons.

Fields

• Configuration fields

• Input fields

Collapse mode

For each section, you can define the collapse mode.

• None: No collapse mode.

• Radio: When the section is collapsed, only the icon of the active button of the specified radio group on the toolbar will be visible. If the radio group is initialized without any button selected, it is still possible to assign an arbitrary icon to the collapse button by using the collapseIcon setting.

  

• Icon: When the section is collapsed, only a custom icon will be visible

  

Adaptive toolbar and supported window resolutions

The toolbar dynamically adapts based on screen resolution. Groups of buttons will automatically collapse, based on screen resolution.

A width below 676 px, will result in no Toolbar being displayed.

When width is between 676 px and 986px, the toolbar will be collapsed.

When width is above 986px, the full toolbar displays.

 

In the case where the height of the windows is less than 550 pixels, the lateral sub-menus will display horizontally.

Buttons

For each button, it is possible to define some options:

• Name: Name of the button.

• Type: Can be only Button.

• Enabled: If by default the button is enabled or not (true, false).

• Mode: The mode of the button.

Button modes

This information must be specified inside the JSON for the definition of the module.

• push — Usually used to trigger punctual events, such as closing a toolbar.

• toggle — Usually used to switch a state on and off, such as enabling or disabling a functionality.

• radio — Only one of the radio buttons in a radio group can stay active.

  

• multistate — A push button that switches between two or more different states.

  

• radioGroup — Name of the radio group, if the mode is set to radio.

• allowDeselect — If the mode is set to radio, this option allows you to define whether the radio group can be in a state without any button selected.

• states — If the mode is set to multistate, defines the various states of the button.

• stateArguments — If the mode is set to multistate, defines the various arguments of the states of the button that will be passed to the button callback as arguments. When not specified, the text in states will be used instead.

• font — The font of the icon or the text of the button.

• text — The character that defines the icon or the text displayed on the button as default value.

• toolTipText — Specifies the tooltip of the button. If not set, the tooltip will show the name of the button by default.

• callBack — The function to call when button is clicked.

• subMenu — Specifies the submenu that will be opened when clicking on the button (SideMenu/Labels).

  

• sideMenu — A side menu is composed like the main menu, allowing the addition of sections and buttons.

  

• labels — Labels are defined like the main menu, but with a different aspect.