The options table

This is a 'database table' parameter. Please refer to passing database tables for a detailed explanation of the database table format. In all the following examples we assume that the recordseparator is ^ and the fieldseparator is | .

options records are mappings

The options table is special kind of database table. It has records that contain mappings between keys and their associated values.
We will use the terms "key" and "value" instead of "field 0" and "field 1". 

all options are optional

All options are optional. diputab has reasonable defaults for every option in the options parameter. Although defaults exist you should not count on the values of these defaults, they may change over time. So, if you want to implement a special ‘look and feel’ you should declare your own options.

colors

backgroundcolor, foregroundcolor, textcolor, selectedcolor, tipcolor, tipbackgroundcolor, mouseovercolor, underlinecolor, highcolor, lowcolor and shadecolor

Colors are represented by a hexadecimal value. The first 2 digits are for the red component, the next 2 for the green component and the final 2 for the blue component.
The value of a color component can range from 00 to FF ( 00 = no intensity, FF = full intensity)
e.g. FFFFFF is the hexadecimal representation of white, 000000 is black.

key value
name value description
backgroundcolor hexadecimal integer the color of the background (behind the tabs)
foregroundcolor hexadecimal integer the color of the foreground (the tabs)
textcolor hexadecimal integer the color of the text
selectedcolor hexadecimal integer the color of the entry when it has been selected (clicked)
tipcolor hexadecimal integer the color of the pop up tip
tipbackgroundcolor hexadecimal integer the background color of the pop up tip
mouseovercolor hexadecimal integer the color of an entry when the mouse moves over it
underlinecolor hexadecimal integer the color of the line shown under an entry when the mouse moves over it
highcolor hexadecimal integer the color of the line surrounding the tab
lowcolor hexadecimal integer the color of the line surrounding the tab
shadecolor hexadecimal integer the color of the line surrounding the tab

example

<param name="options" value="
^backgroundcolor|C0C0C0
^foregroundcolor|336699
^textcolor|FFFF00
^selectedcolor|FFFFFF
^tipcolor|000000
^tipbackgroundcolor|FFFFE0
^mouseovercolor|FFFFC0
^highcolor|FFFFFF
^lowcolor|000000
^shadecolor|808080
">

applet margins

marginleft and marginright

key value
name value description
marginleft decimal integer the left margin
marginright decimal integer the right margin
A: marginleft, B: marginright

tab margins

baseline, tabheight and indent

key value
name value description
baseline decimal integer the baseline of the tab
tabheight decimal integer the height of the tab
indent decimal integer indentation for the first tab
A: indent, B: tabheight , C: baseline
 

text margins

textleft, textright, textup, textdown and imageleft

key value
name value description
textleft decimal integer the space between the left side of the text and the tab (or the image if defined)
textright decimal integer the space between the right side of the text and the tab
textup decimal integer the space between the upper side of the text and the tab
textdown decimal integer the space between the lower side of the text and the tab
imageleft decimal integer the space between the left side of the image and the tab

a: imageleft,b:textleft, c: textright, d: textup e: textdown

scrollbars

scrollbarhorizontaldivider, scrollbarverticaldivider, scrollbarwidth, scrollbuttonsize, unitdivider, blockdivider and scrollspeed

The initial size (100%) and the scrollbardivider value control the representation of the scrollbar. It can be divided by an integer value of 1 or greater.
e.g. a divider value of 3 will give a 33% coverage of the scrollbar.

key value
name value description
scrollbarhorizontaldivider decimal integer the divider value for the horizontal scrollbar
(value can not be 0 )
scrollbarverticaldivider
(only diputree)
decimal integer the divider value for the vertical scrollbar
(value can not be 0 )
scrollbarwidth decimal integer the width of the scrollbar in pixels
scrollbuttonsize decimal integer the width and height of the buttons
unitdivider decimal integer the amount (divider value) that should be scrolled when the user wants
to scroll by 1 unit ( by clicking on the scroll button )
blockdivider decimal integer the amount (divider value) that should be scrolled when the user wants
to scroll by 1 unit ( by clicking on the scroll button )
scrollspeed decimal integer the amount of time between 2 consecutive scrollings in milliseconds

Example

<param name="options" value="
^scrollbarhorizontaldivider|3
">
<param name="options" value="
^scrollbarhorizontaldivider|5
">

