In the following list, the parameters marked (A) provide
general settings for the Banners Applet. Those marked (A/M)
apply to either the applet or specific messages. The parameter marked
(M) is specifically for messages. Message parameter
definitions take the form {parameterName=value}. They appear after
the text of the message and before the message separator (if any).
See the HTML example for specifics.
(Source: http://www.digiville.com/webmagic/aceBanners/parameters.htm)
Parameter |
Default |
Description |
|---|---|---|
|
messages |
"Banners" |
(A) Defines one or more messages to display. This parameter is provided as a string, enclosed in quotes. You specify messages by placing all of them between a single pair of quotes and demarking each with the separator character. The default message separator is the vertical bar ("|") character. If the text of a message contains multiple lines, they must be separated with the newline ("/n") character. The text of each message can be followed by a list of message parameters, in the form {parameterName=value}. |
|
msgFile |
-- |
(A) An alternate way to specify messages, this parameter specifies the URL of a file containing message text formatted as described in the messages parameter. The text in this file may include multiple messages and message parameters. Using this mechanism allows you to update the contents of an Banners applet without editing its HTML page. If you supply a value for this parameter, it overrides the messages parameter. The file must reside in either the directory containing the HTML document specifying the applet or a subdirectory below it. |
|
reloadInterval |
0 |
(A) Defines how often to reload the message file specified by the msgFile parameter. When the value is greater than 0, Banners updates its messages from the file every reloadInterval seconds. (This parameter has no meaning if no msgFile parameter is specified). |
|
separator |
"|" |
(A) Character or characters used to demark individual messages in the messages or msgFile text strings. |
|
font |
TimesRoman |
(A/M) Message font. Valid values for this parameter are Dialog, TimesRoman, Helvetica, Courier, and Symbol. Individual messages may override this parameter to display a different font. |
|
size |
36 |
(A/M) Font size of messages, in points. Individual messages may override this parameter to display a different font size. |
|
style |
plain |
(A/M) Font style of messages. Valid values for this parameter are plain, bold, italic, and boldItalic. Individual messages may override this parameter to display a different font style. |
|
textColor |
black |
(A/M) Color of messages. This value can be one of the predefined color names black, blue, cyan, darkGray, gray, green, lightGray, magenta, orange, pink, red, white, and yellow. Users familiar with hexadecimal numbers can also specify colors as hex values representing a Red-Green-Blue mix. Hex values take the form RRGGBB, with 000000 for black, FFFFFF for white, and FF0000 for red. Individual messages may override this parameter to display a different text color. |
|
shadowColor |
-- |
(A/M) Shadow color of messages. The default provides no shadow. See the textColor parameter for valid values. Individual messages may override this parameter to display a different shadow color. |
|
shadowDepth |
2 |
(A/M) Standard shadow depth of messages. The value provided specifies the number of pixels that the shadow is offset from the text. Individual messages may override this parameter to display a different shadow depth. |
|
bgColor |
(page color) |
(A/M) Background color of messages. See the textColor parameter for valid color values. Individual messages may override this parameter to display a different background color or a background image. |
|
fps |
15 |
(A/M) Frame rate for messages. This value defines how many times a message moves each second. Actual speed depends on the speed of the machine displaying the applet, although it will never be faster than this value. Individual messages may override this parameter to define a different frame rate. |
|
cpf |
2 |
(A/M) Frame change amount for animated messages. This value affects the smoothness of the animation, defining how much a message changes for each frame. This value specifies either pixels, points, or colors, depending on the animation style defined for the enter and exit parameters; a smaller value provides smoother animation. Individual messages may override this parameter to define a different frame change rate. |
|
enter |
scrollLeft |
(A/M) Entry animation style for messages. This parameter defines how messages animate on their way into a window. See Animation styles for a list of values defined for this parameter. Individual messages may override this parameter to define a different entry animation style. |
|
exit |
scrollLeft |
(A/M) Exit animation style for messages. This parameter defines how messages animate on their way out of a window. See Animation styles for a list of values defined for this parameter. Individual messages may override this parameter to define a different entry animation style. |
|
pause |
0 |
(A/M) Time (in seconds) to display all message text between enter and exit animations. This parameter can take fractional values expressed as decimals--e.g., 0.25, 0.5, etc. Individual messages may override this parameter to define a different message display time. |
|
align |
center |
(A/M) Alignment of message text. Valid values for this parameter are left, right, top, bottom, center. The alignment must be appropriate for the animation style; for example, if enter=left, then align=left does not make sense. Individual messages may override this parameter to define a different effect style. |
|
effect |
none |
(A/M) Effect to apply to all messages. See Effect styles for a list of values defined for this parameter. Individual messages may override this parameter to define a different effect style. |
|
emboss |
false |
(A/M) Standard embossing style for all animating messages. Embossing gives a slightly raised, 3D look to message text. Valid values for this parameter are true or false. Specifying true overrides the shadow effect. Individual messages may override this parameter to define their own embossing effect. |
|
borderWidth |
0 |
(A) Width of border around the Banners window, in pixels. The default value specifies no border. |
|
borderColor |
-- |
(A) Color of border around the Banners window. See the textColor parameter for valid color values. |
|
bgImage |
none |
(A/M) The URL of a GIF or JPEG file providing a tiled background image for messages. Setting this parameter overrides bgColor param. Individual messages may override this parameter to define their own background image or color. |
|
bgEnter |
none |
(A/M) Entry animation style for the background color or image. Valid values for this parameter are squeeze and none. Individual messages may override this parameter to define their own background entry animation style. |
|
bgExit |
none |
(A/M) Exit animation style for the background color or image. Valid values for this parameter are squeeze and none. Individual messages may override this parameter to define their own background exit animation style. |
|
URL |
-- |
(A/M) The URL of a file to load in the browser when the user clicks on the message. Individual messages may override this parameter to define URLs for their own files. |
|
repeat |
1 |
(M) Number of times to repeat this message before displaying next. |
The following animation styles are used for both the enter and exit parameters, which may be defined for the applet and overridden for specific messages. The enter parameter controls how messages are animated as they enter the Banners window. The exit parameter controls how messages are animated as they leave the window.
Style |
Enter effect |
Exit effect |
|---|---|---|
|
none |
Message text simply appears. |
Message text simply disappears. |
|
scrollLeft |
Moves message text from left to right at the pixel rate specified by the cpf parameter. |
Same. |
|
scrollRight |
Moves message text from right to left at the pixel rate specified by the cpf parameter. |
Same. |
|
scrollUp |
Moves message text from bottom to top at the pixel rate specified by the cpf parameter. |
Same. |
|
scrollDown |
Moves message text from top to bottom at the pixel rate specified by the cpf parameter. |
Same. |
|
wipeRight |
Progressively reveals message text from left to right at the pixel rate specified by the cpf parameter. |
Progressively conceals message text from left to right at the pixel rate specified by the cpf parameter. |
|
wipeLeft |
Progressively reveals message text from right to left at the pixel rate specified by the cpf parameter. |
Progressively conceals message text from right to left at the pixel rate specified by the cpf parameter. |
|
wipeUp |
Progressively reveals message text from bottom to top at the pixel rate specified by the cpf parameter. |
Progressively conceals message text from bottom to top at the pixel rate specified by the cpf parameter. |
|
wipeDown |
Progressively reveals message text from top to bottom at the pixel rate specified by the cpf parameter. |
Progressively conceals message text from top to bottom at the pixel rate specified by the cpf parameter. |
|
zoomIn |
Scales up the point size of the message text from 1 point to the value specified by the size parameter. Scaling occurs at the point rate specified by the cpf parameter. |
Scales up the point size of the message text from the value specified by the size parameter to 100 points. Scaling occurs at the point rate specified by the cpf parameter. |
|
zoomOut |
Scales down the point size of the message text from 100 points to the values specified by the size parameter. Scaling occurs at the point rate specified by the cpf parameter. |
Scales down the point size of the message text from the value specified by the size parameter to 1 point. Scaling occurs at the point rate specified by the cpf parameter. |
|
fade |
Fades message text from the value of bgColor to the value of textColor, incrementing the color value by cpf colors each frame. This effect works best with > 256 color displays. |
Fades message text from the textColor to the bgColor. |
The following values can be used for the effects parameter. This parameter can be defined for Banners in general and overridden for specific Banners messages.
Effect |
Description |
|---|---|
|
none |
No text effect. |
|
color |
Randomly changes the color of message text at the pixel rate specified by the cpf parameter. |