|
Document revision: 2024-05-27
Refers to JDLG version: 2.0.18
Contents
Object position and size attributes
Object position and size are specified in Dialog raster units or pixel units,
depending on the posraster and
sizeraster attribute values.
The object position is relative to the parent container object.
By default, Dialog raster units are used (i.e., both
posraster and
sizeraster are nonzero).
Note: Using the posraster and
sizeraster attributes to specify pixel units
requires JDLG version 1.7.0 or newer.
The Dialog raster is defined by the Dialog font.
If not specified, a 12-point DialogInput font is used, unless
the
eloquence.config.defaultfont.name
and .size properties are
configured otherwise.
The resulting raster size is adjusted by the value of the
Application.scalefactor
attribute.
As a consequence, the object size is scaled according to the appearance of the
Dialog font if it is specified in Dialog raster
units. On the other hand, using pixel units allow for a more flexible Dialog
layout but might cause an object size to no longer agree to its font size.
Horizontal and vertical layout modes may be specified using the xauto
and yauto attributes, allowing to define if the object origin is left/top
or right/bottom and if the object size is dynamically adjusted based on
the size of the parent container object. If the Dialog
resizepolicy is set to
"layout", object position and/or object size are dynamically adjusted
whenever the Dialog is resized.
- x : integer, get/set
- Same as xleft (see below).
- xleft : integer, get/set
- Left object position.
Used with xauto=1 and xauto=0 layout modes (see below).
- xright : integer, get/set
- Right object position.
Used with xauto=0 and xauto=-1 layout modes (see below).
- w : integer, get/set
- Object width.
Used with xauto=1 and xauto=-1 layout modes (see below).
- wmin : integer, get/set
- Object minimum width.
The default value is zero (no minimum width).
Notes:
- In the current implementation this only limits the range the user can
move a Splitter divider. It must be set
on the immediate Splitter child objects.
In other scenarios, the wmin attribute currently has no effect.
- Requires JDLG version 2.0.14 or newer.
- wmax : integer, get/set
- Object maximum width.
The default value is zero (no maximum width).
Notes:
- In the current implementation this only limits the range the user can
move a Splitter divider. It must be set
on the immediate Splitter child objects.
In other scenarios, the wmax attribute currently has no effect.
- Requires JDLG version 2.0.14 or newer.
- xauto : integer, get/set
- Horizontal layout mode:
xauto = 1 (default) | |
xleft defines left object position,
w defines object width. |
xauto = 0 | |
xleft defines left object position,
xright defines right object position
(object width is dynamically adjusted). |
xauto = -1 | |
xright defines right object position,
w defines object width
(left object position is dynamically adjusted). |
- y : integer, get/set
- Same as ytop (see below).
- ytop : integer, get/set
- Top object position.
Used with yauto=1 and yauto=0 layout modes (see below).
- ybottom : integer, get/set
- Bottom object position.
Used with yauto=0 and yauto=-1 layout modes (see below).
- h : integer, get/set
- Object height.
Used with yauto=1 and yauto=-1 layout modes (see below).
- hmin : integer, get/set
- Object minimum height.
The default value is zero (no minimum height).
Notes:
- In the current implementation this only limits the range the user can
move a Splitter divider. It must be set
on the immediate Splitter child objects.
In other scenarios, the hmin attribute currently has no effect.
- Requires JDLG version 2.0.14 or newer.
- hmax : integer, get/set
- Object maximum height.
The default value is zero (no maximum height).
Notes:
- In the current implementation this only limits the range the user can
move a Splitter divider. It must be set
on the immediate Splitter child objects.
In other scenarios, the hmax attribute currently has no effect.
- Requires JDLG version 2.0.14 or newer.
- yauto : integer, get/set
- Vertical layout mode:
yauto = 1 (default) | |
ytop defines top object position,
h defines object height. |
yauto = 0 | |
ytop defines top object position,
ybottom defines bottom object position
(object height is dynamically adjusted). |
yauto = -1 | |
ybottom defines bottom object position,
h defines object height
(top object position is dynamically adjusted). |
- posraster : integer, get/set
- This specifies how JDLG interprets the position attributes
x, xleft,
xright, y,
ytop, ybottom
of this object.
Nonzero (default): Position attributes are specified in Dialog raster units.
Zero: Position attributes are specified in pixel units.
Note: Requires JDLG version 1.7.0 or newer.
- sizeraster : integer, get/set
- This specifies how JDLG interprets the size attributes
w, h of this object.
Nonzero (default): Size attributes are specified in Dialog raster units.
Zero: Size attributes are specified in pixel units.
Note: Requires JDLG version 1.7.0 or newer.
- raster : integer, get/set
- Used to set both the posraster and sizeraster attributes to the same value.
On DLG GET, 1 is returned if both posraster and sizeraster are set to a
nonzero value, else 0 is returned.
Note: Requires JDLG version 1.7.0 or newer.
Common attributes
The attributes listed below are common for all object classes.
- bgc : integer, get/set (also: string, set)
- No function (provided for ASCII DLG backward compatibility).
If used with string argument in DLG SET: Same as bgcolor (see below).
- bgcolor : string, get/set
- Background color in hexadecimal #RRGGBB notation.
For example:
"#000000" | | black |
"#FFFFFF" | | white |
"#8b0000" | | dark red |
"#00ff00" | | green |
"#0000CD" | | medium blue |
"#b03060" | | maroon |
"#A020F0" | | purple |
"#FFFF00" | | yellow |
"#ffd700" | | gold |
"#00ffff" | | cyan |
The default background color depends on the object class
and may be subject to the
look-and-feel definition.
See also fgcolor below.
- class : string, get
- Object type (class name).
- clipboardcontextmenu : string, get/set
- Allows to override the global or session-specific clipboard context menu
configuration with an object-specific value.
The clipboardcontextmenu attribute affects
EditText and
ComboBox objects. If specified for a container
object, all contained EditText and
ComboBox objects are affected.
For details, please refer to the documentation of the
eloquence.config.clipboardcontextmenu
configuration property.
By default, this is the value of the
Application.clipboardcontextmenu
attribute or the
System.clipboardcontextmenu
attribute or the
eloquence.config.clipboardcontextmenu
configuration property.
Note: Requires JDLG version 1.5.7-110518-1310 or newer.
- contextmenu : string, get/set
- Specifies the path of a
Menu object that is opened at
the mouse position when the context
menu mouse button is clicked.
If the Menu object
path starts with a . dot character,
it is considered relative to the current Dialog,
i.e., the id of the current
Dialog is prepended.
The rmbmask attribute defines the
context menu mouse button. By default this is the right
mouse button.
For details, please refer to the
Context menus documentation.
- fgc : integer, get/set (also: string, set)
- No function (provided for ASCII DLG backward compatibility).
If used with string argument in DLG SET: Same as fgcolor (see below).
- fgcolor : string, get/set
- Foreground color in hexadecimal #RRGGBB notation
(see bgcolor above for examples).
The default foreground color depends on the object class
and may be subject to the
look-and-feel definition.
- first : string, get
- Used on a container object: Returns the path
of the first child object.
Used on top-level (DLG GET ".first"): Returns the
id of the first Dialog.
Note: Object path or
Dialog id is always
returned in lower-case.
An empty string is returned if no object or
Dialog is found.
See also next below.
- focus : integer, get/set
- A nonzero focus value specifies or indicates that this object
will obtain the keyboard focus on the next DLG DO invocation.
By default, the first focusable object in a
Dialog will obtain the keyboard focus if
the Dialog is opened for the first time.
- focuscolor : string, get/set
- Alternative background color in hexadecimal #RRGGBB notation,
used when the object has the keyboard focus
(see bgcolor above for examples).
By default, focuscolor equals bgcolor.
Note: Only applies to focusable object classes, such as
EditText,
ComboBox,
ListBox,
PopText,
PushButton.
- focusobj : string, get
- Path of the object that currently
has the keyboard focus.
Note: Always returned in lower-case.
- fontface : string, get/set
- Font face or font family name. The resulting object font is composed
using the fontface, fontsize and fontstyle attributes (see below).
Valid font face or font family names depend on the installed fonts,
for example Times, Helvetica, Courier.
The family names for logical fonts are: Dialog, DialogInput,
Monospaced, Serif, SansSerif. These are mapped
to available font face or font family names installed on the system.
By default, the object font attributes (fontface, fontsize, fontstyle) are
derived from the parent object, while the Dialog
font attributes are derived from the default font, defined by the
eloquence.config.defaultfont.name
and .size configuration
properties. The default Dialog font is a
12-point DialogInput font.
- fontsize : integer, get/set
- Font size in point units
(see fontface above).
By default, the fontsize attribute is derived from the parent object
or the Dialog.
- fontstyle : string, get/set
- Font style: plain, italic or bold
(see fontface above).
By default, the fontstyle attribute is derived from the parent object
or the Dialog.
- help : string, get/set
- A rule value of -1 triggers the help system
(see rule below), which uses the help
attribute values of an object and its parent objects to compose
the URL of a context-sensitive help document.
The base of this URL is defined by the
System.helpbaseurl
attribute or the
eloquence.config.helpbaseurl
configuration property, followed by the value of the
Application.helpbaseurl
attribute.
For example:
System.helpbaseurl = "http://intranet/jdlg/doc/"
Application.helpbaseurl = "erp/"
MenuDialog.help = "menu.html"
MenuDialog.Accounting.help = "#accounting"
Resulting URL:
http://intranet/jdlg/doc/erp/menu.html#accounting
The configured browser is then invoked with the resulting URL.
Please refer to the documentation of the
Application.browser
attribute for details.
Note: The F1 function key (i.e., the
Dialog.f1 attribute) by
default has a -1 rule value assigned.
- id : string, get/set
- Object identifier (object name).
Note: Always returned in lower-case.
- next : string, get
- Used on an object: Returns the path of
the next object in the same hierarchy level.
Used on top-level (DLG GET ".next"): Returns the
id of the next Dialog,
based on previous top-level DLG GET ".first" or ".next" invocation.
Note: Object path or
Dialog id is always
returned in lower-case. An empty string is returned if no object or
Dialog is found.
See also first above.
- path : string, get
- The path specifies the object location in the
Dialog hierarchy.
Path components are separated with . dot characters. The first
path component is always the id of the
Dialog.
Note: Always returned in lower-case.
- rmbmask : integer, get/set
- Defines which mouse button is used to trigger a context menu
(see contextmenu above) or the
Dialog.rmbr rule.
Possible values are:
1 - the left mouse button
2 - the middle mouse button (e.g., the mouse-wheel button)
4 - the right mouse button
and any combination of these, for example 6 (middle and right)
or 7 (all buttons).
The default value is 4 (right mouse button).
For details, please refer to the
Context menus documentation.
- rule : integer, get/set
- The rule value is returned to the program when an object
issues a notification event, for example when a
PushButton is clicked or a
configured Dialog
timeout has elapsed.
The rule value is transferred to the program through the first
return variable on DLG DO. If in addition a second return
variable is provided, it is used to transfer the context of the
issued event, which is an object path,
identifying for example the particular
PushButton that was clicked.
Details on the notification event types are documented for each
object class.
The default rule value is zero. Usually, a nonzero rule value
needs to be specified to enable event notification for an object.
Note: A rule value of -1 triggers the help system (see
help above). The F1 function key (i.e., the
Dialog.f1 attribute) by default
has a -1 rule value assigned.
- sensitive : integer, get/set
- Nonzero (default): Object and child objects are potentially
sensitive (react upon keyboard and mouse input), depending on
parent object sensitivity.
Zero: Object and child objects are insensitive (do not react upon
keyboard and mouse input).
Note: Insensitive objects are usually displayed using dim
foreground and
background colors, subject to the
look-and-feel definition.
- tabstop : integer, get/set
- Nonzero (default): The object is part of the
Dialog tab order.
Zero: The object is not part of the
Dialog tab order.
Note: Before JDLG version 1.6.5, if tabstop is set to zero
the object was no longer focusable.
- toolhelp : string, get/set
- Informational text to be displayed when the user hovers the mouse
cursor over the object for some time without clicking the mouse.
If set to an empty string, a previously set toolhelp text is deleted.
- udata : integer or string, get/set
- User-defined data stored in the object context.
DLG SET defines the data type (integer or string).
The default value is integer zero.
- visible : integer, get/set
- Nonzero (default): Object and child objects are potentially visible,
depending on parent object visibility.
Zero: Object and child objects are invisible (hidden).
|
|