# Typewriter Scroll

Class File Name: tscroll.class, occcolor.class, ocfontc.class, ocwordw.class ocjwkey.class Notice Tag: Typewriter Scroll, (c) 1997, OpenCube Technologies, Registered (Unique Key ID#)

Applet Tag Template

- Template based on the above implementation of the applet

Information about the applet and its parameters

Required Parameters

Parameter 1 (the "notice" tag) must be included in the applet tag in order for the applet to work. Most of the parameters will default if you fail to define them, at a minimum you must include the notice tag and description parameters for you messages. Usually the easiest way to customize the applet is cut and paste the template tag and modify it to fit your web page.

Defining Colors

This applet uses a simple RGB or Hexadecimal color definition scheme. On most systems (depending on the software being used to choose a color) its easier to define a color using RGB, however since most web pages define colors using a HEX value we have allowed for both methods of color definition. To define a color using RGB use commas to separate the values such as 255,255,255 (White). To define a color using a hexadecimal value use a pound sign ('#') followed by a 6 digit hex value in the rage of 000000 - FFFFFF (e.g. #FFFFFF is equal to the color White).

Color Definition with RGB: To define a color in one of the color parameters using RGB choose a value between 0 - 255 for the red, green, and blue components separated by commas and typed out in the correct r,g,b order. Below is a sample of how a color parameter using RGB should look, the example specifies several different sample colors for the "bgcolor" parameter.

WHITE: <param name="bgcolor" value="255,255,255">
GREEN: <param name="bgcolor" value="0,255,0">
BLACK: <param name="bgcolor" value="0,0,0">
YELLOW: <param name="bgcolor" value="255,255,0">
OFF WHITE: <param name="bgcolor" value="240,239,234">

The best way to choose the exact color you are looking for without having to guess the numbers is to access your systems Color Picker. Color Pickers usually allow you to drag the mouse over a rainbow type color grid to select a color, and show you the appropriate RGB values. In windows the Color Picker is accessible through MS Paint as well as a majority of the popular Imaging and HTML Authoring Software.

Defining Multiple Attributes with the same parameter name

Parameters used to customize a specific message are indicated using a range, such as "desc0" - "descN". To define a parameter for a specific message (available when noted as above), use "textcolor0" to define, in this case, the text color for the first message - "textcolor1" would define the text color for the second message, etc., etc.

The Applet Parameters

The Applet

Parameter 1
Attribute: Copyright notice.
param name="Notice"
value="Typewriter Scroll, (c) 1997, OpenCube Technologies, Registered (Unique Key ID#)"
Note: This must be included for the applet to work.

Parameter 2
Attribute: Background Color
param name= "bgcolor"
Value=r,g,b or #000000 - #FFFFFF - See above for more information on defining colors.
DEFAULT: WHITE

Parameter 3
Attribute: Message Scroll Delay
param name = "scrolldelay"
value="X", where X is the delay time in milliseconds between animation frames.
DEFAULT: 25

Parameter 4
Attribute: Type Effect Delay
param name = "typedelay"
value="X", where X is the delay time in milliseconds between typed characters.
DEFAULT: 50

Parameter 5
Attribute: Ending Message Delay Time
param name = "enddelay"
value="X", where X is the delay time in milliseconds for the last message to be displayed. Once this delay time has expired the message scrolls out of view and the type effects starts over.
DEFAULT: 2000 (2 seconds)

Parameter 6
Attribute: Default Status Bar Text when mouse is over applet
param name = "onsbtext"
value="X", where X is the message to appear in the status bar when the mouse is over the applet but not over a URL link.
DEFAULT: "OpenCube - Smooth Scroll Up II"

Parameter 7
Attribute: Default Status Bar Text when mouse is off applet
param name = "offsbtext"
value="X", where X is the message to appear in the status bar when the mouse is not over the applet.
DEFAULT: "Java By Opencube"

The Typing Messages

Parameter 8
Attribute: Message
param name="desc0" - "descN"
value=X, where X is the message to be typed
Note: Messages longer than the width of the applet are automatically put in a multi-line format. To use a message as a blank line break use a space character " ".

Parameter 9
Attribute: Type Message
param name= "textcolor"
Value=true or false, True = yes display the message with a typewriter effect. false = simply scroll the message into view without using a type effect. This parameter works good for scrolling titles into view then typing their associated message. Note: If the first message is set to be typed the effect start with the message already positioned, if the first message is set not to be typed the message will scroll into view from off the screen.
DEFAULT: true

Parameter 10
Attribute: Default Text Color
param name= "textcolor"
Value=r,g,b or #000000 - #FFFFFF - See above for more information on defining colors.
DEFAULT: BLACK

Parameter 11
Attribute: Specific Text Color
param name= "textcolor0" - "textcolorN"
Value=r,g,b or #000000 - #FFFFFF - See above for more information on defining colors.
DEFAULT: BLACK

Parameter 12
Attribute: Default Message Font Size
param name="size"
value="X", where X is the default size of all message fonts.
DEFAULT: 14

Parameter 13
Attribute: Specific Message Font Size
param name="size0" - "sizeN"
value="X", where X is the specific size of a message font.

Parameter 14
Attribute: Default Message Font Name
param name="fontface"
value="X", where X is the name of a standard Java Font (Dialog, Helvetica, TimesRoman, Courier, Symbol)
DEFAULT: "Helvetical"

Parameter 15
Attribute: Specific Message Font Name
param name="fontface0" - "fontfaceN"
value="X", where X is the name of a standard Java Font (Dialog, Helvetica, TimesRoman, Courier, Symbol)

Parameter 16
Attribute: Default Font Style
param name="style"
value= bold, italic, bolditalic, plain
DEFAULT: plain

Parameter 17
Attribute: Specific Font Style
param name="style0" - "styleN"
value= bold, italic, bolditalic, plain

Parameter 18
Attribute: Default Center Text
param name="centertext"
Value = true or false. true = yes center text, false = no left justify text
DEFAULT: False

Parameter 19
Attribute: Specific Center Text
param name="centertext0" - "centertextN"
Value = true or false. true = yes center text, false = no left justify text

Parameter 20
Attribute: Left and Right Margin Width
param name="lrmargins"
Value = X, Where X is the width of the right and left margins.
DEFAULT: 5

Parameter 21
Attribute: Automatically Size the Starting Position of the following Message.
param name="sizepause0" - "sizepauseN"
Value=0 or 1 or 2: 0 = do nothing, this is the default value, 1 = Identifies a message as the starting message to be automatically sized to fit applet area, 2 = Identifies the ending message to be sized. To automatically size messages that span multiple description tags, simply set the starting message to 1 and the ending message to 2 with this parameter. For example if you wanted your desc2 and desc3 tags to scroll up the screen and your desc3 tag to start scrolling only after desc2 started off the screen you would simply identify the desc2 as a start sizing message by setting "sizepuase2" = 1 and define desc3 as the end sizing message with "sizepause3" = 2. To size only one message to fit the applet height only identify that message as a ending message and do not define a starting message (e.g. "sizepause2" = 2, forces the desc2 message to scroll all the way to the top of the applet before desc3 start scrolling into view.)

Parameter 22
Attribute: Bottom Margin
param name="bottom margin"
Value = X, Where X is the distance from the bottom border of the applet to the message being typed.
DEFAULT: 5

Messages that act as URL Links

Parameter 23
Attribute: Destination URL Link
param name="desturl0" - "desturlN"
Value = X, Where X is the location of the document to load relative to the location of the HTML document containing the applet (e.g. if the HTML page containing the applet is located at http://www.opencube.com and the document to load is located at http://www.opencube.com/myhtml/mydoc.htm then the desturlN value would be "myhtml/mydoc.htm"). Note: The desturlN tags directly correspond to the descN tags, setting desturl0 will add a link to the first message description identified in desc0, desturl1 uses a link with desc1, etc.

Parameter 24
Attribute: Default Load Destination URL Link Where? (Frame Targeting)
param name="loadwhere"
The "loadwhere" tag specifies where the document specified in the "URL" value should be loaded. The default is "_self". A value equal to the name (case sensitive) of a frame will load the document in that frame.
"_parent" show in the parent frame
"_top" show in the top-most frame
"_self" show in the current frame
"_blank" show in a new unnamed top-level window
"name" show in a new top-level window named name
"frame name" show in the frame named frame name

Note: When targeting a frame location with the name of the frame make certain that the case and names are typed identically. If the applet cannot find the frame the document will be loaded in a new window.

Parameter 25
Attribute: Specific Load Destination URL Link Where? (Frame Targeting)
param name="loadwhere0" - "loadwhereN"
The "loadwhere" tag specifies where the document specified in the "URL" value should be loaded. The default is "_self". A value equal to the name (case sensitive) of a frame will load the document in that frame.
"_parent" show in the parent frame
"_top" show in the top-most frame
"_self" show in the current frame
"_blank" show in a new unnamed top-level window
"name" show in a new top-level window named name
"frame name" show in the frame named frame name

Note: When targeting a frame location with the name of the frame make certain that the case and names are typed identically. If the applet cannot find the frame the document will be loaded in a new window.

Parameter 26
Attribute: Highlight Color
param name= "hlcolor"
Value=r,g,b or #000000 - #FFFFFF - See above for more information on defining colors.
DEFAULT: Blue

Typewriter Scroll, © 1997, OpenCube Technologies