Skip to main content
Version: Next (5.0)

Window

A window is a container with a title bar. It also can be maximized or restored, and it's very useful to sort groups of components in the screen.

Window

XML skeleton​

<window id="[window-identifier]" label="[window-label]" style="[window-style]"
icon="[window-icon]" expandible="[expand-orientation]" maximize="[maximize-window]">
<tag type="div" style="panel-body">...</tag>
<tag type="div" style="panel-footer">...</tag>
...
<grid>...</grid>
...
<chart>...</chart>
...
</window>

Window structure​

ElementUseMultiples instancesDescription
windowRequiredNoGlobal node of window. Describes the window attributes
tagOptionalYesA tag list inside the window, usually with styles like panel-body and panel-footer
gridOptionalNoA grid inside the window
chartOptionalNoA chart inside the window

Note There are three special styles you can use as tag styles on windows:

  • panel-body: A special style to define the content of a window. It adds margins to the content.
  • panel-footer: A special style to define the bottom of a window. It is recommended to put buttons inside.
  • expand-maximize: A special style usually combined with panel-body which expands the content of the window when it is maximized.

Window attributes​

AttributeUseTypeDescriptionValues
idOptionalStringWindow identifier. For reference purposes
labelOptionalStringWindow titleNote: You can use i18n files (locales)
styleOptionalStringWindow CSS classesNote: Here you can use expand class to set the window as expandible
iconOptionalStringIcon identifierNote: You can check all iconsets at icons screen
expandibleOptionalStringHow to expand the window childrenvertical (default), horizontal
maximizeOptionalBooleanWhether to show the maximize icon or notNote: Only a window with a label can be maximized
helpOptionalStringHelp text for the criterionNote: You can use i18n files (locales)
help-imageOptionalStringHelp image for the criterionThis must be a image path

Examples​

Expandible window with grid (maximizable)​

<window style="expand" maximize="true" label="SCREEN_TEXT_DATA" icon="list">
<grid ...>...</grid>
</window>
expandible window with grid

Static window with content and buttons zone​

<window label="SCREEN_TEXT_CRITERIA" icon="filter">
<tag type="div" style="panel-body">...</tag>
<tag type="div" style="panel-footer">
<tag type="div" style="pull-right">...</tag>
</tag>
</window>
Static_window_with_buttons_and_panel

AngularJS and React engines​

Both engines handle expandible and maximize in the same way:

  • expandible sets the direction in which the window shares the space among its children (vertical by default).
  • maximize="true" shows a button in the title bar that maximizes the window over the content of the screen and restores it. The window fills the content area, keeping the menu and the top bar visible, and its sibling windows are hidden while it is maximized. The Restore button brings it back; there is no Escape key shortcut. The content with the expand-maximize style takes the free space while the window is maximized.

The differences are only visual: the maximize button shows the Lucide expand and shrink icons in the AngularJS engine and maximize and minimize in the React engine, and the React engine shows the icon of the window at the right of the title bar.