Manual

54.1
Overview generic classes

Each generic class has dedicated properties, which will be described within this chapter.

These classes describe components, which can be used to enter values or to show simple text or images:

Class Description
ComboBox Consists of a textfield and a list of selectable options. See subsection 54.3.9.
Graphics Shows a graphics or a diagram. Clicks could raise an action, but that's not mandatory. See subsection 54.3.12.
Icon Shows an image. Clicks could raise an action, but that's not mandatory. See subsection 54.3.13.
Label Shows some text, like a caption. Clicks could raise an action, but that's not necessary. See subsection 54.3.16.
ProgressBar Shows the current progress of an action. See subsection 54.3.28.
Slider Allows the user to select a value via a thumb. See subsection 54.3.32.
Spinner Allows the user to select a value via arrow-buttons combined with a textfield. See subsection 54.3.34.
Text Shows common text with multiple rows. A user can't enter any value. See subsection 54.3.43.
TextArea Allows the user to enter text, even with multiple lines. It is able to show that text as well. See subsection 54.3.44.
TextField Allows the user to enter single-line text. It is able to show that text as well. See subsection 54.3.45.
Table 54.1:  Generic classes for input and output

Those generic classes are normally used for direct interaction with the user like clicks. Those components could have a state:

Class Description
Button Raises an action, once it is clicked. It normally doesn't have a defined state. See subsection 54.3.3.
CheckBox Has a dedicated state. Usually you can check and un-check those components. See subsection 54.3.6.
Closer Closes a component, e.g. the 'X' button of a window. See subsection 54.3.7.
Link Allows the user to navigate to another area of the application. See subsection 54.3.17.
Maximizer Maximizes the size of a component, e.g. of a window. See subsection 54.3.20.
MenuItem Is shown in menus. A click normally raises an action or changes the application's state. See subsection 54.3.22.
Minimizer Minimizes the size of a component, e.g. of a window. See subsection 54.3.23.
RadioButton Stands for a selectable option. It is typically used for selecting a state, if various states are allowed. See subsection 54.3.25.
Restore Re-creates the original size of a component, e.g. of a window. See subsection 54.3.26.
Sizer Modifies the size of a component, e.g. of a window. See subsection 54.3.31.
Thumb Can be used to thumb through certain values on a slider component. See subsection 54.3.46.
ToggleButton Can be clicked like a button and has a certain state as well. Sometimes clicks also raise actions. See subsection 54.3.47.
ToolBarItem Stands for a clickable component inside a toolbar. See subsection 54.3.49.
Table 54.2:  Generic classes for interactions

Those components can be applied as containers, to organize other components:

Class Description
Accordion Can be used as navigator between components. Components can be expanded and collapsed. See subsection 54.3.1.
Calendar Can be used to select a date or time. See subsection 54.3.4.
ColorPicker Can be used to select a certain color. See subsection 54.3.5.
FileChooser Can be used to select a file. Usually it consists of a textfield, a list of files and a button to choose. See subsection 54.3.11.
Indicator Shows a message after an input event. Typically they appear after entering something into textfields, could also contain an icon. See subsection 54.3.14.
Menu Contains multiple menu items. See subsection 54.3.21.
Popup Shows components, which are only shown after a click on certain buttons and which belong to that button, e.g. the list after clicking on a button of a combobox. See subsection 54.3.24.
Panel Contains various components. Can be used to organize the UI. See subsection 54.3.27.
SplitPanel Shows components. Those components are located in resizable areas. See subsection 54.3.35.
TabPanel Can be used to navigate between components. Those components are shown in dedicated cards ("tabs"). Only one tab can be visible at once. See subsection 54.3.41.
ToolBar Stands for a toolbar. It typically contains several menu-items and important buttons to raise most common actions. See subsection 54.3.48.
ToolTip A window, which gets opened as some kind of hint. Normally shown, if the user moves the mouse over a component. See subsection 54.3.50.
Window Stands for a usual window. See subsection 54.3.54.
Table 54.3:  Generic classes for container components

Besides classes for container components, there are also classes which allows the user to show content in a well-organized structure:

Class Description
List Shows multiple values. Values could be selectable as well. See subsection 54.3.18.
Table Shows multiple values. It has several dimensions columns. Values could be selectable as well. See subsection 54.3.36.
TableFooter Footer row of a table. See subsection 54.3.38.
TableHeader Header row of a table. See subsection 54.3.39.
Tree Shows content as tree. Can be used to show values in certain categories. See subsection 54.3.51.
TreeTable Shows content as tree. Can be used to show values in certain categories. Values normally consist of several columns like in a table. See subsection 54.3.53.
Table 54.4:  Generic classes for data containers

Data itself is implemented with following classes:

Class Description
Item Sub-item of a list, can be selectable. See subsection 54.3.15.
TableCell A value of a table. It is identified by its column and its position in the row. See subsection 54.3.37.
TableHeaderCell Name of a column. See subsection 54.3.40.
TableRow Row of a table. See subsection 54.3.42.
TreeNode Sub-item of a tree. See subsection 54.3.51.
Table 54.5:  Generic classes for data

Beside classes for input, interaction, data or structuring a couple of classes exist, which only appear in very certain contexts:

Class Description
BusyPane Is drawn over other components to lock them. See subsection 54.3.2.
Divider Splits areas of certain components. It can be moved. See subsection 54.3.8.
Expander Is used to expand or collapse a component, e.g. for a node of a tree. See subsection 54.3.10.
LoadingComponent Is used to show that your application is busy, e.g. if something is getting loaded by your application. See subsection 54.3.19.
ScrollBar Is used for scrolling a component. Usually it contains a something like a thumb. See subsection 54.3.29.
Separator Splits areas of certain components. It cannot be moved. See subsection 54.3.30.
Spacer Acts as some kind of indentation, e.g. for nodes of a tree. See subsection 54.3.33.
Table 54.6:  Generic classes for specific components