| Applet Usage Note: The unregistered version of this applet may be fully customized and used for evaluation purposes on a single computer and viewed locally. The purchased version includes the necessary security key class file and license to display multiple copies of the software on one web site. Purchasing
The Applet |
Applet Documentation
The Status Bar Message
Note: The status bar message which indicates the name of the applet and "Java by OpenCube" in the sample implementation above is customizable using the "onsbtext" and "offsbtext" parameters. See the parameter list below for more information on customizing the Status Bar Text.
Notes Regarding Java
Note: Some versions of Internet Explorer and Netscape, depending on the platform, (primarily the Beta IE 4.0, IE 3.02 and Netscape 4.01) will not be able to view this and most other applets locally when the class files, images, or html are NOT located in the same folder (usually image based or text file reading applets). If this is the case we recommend using IE 3.0 - 3.01, Netscape 2.0 - 3.01 or the Microsoft Applet Viewer which is included in the JDK. Note: This bug will not be present once the applet is located on the internet and will work under all browser / platform scenarios.
Required Class Files
This applet uses multiple class files (included with the download), the main class file: OCVscroll.class must be referenced by the applet tag. The other support class files must be located in the same folder as the main class file in order for the applet to run. The required class files are: OCVscroll.class, occcolor.class, ocfontc.class, ocwordw.class, preskey.class
Applet Tag Template
Online Documentation at www.opencube.com
Receiving Technical Support:
If you are having trouble customizing the applet or cannot get the applet to function you may contact OpenCube by phone or e-mail at 207-947-1955, or support@opencube.com. When contacting support by e-mail please include any error messages you received and an explanation of the problem. If you have already customized your tag please e-mail the HTML document which includes the tag and any support files such as images that the applet uses and we will correct the problem and e-mail the working tag with your page back to you.
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 applet tag information used in the sample 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 - "textcolor3" would define the text color for the fourth message, etc., etc.
The Applet Parameters
The Applet
Parameter 1
Attribute: Copyright notice.
param name="Notice"
value="Smooth Scroll Up II, Copyright (c) 1998, OpenCube
Inc."
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: Default Status Bar Text when mouse is over
applet
NOTE: The unregistered version does not allow for the
customization of this paramter.
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 5
Attribute: Default Status Bar Text when mouse is off
applet
NOTE: The unregistered version does not allow for the
customization of this paramter.
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 Scrolling Messages
Parameter 6
Attribute: Message
param name="desc0" - "descN"
value=X, where X is the message to be scrolled
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 break use a space character " ".
Parameter 7
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 8
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 9
Attribute: Default Font
param name="font"
Value = Font Face, Style, Size, Each value must be separated by a
comma and appear in the correct order (font face, style, and
size) The Allowable font Java face values are Helvetica,
TimesRoman, Courier, Dialog, or DialogInput. The allowable style
options are plain, bold, or italic.
DEFAULT: Helvetica, plain, 12
Parameter 10
Attribute: Specific Font
param name="font0" - "fontN"
Value = Font Face, Style, Size, Each value must be separated by a
comma and appear in the correct order (font face, style, and
size) The Allowable font Java face values are Helvetica,
TimesRoman, Courier, Dialog, or DialogInput. The allowable style
options are plain, bold, or italic.
DEFAULT: Helvetica, plain, 12
Parameter 11
Attribute: Default Text Allignment
param name="halign"
Value = left, center, or right
Parameter 12
Attribute: Specific Text Allignment
param name="halign0" - "halignN"
Value = left, center or right
Parameter 13
Attribute: Left and Right Margin Width
param name="lrmargin"
Value = X, Where X is the width of the right and left margins.
Parameter 14
Attribute: Specific Message Pause Times
param name = "delay0" - "delayN"
value="X", where X is the pause time in milliseconds
(1000 = 1 second) for a message when it reaches the top of the
applet space, a value of 0 (the default) forces the messages to
continually scroll with no pause.
DEFAULT: 0
Parameter 15
Attribute: Automatically Size the Starting Position of
the following Message.
param name="sizepause0" -
"sizepauseN"
Value = Start, End, Fit, <none>: The available auto fit
settings will automatically size a message to fit the applet
height by placing enough blank space after the message or
messages such that the following message will be placed just out
of view. To auto fit a single message simply set the value for
the message to "fit". To auto fit multiple message set
the first message to "start" and the ending message to
"end".
Messages that act as URL Links
Parameter 16
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 17
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.
Setting this value to applet forces the document to load within
the applet itself
"_self" show in the current frame
"_parent" show in the parent frame
"_top" show in the top-most 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 18
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.
Setting this value to applet forces the document to load within
the applet itself
"_self" show in the current frame
"_parent" show in the parent frame
"_top" show in the top-most 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 19
Attribute: Highlight Color
param name= "hlcolor"
Value=r,g,b or #000000 - #FFFFFF - See above for more information
on defining colors.
DEFAULT: Blue
Smooth Scroll Up II, © 1998, OpenCube Inc.