Eloquence B.07.00 Release Notes - WEBDLG PR#5
Eloquence WEBDLG - Object classes and attribute reference
This reference covers every object class and attribute implemented with
WEBDLG.
Contents:
Name |
Type |
Default |
GET |
SET |
Description |
class |
STRING |
|
X |
- |
Object's class name
|
id |
STRING |
empty |
X |
X |
Object's identifier (name), must be unique in the current object level
|
x |
INT |
0 |
X |
X |
Horizontal object position
|
y |
INT |
0 |
X |
X |
Vertical object position
|
w |
INT |
0* |
X |
X |
Object width (default value is class-specific)
|
h |
INT |
0* |
X |
X |
Object height (default value is class-specific)
|
visible |
INT |
1 |
X |
X |
Whether the object is visible
(objects in a container are affected by the container's visibility)
|
sensitive |
INT |
1 |
X |
X |
Whether the object is sensitive for user-input
(objects in a container are affected by the container's sensitivity)
|
rule |
INT |
0 |
X |
X |
If nonzero: value returned to the program on action (kind of action
is class-specific)
|
ruleonchange |
INT |
1* |
X |
X |
If nonzero: rule is triggered only when edittext contents change
(default value depends on the
RuleOnChange
configuration). If defined in a dialog or groupbox, this attribute
affects all contained objects.
|
focus |
INT |
0 |
X |
X |
Whether this object has or shall get the keyboard focus
|
help |
STRING |
empty |
X |
X |
Currently unused since the help system is not functional yet
|
udata |
ANY |
|
X |
X |
General-purpose user data
|
fgc |
STRING* |
empty |
X |
X |
Object's foreground (text) color in hexadecimal RGB format (#rrggbb),
for example: #000000 equals black, #ffffff equals white (INT values
are ignored for compatibility reasons)
|
bgc |
STRING* |
empty |
X |
X |
Object's background color in hexadecimal RGB format (#rrggbb),
for example: #000000 equals black, #ffffff equals white (INT values
are ignored for compatibility reasons)
|
font |
INT |
0 |
X |
X |
Ignored but implemented for compatibility reasons
|
fontface |
STRING |
empty |
X |
X |
Aka. font family. The following universal font families should be
supported by any browser regardless of the operating system used:
Serif, Sans-serif, Cursive, Fantasy, Monospace. Otherwise, any
system-specific font families such as Courier can be used as well
but may cause non-portable appearance.
|
fontsize |
STRING* |
empty |
X |
X |
Either a pre-defined constant (xx-small, x-small, smaller, small,
medium, large, larger, x-large, xx-large) or an absolute size
followed by an unit (12pt for 12 points, 20px for 20 pixels).
If no unit is given or an INT is passed, points are assumed.
|
fontstyle |
STRING |
empty |
X |
X |
A pre-defined constant (plain, bold, italic)
|
first |
STRING |
|
X |
- |
Path of first contained object
|
next |
STRING |
|
X |
- |
Path of next object in same level
|
kbcode |
INT |
|
- |
X |
Ignored but implemented for compatibility reasons
|
focusobj |
INT |
|
X |
- |
Path of current focused object
|
kbind |
INT |
|
X |
X |
Ignored but implemented for compatibility reasons
|
The dialog class serves as the root-level object container.
Name |
Type |
Default |
GET |
SET |
Description |
x |
INT |
0 |
X |
X |
Ignored but implemented for compatibility reasons
(please refer to the document How
compatible is Eloquence WEBDLG? for details)
|
y |
INT |
0 |
X |
X |
Ignored but implemented for compatibility reasons
(please refer to the document How
compatible is Eloquence WEBDLG? for details)
|
title |
STRING |
empty |
X |
X |
Dialog title
(a special token is provided
to embed the title into customized page header and/or page trailer
template files)
|
border |
INT |
3 |
X |
X |
If nonzero: border width in pixels (has no effect with Netscape 4.x
browsers).
|
bgimage |
STRING |
empty |
X |
X |
Location of a background image file, typically on a web server.
If a relative URL is given the .baseurl attribute of the
application object is prepended.
Please note that with Netscape this disables any background colors
(even with Netscape 6.2).
|
cr |
INT |
0 |
X |
X |
Ignored but implemented for compatibility reasons
|
f1...f10 |
INT |
0 |
X |
X |
Ignored but implemented for compatibility reasons
|
alt |
INT |
0 |
X |
X |
Ignored but implemented for compatibility reasons
|
The groupbox class serves as an general-purpose object
container.
Name |
Type |
Default |
GET |
SET |
Description |
title |
STRING |
empty |
X |
X |
Currently ignored but implemented
|
border |
INT |
1 |
X |
X |
If nonzero: border width in pixels (has no effect with Netscape 4.x
browsers).
|
The statictext class is used to display object labels as
well as text of any purpose.
Name |
Type |
Default |
GET |
SET |
Description |
w |
INT |
* |
X |
X |
Object width (default value depends on text length)
|
h |
INT |
1 |
X |
X |
Object height
|
text |
STRING |
empty |
X |
X |
The text to be displayed
|
The pushbutton class is used to submit actions to the
program according to the rule value.
Name |
Type |
Default |
GET |
SET |
Description |
w |
INT |
* |
X |
X |
Object width (default value depends on length of button's text)
|
h |
INT |
1 |
X |
X |
Object height
|
rule |
INT |
0 |
X |
X |
If nonzero: rule value to be triggered when the button is clicked.
|
text |
STRING |
empty |
X |
X |
The button's text
|
border |
INT |
1 |
X |
X |
Currently ignored but implemented (a pushbutton always has a border)
|
adjust |
INT |
0 |
X |
X |
Ignored but implemented for compatibility reasons
|
ruleoverride |
INT |
1 |
X |
X |
Whether the rule of an edittext which currently has the focus will
be overridden.
|
The checkbox class is used to select an option. Additionally,
a rule can be triggered if the state of the checkbox changes.
Name |
Type |
Default |
GET |
SET |
Description |
w |
INT |
* |
X |
X |
Object width (default value depends on length of label text)
|
h |
INT |
1 |
X |
X |
Object height
|
rule |
INT |
0 |
X |
X |
If nonzero: rule value to be triggered when the state of the checkbox
is changed.
|
text |
STRING |
empty |
X |
X |
The label text of the checkbox
|
active |
INT |
0 |
X |
X |
Whether the checkbox is active or to be activated
|
ruleoverride |
INT |
1 |
X |
X |
Whether the rule of an edittext which currently has the focus will
be overridden.
|
The radiobutton class is used to choose one of a number
of options. Additionally, a rule can be triggered if the state of the
radiobutton changes.
Name |
Type |
Default |
GET |
SET |
Description |
w |
INT |
* |
X |
X |
Object width (default value depends on length of label text)
|
h |
INT |
1 |
X |
X |
Object height
|
rule |
INT |
0 |
X |
X |
If nonzero: rule value to be triggered when the state of the radiobutton
is changed.
|
text |
STRING |
empty |
X |
X |
The label text of the radiobutton
|
activebtn |
STRING |
empty |
X |
- |
Path of active radiobutton in this group
|
active |
INT |
0 |
X |
X |
Whether the radiobutton is active or to be activated
|
ruleoverride |
INT |
1 |
X |
X |
Whether the rule of an edittext which currently has the focus will
be overridden.
|
The edittext class is used for single- and multiline
editable data entry areas. A rule can be triggered whenever the
contents have changed and the focus moves out of the edittext.
Please note that although a cursor position is maintained, this is only
used internally (eg. to specify the position where new contents are to
be inserted). The browser however does not mention this cursor position
at all.
Name |
Type |
Default |
GET |
SET |
Description |
rule |
INT |
0 |
X |
X |
If nonzero: rule value to be triggered when the contents have changed
and the focus moves out of the edittext.
|
length |
INT |
|
X |
- |
Current length of content
|
content |
STRING |
empty |
X |
X |
Current content
|
editable |
INT |
1 |
X |
X |
Whether edittext is editable or read-only
|
multiline |
INT |
0 |
X |
X |
Whether edittext is single- or multi-line
|
border |
INT |
1 |
X |
X |
Currently ignored but implemented (an edittext always has a border)
|
title |
STRING |
empty |
X |
X |
Ignored but implemented for compatibility reasons
|
hsb |
INT |
1 |
X |
X |
Ignored but implemented for compatibility reasons
(horizontal scroll bar is displayed automatically by the browser)
|
vsb |
INT |
1 |
X |
X |
Ignored but implemented for compatibility reasons
(horizontal scroll bar is displayed automatically by the browser)
|
maxchars |
INT |
0 |
X |
X |
Maximum characters accepted for input (0=unlimited)
|
maxlines |
INT |
0 |
X |
X |
Ignored but implemented for compatibility reasons
|
ispassword |
INT |
0 |
X |
X |
Whether contents are visible or displayed as '*' asterisk characters
|
vheight |
INT |
|
X |
- |
Current number of lines
|
vwidth |
INT |
|
X |
- |
Current number of columns
|
cx |
INT |
0 |
X |
X |
Cursor column (starting with 0)
|
cy |
INT |
0 |
X |
X |
Cursor line (starting with 0)
|
topitem |
INT |
0 |
X |
X |
Topmost line (starting with 0)
|
clear |
|
|
- |
X |
Clears the entire edittext
|
add |
STRING |
|
- |
X |
Adds new contents to the end
|
line |
STRING |
|
X |
X |
A specific line's contents
|
home |
|
|
- |
X |
Moves the internal position to the beginning
|
end |
|
|
- |
X |
Moves the internal position to the end
|
bol |
|
|
- |
X |
Moves the internal position to the beginning of the current line
|
eol |
|
|
- |
X |
Moves the internal position to the end of the current line
|
up |
INT |
|
- |
X |
Moves the internal position up for the specified number of lines
|
down |
INT |
|
- |
X |
Moves the internal position down for the specified number of lines
|
left |
INT |
|
- |
X |
Moves the internal position left for the specified number of columns
|
right |
INT |
|
- |
X |
Moves the internal position right for the specified number of columns
|
npage |
INT |
|
- |
X |
Moves the internal position down for the specified number of pages
|
ppage |
INT |
|
- |
X |
Moves the internal position up for the specified number of pages
|
ins |
STRING |
|
- |
X |
Inserts new contents at the current position
|
delch |
INT |
|
- |
X |
Deletes the specified number of characters from the current position
|
delln |
INT |
|
- |
X |
Deletes the specified number of lines from the current position
|
deleol |
|
|
- |
X |
Deletes from the current position up to the end of the current line
|
deleot |
|
|
- |
X |
Deletes from the current position up to the end
|
file |
STRING |
|
- |
X |
Name of a file from which the contents shall be read
(the encoding of external files can be configured with the
ExtCharset directive)
|
insertfile |
STRING |
|
- |
X |
Name of a file from which the contents shall be inserted at the
current position
|
writefile |
STRING |
|
- |
X |
Name of a file to which the contents shall be written
|
The listbox class is used to choose from a number
of lines. Additionally, a rule can be triggered if the selected
line changes.
Please note that although a cursor position is maintained, this is only
used internally (eg. to specify the position where new contents are to
be inserted). The browser however does not mention this cursor position
at all.
Name |
Type |
Default |
GET |
SET |
Description |
rule |
INT |
0 |
X |
X |
If nonzero: rule value to be triggered when the selected line changes.
|
length |
INT |
|
X |
- |
Current length of content
|
content |
STRING |
empty |
X |
X |
Current content
|
multiline |
INT |
0 |
X |
X |
Whether edittext is single- or multi-line
|
border |
INT |
1 |
X |
X |
Currently ignored but implemented (a listbox always has a border)
|
title |
STRING |
empty |
X |
X |
Ignored but implemented for compatibility reasons
|
hsb |
INT |
1 |
X |
X |
Ignored but implemented for compatibility reasons
(horizontal scroll bar is displayed automatically by the browser)
|
vsb |
INT |
1 |
X |
X |
Ignored but implemented for compatibility reasons
(horizontal scroll bar is displayed automatically by the browser)
|
vheight |
INT |
|
X |
- |
Current number of lines
|
vwidth |
INT |
|
X |
- |
Current number of columns
|
cx |
INT |
0 |
X |
X |
Cursor column (starting with 0)
|
cy |
INT |
0 |
X |
X |
Cursor line (starting with 0)
|
topitem |
INT |
0 |
X |
X |
Topmost line (starting with 0)
|
activeline |
INT |
0 |
X |
X |
Current active line (starting with 1, 0 = no active line)
|
clear |
|
|
- |
X |
Clears the entire edittext
|
add |
STRING |
|
- |
X |
Adds new contents to the end
|
line |
STRING |
|
X |
X |
A specific line's contents
|
home |
|
|
- |
X |
Moves the internal position to the beginning
|
end |
|
|
- |
X |
Moves the internal position to the end
|
bol |
|
|
- |
X |
Moves the internal position to the beginning of the current line
|
eol |
|
|
- |
X |
Moves the internal position to the end of the current line
|
up |
INT |
|
- |
X |
Moves the internal position up for the specified number of lines
|
down |
INT |
|
- |
X |
Moves the internal position down for the specified number of lines
|
left |
INT |
|
- |
X |
Moves the internal position left for the specified number of columns
|
right |
INT |
|
- |
X |
Moves the internal position right for the specified number of columns
|
npage |
INT |
|
- |
X |
Moves the internal position down for the specified number of pages
|
ppage |
INT |
|
- |
X |
Moves the internal position up for the specified number of pages
|
ins |
STRING |
|
- |
X |
Inserts new contents at the current position
|
delch |
INT |
|
- |
X |
Deletes the specified number of characters from the current position
|
delln |
INT |
|
- |
X |
Deletes the specified number of lines from the current position
|
deleol |
|
|
- |
X |
Deletes from the current position up to the end of the current line
|
deleot |
|
|
- |
X |
Deletes from the current position up to the end
|
file |
STRING |
|
- |
X |
Name of a file from which the contents shall be read
(the encoding of external files can be configured with the
ExtCharset directive)
|
writefile |
STRING |
|
- |
X |
Name of a file to which the contents shall be written
|
The helptext class is currently not functional. It is
however implemented for compatibility reasons.
The POPUP BOX displays a simple confirmation dialog with
a variable number of text lines and pushbuttons.
Syntax:
POPUP BOX X,Y,"[Title][Line 1|Line 2|Line 3][Button 1|Button 2]",Rc
Please note:
-
With WEBDLG, the X/Y coordinates are ignored.
-
On entry, WEBDLG ignores the value of
Rc .
With ASCII DLG, it would define the default button which can be
submitted with the ENTER key, but with WEBDLG this is
currently not implemented.
-
On exit, the value of
Rc reflects which button was
submitted (starting with 1).
-
CSS style sheets can be used to customize the appearance.
Please refer to the document
How compatible is Eloquence
WEBDLG? for details.
The non-visible root-level system object is used to query
properties of the current driver. A program can use this information to
dynamically find out eg. whether it uses a WEBDLG or Java DLG driver and
change its behavior appropriately.
Name |
Type |
Default |
GET |
SET |
Description |
driver |
STRING |
empty |
X |
- |
WEB for WEBDLG, JDLG for Java DLG
(will be implemented for ASCII DLG as well)
|
version |
STRING |
empty |
X |
- |
The driver's version code
|
baseurl |
STRING |
empty |
X |
- |
Any given relative URL (eg. referring to image files) is prepended
with this value. An URL is considered relative if it does not start
with http:// (globally-absolute) or /
(server-absolute).
|
helpbaseurl |
STRING |
empty |
X |
- |
Currently unused since the help system is not functional yet
|
Example:
! Query the System.driver
DLG GET "System.driver",Driver$
The non-visible root-level application object is used to
define session-wide parameters. If required, they should be specified
early in the program before any dialog is loaded to ensure that every
dialog will be affected.
Name |
Type |
Default |
GET |
SET |
Description |
baseurl |
STRING |
empty |
X |
X |
Any given relative URL (eg. referring to image files) is prepended
with this value. An URL is considered relative if it does not start
with http:// (globally-absolute) or /
(server-absolute).
|
helpbaseurl |
STRING |
empty |
X |
X |
Currently unused since the help system is not functional yet
|
Example:
! Set the Application.baseURL
DLG SET "Application.baseURL","http://www.your-host.com/your-app/"
! Now load the first dialog
DLG LOAD "dialog.dlg,YOURVOL"
With the image class, graphics can be embedded into dialogs.
The particular image file is typically stored on the same web server where
the WEBDLG application runs.
Name |
Type |
Default |
GET |
SET |
Description |
w |
INT |
0 |
X |
X |
Width in character cells of the rectangular area where the image
is to be placed. If the image's width extends this width the area
is enlarged accordingly by the browser.
|
h |
INT |
0 |
X |
X |
Height in character cells of the rectangular area where the image
is to be placed. If the image's height extends this height the area
is enlarged accordingly by the browser.
|
url |
STRING |
empty |
X |
X |
Location of the image file, typically on a web server.
If a relative URL is given the .baseurl attribute of the
application object is prepended.
|
rule |
INT |
0 |
X |
X |
If nonzero: rule value to be triggered when the image is clicked.
|
ruleoverride |
INT |
1 |
X |
X |
Whether the rule of an edittext which currently has the focus will
be overridden.
|
border |
INT |
0 |
X |
X |
If nonzero: border width in pixels (has no effect with Netscape 4.x
browsers).
|
sw |
INT |
0 |
X |
X |
Horizontal alignment:
0 : The image is horizontally centered
<0 : The image is horizontally scaled to
.w (in character cells)
>0 : The image is horizontally scaled to
.sw (in pixels)
|
sh |
INT |
0 |
X |
X |
Vertical alignment:
0 : The image is vertically centered
<0 : The image is vertically scaled to
.h (in character cells)
>0 : The image is vertically scaled to
.sh (in pixels)
|
© Copyright 2002-2003 Marxmeier Software AG. All rights reserved.
Revision: 2003-05-05
|