JSite Applet Parameters
JSite provides default values for all of its parameters so that the applet can be invoked without specifying any <param> tags at all.
This default implementation can be customized by setting the following parameters. Most are general values ultilized by JDoc as well. These can be set either in the <applet> tag itself or in a Site.web file as described below.
Parameter | Default Value | Comments |
resolutions | 1600x1200, 1024x768, 832x624, 800x600, 640x480 | Supported screen resolutions. If default values are modified, set corresponding value for parameters marked with*. Note: These resolutions are explicitly supported because they all have the same aspect ratio (1.33) and they can thus be conviently scaled without introducing distortion in proportions. The resolution-detection routine will force other resolutions the to next lower value of the width parameter. Thus, if a resolution of 1152x870 is detected, the screen resolution parameter will be set to 1024x768. |
resFactors* | 1.56f, 1.00f, 0.812f, 0.781f, 0.625f | resFactor = screenWidth (in pixels)/1024. Note that the f after the floating point value is required by Java. |
baseFontSizes* | 28, 18, 15, 14, 11 | The base Java font size for corresponding screen resolution. |
captionFontSizes* | 19, 12, 10, 10, 9 | The default caption font size (e.g.., used in image captions). |
platforms | Win NT, Win 95, Win 3.1, Mac PPC, Mac 68K | Supported (hardware/operating system) platforms. |
browsers | IE3, IE4, NN3, NN4 | Supported browsers (IEx, Internet Explorer, Version x; NNx, Netscape Navigator, Version x) |
baseFont | Helvetica | Specify one of the following currently-supported Java fonts: Helvetica, Courier, TimesRoman, Dialog. |
defaultBullet | images/disc.gif (solid circle) | Can be set to any bitmapped image. Specify absolute URL or path relative to file containing the <applet> tag. |
defaultBulletType | The <ul type=...> value which will be interpreted as the bullet character specified by the defaultBullet variable. E.g., if type is set to square, then the bullet will be that specified by the defaultBullet variable rather than the square bullet character. No default is set. | |
defaultLinkColor** | #0000FF; (blue) | |
defaultLinkStyle | 4 (underlined) | Allowed values: 0, plain text; 1, bold; 2, italic; 3, bold italic; 4, underlined; 5, bold underlined; 6, italic underlined; 7, bold italic underlined. |
defaultHintColor** | #FFFF00; (yellow) | Default background color for "hint" displayed when mouse enters hyperlinked text or other user input element. |
defaultAccentColor** | #FF0000; (red) | Default color for elements such as text box ruling lines, hint text, etc. |
bulletHeightFactor | 0.6f | Bullet bitmap is scaled so that its height (and width, if map is square) is equal to bulletHeightFactor x fontheight. Note that 1) fontheight is defined by the font's fontMetrics object and is not the same as its size and 2) the f after the floating point value is required by Java. |
bulletIndentFactor | 1.2f | The indent width between the beginning of the bullet character and the beginning of subsequent text. Note that the f after the floating point value is required by Java. |
addaboveFactor | 0.4f | By default, interparagraph spacing is set equal to the value of the font's fontheight parameter (this can be overridden in the <p> and <ul> tags by using the nonebetween attribute). The addaboveFactor determines what fraction of this amount is added above the paragraph. The remainder (i.e., [1 - addaboveFactor] x fontheight) is added below. |
platform*** | Set to one of the values defined by the platforms attribute (see above and Setting User Data). Default is Win 95. | |
browser*** | Set to one of the values defined by the browsers attribute (see above and Setting User Data). Default is IE 4. | |
autoLoad*** | true [JSite]; false [JDoc, JDocViewer] | When set, website parameters are automatically read from the file Site.web. If autoLoad is set but no Site.web file is found in the directory containing the applet tag, no action is taken. By default, autoLoad is set (i.e., true) for JSite but not for JDoc or JDocViewer. |
loadSplash*** | true, false | Setting this value allows loads a splash panel while the rest of the applet is loading. |
id*** | n | Setting this parameter to some integer value enables inter-applet communication. When an applet equipped to serve as a communications host encounters this id tag it registers itself with JSite. To become a client of this host, another applet must be deployed with an identical id tag (i.e., same n value). |
debug*** | false | When set, messages are printer to the browser's Java console when JSite or JDoc encounter certain error conditions. This is particularly useful in debugging .web files. |
*The values of this parameter correspond to those set for the resolutions parameter. | ||
**Color is specified as " #XXYYZZ;" where xx, etc., are hexadecimal values specifying the RGB color values and the bracketing # and ; characters are optional. | ||
***Must be set in applet's <param> tag rather than in a Site.web file. |
Except as noted (above***), these parameters can be set to values other than the defaults in either (or both) of two ways:
baseFont=TimesRoman
baseFontSizes=16, 15, 15, 14
Note: Any <param> tags are interpreted before the Site.web file, if present, is read, so values set using the Site.web file will override any duplicate values set using these tags.