frame

Your web document can be divided into different frames. Every frame acts as a container for another web document, effectively creating a hierarchy of (contained) subdocuments.

You can assign a name to each frame individually. By default your browser assigns names to some special frames, such as: _blank (a new frame), _self (this frame), _parent (this frame’s parent) and _top (the uppermost parent frame, the root of the frame hierarchy).

key value
name value description
frame String the name of the default frame where the pages will be displayed,
can be overridden in the links parameter.

fontprofile

key value
name value description
fontprofile String the default font profile, can be overridden in the entries parameter

showstatus

key value
name value description
showstatus integer boolean showing status messages can be switched on or off
( 0 = off, 1 = on )

mouse movements

mouseover and underline

When the mouse moves over an entry, the entry can respond by highlighting or underlining itself.

key value
name value description
mouseover integer boolean highlighting due to the mouse being rolled over can be switched on or off
(0 = off, 1 = on)
underline integer boolean underlining due to the mouse being rolled over can be switched on or off
(0 = off, 1 = on)

tips

tipwait and tipfontprofile

Pop up tips are small messages that pop up whenever there is no user action during a specified period.

key value
name value description
tipwait decimal integer the period before a tip pops up defined in milliseconds (1000ms = 1sec)
tipfontprofile decimal integer the default font profile to use for the tips. If the tip extends beyond the applet’s boundaries the font size is decremented until it can fit within the boundaries (the default font profile for pop up tips is tipdefaultfont).

selected

The key of the entry that should be selected when the applet is first loaded.

key value
name value description
selected string the key from the entries table, that should be set as the selected record.

overlap

Overlap is the amount of pixels that the selected tab will extend over the adjacent tabs. This will add a perspective effect.

key value
name value description
overlap decimal integer the width in pixels that the selected tab will overlap over the adjacent tabs

Example

<param name="options" value="
^overlap|0
">
 
<param name="options" value="
^overlap|6
">

position

The tabs can be positioned at the top or the bottom.

key value
name value description
position String The position where the tabs will be located.
(values: "top" or "bottom")

Example

<param name="options" value="
^position|bottom
">

connecting lines

connectlineleft and connectlineright

If the tab is used in conjunction with a borderline from another html page a little gap can exist between the tabs and the borderline in the other frame.
Use connectlineleft and connectlineright to connect the tab with the borderline.

key value
name value description
connectlineleft integer boolean connect a line to the left
( 0 = no connection , 1 = connection)
connectlineleft integer boolean connect a line to the right
(0 = no connection and 1 = connection)
<param name="options" value="
^connectlineleft|1
">

externalhandlers

Not all browsers support external handlers. If this option is set, then the applet shall check during initialization if external handlers are supported.

If this feature is supported then the applet will leave this option as is ( a value of 1), if this feature is not support then the applet will unset this option ( new value will be 0 ).

In your script you can get the value of this option to determine if external handlers are enabled.

IMPORTANT

External handlers require the MAYSCRIPT attribute to be present in the applet definition.

key value
name value description
externalhandlers boolean integer instructs the applet to test if external handlers are supported
(values: 0 = don't test an consequently don't allow external handlers
1= test for external handlers support, if support is not available set value to 0)

asyncload

For utter compatibility you can disable ( a value of 0 ) the asynchronous loading of images. This will prevent the applet from showing a "please wait while loading" message during image loading.

key value
name value description
asyncload boolean integer tells the applet to enable asynchronous loading of images
(values: 0 = don't load asynchronously, 1= load asynchronously,)

baseurl

If you use relative URL’s then baseurl is used to complete your URL.

So if all your link URL’s are located in a directory " /mydirectory" at your web site "http://www.mywebsite.com" than you can define a baseurl "http://www.mywebsite.com/mydirectory".
Now you only have to use the filename part of your URL’s instead of the complete URL in your links parameter.

The default URL for baseurl is the URL of the directory that contains the applet.
So if your applet is located in "http://www.mysite.com/mydirectory/diputab.class", then the baseurl will be "http://www.mysite.com/mydirectory".

baseurl is used in the links parameter.

key value
name value description
baseurl String the url that will be used to complete relative and/or uncomplete URL references
(values: a Fully Qualified URL or a relative URL)