Parameters of 3D Scroll
(A companion
parameters checking applet is provided)
Text and It's Appearance:
ScrollText:
The text to scroll over screen.
For very long text string, split to multiple lines. Use scrolltext1,
scrolltext2, etc, up to 50.
Default:
none.
If the input strings for ScrollText
starts with a 's' (lower case), 3D Scroll will take it as
a mark for leading blanks.
The 's' will not show on the output. For example:
<param name="scrollText"
value="s 3 leading blanks">
The output will be "
3 leading blank".
The reason for the 's'
is that some browsers take away the leading blanks of applet's input parameters.
See Example 1 Example
2 for further details.
TextFile:
The name of an ascii text
file for scrolling text. (path relative to the applet code's directory).
When it is coded, the above parameter ScrollText will be ignored.
TextColor:
Hex triplet value in the order
of RGB. See Color Table.
Default
is black (0).
Fontname:
The name of the font used
to display the scrolling text. Possible values:
"Dialog",
"TimesRoman", "Helvetica", "Courier"
Default
is "Helvetica".
See Text
and 3D Effect shows an easy way to import fonts.
FontSize:
The point size of the font.
Default is 14.
FontStyle:
The style of the font. Can
be:
"PLAIN", "BOLD",
"ITALIC", "BOLD ITALIC".
Default
is PLAIN.
Special Effects:
FontEffect:
For making 3d font or other
special font effects. It's format is:
"effect_and_smoothing
smoothing_factor"
"effect_and_smoothing"
can be:
3D :
applying 3d effects to fonts. The result 3D font (based on the input
font style) and it's surrounding pixels will be smoothed (averaged) with
the surrounding (FontBackColor) colors.
3D smoothfont :
(3D) fonts (but not it's surrounding pixels) will be smoothed with
the surrounding (FontBackColor) colors.
Try this one to see the subtle difference
between above one and this one.
3D nosmoothing :
the generated 3d font will not be smoothed.
3D Example,
Apply 3D effect contain examples.
Outline:
making an outline around fonts, the fonts will be transparent. The outline
color is FrontShadowColor.
OutlineFont :
making an outline around fonts, The outline color is FrontShadowColor,
and the text will be draw with TextColor.
See Example.
Smooth :
smooth the edge of fonts with the background color as coded in FontBackColor.
The surrounding pixels will also
be smoothed.
Smooth smoothfont :
smooth the edge of the font with the background color as coded in FontBackColor.
Surrounding pixels will not be
smoothed (made transparent).
Transparent:
background of the text image will be made transparent, and the size of
the image may be reduced so that it only contains the none transparent
part of the original image. TextColor
will not be applied. Can be used to
make a FrontImage's background transparent.
Transparent notrim
: same as above except that image size will not be reduced.
There's no
default value for "effect".
"smoothing_factor":
A number (must be greater
than zero and less than 0.9999). used as a weight in the smoothing
algorithm. If this number is close to 1, then the smoothed result will
be close to nosmoothing.
The smaller the number, the soft the result will be. Smoothing_factor
is not used when FontSize is less than 16.
Example:
<param name="fonteffect"
value="3d 0.7">
3D effect will be applied
to fonts, and smoothed. The weight is 0.7;
<param name="fonteffect"
value="outline 0.3">
Font outline will be generated
(font itself is invisible).
The remain parameters will
be ignored.
<param name="fonteffect"
value="smooth">
Fonts will be smoothed against
coded FontBackColor.
Default
for FontEffect: Do nothing.
See Text
and 3D Effects and Example 3 for more info.
FontBackColor:
Shadow:
An integer value (>=0 and
<=10). If coded, a drop shadow will be added to every character
of the scrolling text. Try shadow=2 and dark shadow color
(see below). The value
of Shadow is the distance between the shadow and the font.
Default:
0 (no shadow);
ShadowColor:
The drop shadow color. Hex
triplet RGB value. See Color Table.
Default:
None.
This parameter is an important
factor in applying 3D Effects or other special
effects.
Engraved
Style contains examples.
FrontShadow:
An integer value (>=0 and
<=10). If coded, a forward drop shadow will be added to every character
of the scrolling text. The
value of Shadow is the distance between the FrontShadow and
the font.
Default:
0 (no front shadow);
Set this value and "shadow"
value to 1. With proper shadowColor and FrontShadowColor (see below), a
visual effects similar to engraved/embrossed font can be created.
FrontShadowColor:
FontGap:
An integer (>=0).
Used to increase the normal gap between fonts.
Images and Text Images:
FrontImage:
Name of a gif, jpg or bmp
file to be used as the scrolling object. (path relative to the applet code's
directory). When it is coded, the parameter ScrollText
and TextFile will be ignored.
See FrontImageIs (below) for more info.
Default:
None.
FrontImageIs:
Possible value can be:
text:
the front image file will be treated as text image. 3D or other special
effects can be applied to the image. See Text
and 3D Effects for more info.
anything else:
a picture.
BackColor:
Background color. Hex RGB
value. See Color Table.
Default
is white (FFFFFF).
BackImage:
Name of a gif, jpg or bmp
file to be painted as background. (path relative to the applet code's directory).
See below drawBkImage
for options how to draw background. (currently, compressed bmp files are
not supported).
Default
none.
DrawBkImage:
Use this parameter to indicate
how the background picture will be draw. It's format is "method
x y" or "x y":
"method": as
is.
x y:
The provided picture will be tiled into the background. See below
for the meaning
of "x y".
as is:
The provided picture will only be painted once.
In case it is smaller than the applet, the unpainted area will be
filled with background color.
Default:
as is.
"x y":
A pair of integer values used
to align the background image. For example,
" 10 11" means tile BackImage into the background, start at
column number 11 and row number 12 of BackImage.
(counted from the upper left corner). Keep
in mind that all the coordinates in this applet are zero based.
Default 0
0.
Margins:
LeftMargin:
An integer, measured from
the left edge of the applet.
Default:
Frame width.
RightMargin:
An integer, measured from
the right edge of the applet.
Default:
Frame width.
TopMargin:
An integer, measured from
the top edge of the applet.
Default:
Frame width.
BottomMargin:
An integer, measured from
the bottom edge of the applet.
Default:
Frame width.
Animation:
ScrollDirection:
A character string. "vertical"
for scrolling vertically. None or any other value means scrolling
horizontally.
Delay:
An integer. time between one
frame being painted and the next. Measured in millisecond. A delay
of 1000 means 1 second.
Default:
100. (1/10th of a second).
Advance:
An integer. Pixels to advance
from one frame to the next.
Default:
3.
An advance value greater than
zero. The text or image will be moved leftwards or upwards (depending on
ScrollDirection). An advance value
smaller than zero. The text or image will be moved rightwards or downwards
(depending on ScrollDirection).
Advance=0 makes a still image.
PauseTime:
An integer. If coded and is
greater than zero, then the scrolling text will be paused after several
iteration. The pausing time will be equal to the PauseTime value.
Measured in 1/10th of a second. (see PauseLoop
and PauseAt for more info.)
Default:
0 (no pause).
PauseAt:
Indicating the location where
the scrolling text/image will be paused.
Possible value:
middle
or an integer.
middle:
the scrolling text will be paused at center of the applet.
An integer:
The (beginning of the) scrolling
text/image will be paused at the PauseAt location.
Example:
<param name="pauseAt" value="0">
In the case of scrolling left,
The scrolling text/image will be paused at the left edge of the visible
area (just before left margin). In the case of scrolling up, The
scrolling text/image will be paused at the top edge of the visible area
(just before top margin). In the case of scrolling right or down,
Only one line of pixels of the scrolling text/image will be visible (just
besides the left margin) when it is paused.
Default:
Pause at begin.
PauseLoop:
An integer. if Coded and is
greater than zero. then the scrolling text/image will be paused after every
PauseLoop iteration. If coded and is less than zero, it has
the same effect as a positive integer except, at very beginning, the scrolling
text/image will pause when it reaches the PauseAt
location.
Default:
no pause (0).
When Gap
is coded. Every time a new scrolling image/text passes the PauseAt
location, the iteration count will be increased by 1.
StartAt:
An integer value or middle.
Used to indicate the initial
position of the scrolling text/image. The interpretation of it's value
is the same as PauseAt.
Default:
start at beginning.
Miscellaneous:
Frame:
Gap:
An integer.
If not coded (or less than
0), the entire scrolling text/image will scroll over the applet (less margins).
A new iteration will not start until the old one is completely out of the
screen.
If coded and is greater or
equal to zero, then there will be a series of text/image (one after another)
scrolling across the screen. The width of the gap between adjacent objects
is the value coded here.
Default:
-1.
URL:
If coded, the applet will
act as a link to this URL.
Default:
None.
URLTarget:
The target window for loading
the above URL.
Default:
None.
Here's the complete list of
all the parameters:
Advance
Animation BackColor
BackImage Delay
DrawBkImage FontEffect
Fontname FontSize
FontStyle Frame
FrontImage FrontImageIs
FrontShadowColor
Gap Margins PauseAt
PauseLoop PauseTime
ScrollDirection ScrollText
Shadow ShadowColor
StartAt TextColor
TextFile URL
URLTarget
How to use the parameter checking applet:
To use the companion parameter
checking applet. Simply change the class name from Scroll3D
to PCheck:
HTML code for 3D Scroll:
<applet code="Scroll3D.class"
...>
<param ...>
..
</applet>
HTML code for parameter checking:
<applet code="PCheck.class"
...>
<param ...>
..
</applet>
The only change needed is shown in red.
.Change the applet size if needed.