| |
Document revision: 2023-02-22
Refers to JDLG version: 2.0.16
Contents
TabBox class
A TabBox is a special container object which accepts a number of
GroupBox child objects, where only
one GroupBox is displayed.
For each GroupBox, a tab is displayed
in the tab bar, showing the
GroupBox title and optionally
a GroupBox icon.
The tab bar may be used to switch between the available tabs,
which displays the associated GroupBox.
A nonzero TabBox rule value or
GroupBox rule value is
returned to the program when tabs are switched.
Notes:
- The size of a GroupBox child
object is ignored, its size depends on the TabBox size.
A virtual size may be
defined for a GroupBox child object,
which then becomes scrollable if insufficient space is available.
- The border attribute of a
GroupBox child object is ignored,
no border is displayed.
- For an invisible
GroupBox child object, the associated
tab is disabled but still displayed. The disabled
state is usually visualized using dim
foreground and
background colors, subject
to the look-and-feel definition.
- class : string, get
- Returns "TabBox".
- rule : integer, get/set
- If nonzero, the rule value is returned to the program, along with the
path of the TabBox object
(see also ruleoverride below), when a
tab is clicked or activated by a
GroupBox accelerator key
and this changes the selected tab.
The default rule value is zero.
Note: If a GroupBox rule
value is set to nonzero, it is returned to the program instead of
the TabBox rule value, along with the
path of the
GroupBox object.
See also the documentation of the
common rule attribute.
- ruleoverride : integer, get/set
- If nonzero, the rule
of a previously focused EditText
or ComboBox object is overridden
(the TabBox rule value or the
GroupBox rule value combined
with the EditText or
ComboBox
path
is returned).
The default ruleoverride value is zero.
For details, please refer to the
RuleOverride documentation.
- scrollable : integer, get/set
- Specifies the tab layout to be used when the tabs do not fit
in the tab bar.
Zero (default): The tabs are wrapped.
Nonzero: The tab bar is scrollable.
Note: This functionality requires a Java version 1.5 or above
and may not be available, depending on the
look-and-feel definition.
- selectedtab : string, get/set
- Specifies the id of the
currently selected tab.
Note: On DLG GET, this is always returned in lower-case.
- tabs : integer, get
- Returns the current number of tabs.
- tabplacement : string, get/set
- Specifies the placement of the tab bar.
Possible values are:
"top"
"bottom"
"left"
"right"
The default value is "top".
Note: This functionality may not be available, depending on the
look-and-feel definition.
|
|
