Required Parameters

width
Change the width to indicate the size of the applet.

height
Change the height to indicate the size of the applet.

numberOfLines
This is the number of lines to display.

background
This is the background color of the applet. There are three different ways to specify this parameter: color name, by RGB color values, or by special multi-colored fade background name:

To use a single colored background, use one of the following colors below:
  • black
  • blue
  • cyan
  • darkGray
  • gray
  • green
  • lightGray
  • magenta
  • orange
  • pink
  • red
  • white
  • yellow
 

Or,  you can specify the red, green, and blue values for a unique RGB color: specify three number from 0 - 255 separated by commas.

For example code this for the color red:
<param name=background value="255,0,0">

Or you can use one of the special multi-colored fade backgrounds, use one the following parameters: special1 - black fade to green special2 - light blue fade to light green special3 - black fade to blue special4 - red fade to yellow special5 - black fade to red

For example, to use the 'red fade to yellow' background (special4), code the background parameter as follows:
<param name=background value="special4">

scrollDelay
This controls the speed of the scroll. The lower the number, the faster it scrolls.

lineSpace
This controls how much space is between each line.

linkFrame
This controls which HTML frame to use when a hyperlink is clicked. Use this parameter like the HTML Target attribute. Standard HTML frame "rules" apply.

  _self - load in current frame.
  _parent - load in parent frame.
  _top - load in topmost frame.
  _blank - load in new unnamed top-level frame.
  <other> - show in new top-level window named <other>.

linkColor
This controls the color of the hyperlinked line when the mouse is placed over it. Colors supported are the same as background.

manualPause
This is the amount of time the scroll will pause when the applet is clicked on. To resume scrolling, click again. Entered in milliseconds - 5000 is 5 seconds.

linkClick
This is the number of times to click a hyperlinked line. Use either 1 or 2, for a single or double click.

copyright
The copyright parameter must be included or the scroller will not function properly. The value for this parameter must be:

ConsultScroll Vertical Text Scroller v2.0 Copyright (c) 1998, consulting.com Inc.


Required Default Parameters

sizeDefault
This is the default text size for each line.

lineDefault
This is the default text that is displayed for each line (usually the default is blank, and this is overriden).

colorDefault
This is the default color for each line. Colors supported are the same as background.

fontDefault
This is the default font for all lines. Use one of the following below:

styleDefault
This is the default font style for all lines. Use one of the following below:

linkDefault
This is the default URL for all lines (the default is usually blank). Enter as a standard URL:

http://www.consultcom.com/

pauseValueDefault
This is the default pause value for all line (the default is usually zero).

lineOffsetDefault
This is the default starting position for all lines (starting at position zero).


Optional Parameters 

With the exception of the following two parameters, these are basically the same as the default parameters. Just replace 'Default' with the line number, for example:

To change the default text for the first line, use the parameter 'line1':
<param name=line1 value="ConsultScroll Vertical Text Scroller">

The following optional parameters are only needed if you want the text displayed by the scroller to come from a text file. To see an example of this, take a look at Demo2.htm


Text File Input 

This parameter identifies the name of the text file. Make sure the text file is spelled correctly, upper and lower case matter. Put the text file in the same directory as the class file: VertTextScroller.class.

For example, if your text file is named Demo3.txt, enter the following parameter:
<param name=textFile value="Demo3.txt">

insertTextFile
This parameter controls where the applet will place the lines read from the text file. There are two different ways to specify this parameter:

Fixed number of lines from a input file:

Use this option if you want a fixed number of lines from the text file to be displayed in the scroller. You must use the numberOfLines parameter to tell the applet the total number of lines to display (the total number of lines is the sum of all the lines in the text file plus the lines inputted from HTML param tags). This option can merge a fixed number of lines from a text file with lines from the HTML param tags.

For example, if you want the lines in the text file to display at line 2 - line 7 of the scroller, enter the following parameter:
<param name=insertTextFile value="2-7"> (enter a number, a dash, then a number, no spaces)

Variable (unlimited) number of lines from a input file:

This option will display all the lines from the text file in the scroller, regardless of how many lines are in the text file. Enter a number that tells the applet where the lines will be placed in the scroller. Because the text file can have a variable number of lines, the numberOfLines parameter is not used, and will be ignored. With this option, you can also input lines using the HTML param tags, but these lines must display ABOVE the lines from the text file (for example, the first line can come from a HTML param tag, and all the rest from the text file).

For example, if you want the lines in the text file to display starting at line 1 of the scroller, enter the following parameter:
<param name=insertTextFile value="1"> (enter just a number)