SmartTree Menu

Applet Usage

Note: The unregistered version of this applet may be 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 multipleind copies of the software on one web site.


Purchasing The Applet

This software is available as part of Web Effects (Navigation and Gold Collections), for more information visit the Web Effects page or contact OpenCube at 207-947-1955

 

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 (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 on the internet, and the applet will function correctly under all browser / platform scenarios.

Note: Due to a bug in Netscape and IE, Gif Images can sometimes be rendered inappropriately depending on the the platform and browser being used. Netscape typically displays the gif image with a spotty effect. This applet does use special code to work around the bug, however cannot guarantee to resolve the problem 100% of the time and may instead cause part of the image to be cropped. When encountering this issue try saving the image with a different image editor or use a different format.

 

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 appropriately please 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 and are having trouble 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

The Required Parameters:

Parameter 1, the notice tag, must be included in the applet tag in order for the applet to work. The only other required parameters are at least on main menu description.

 

Color Definition:

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 One Parameter:

Single parameters used to customize more than one item such as specific images or messages are done so using a range, such as "imagefile0" - "imagefileN". To define a parameter for a specific item (available when noted as above), use "imagefile0" to define, in this case, the location of the first image file - "imagefile3" would define the fourth image file to use, etc., etc.

 

The Applet Coordinate System:

The origin of the applets coordinate system is located at the upper left corner of the applet. The x (horizontal) coordinate starts at the left border with 0 and goes as far to the right as the applet is wide (defined with the width tag - see above). The y (vertical) coordinate starts at the top of the applet with 0 and goes down as far as the applet is high (defined with the height tag - see above).

 

The Applet Parameters

 

General Settings

Parameter 1
Attribute: Copyright notice.
param name="Notice"
value="SmartTree Menu, Copyright (c) 1998, OpenCube Inc."
Note: This must be included for the applet to work.

Parameter 2
Attribute: Applet Background Color
param name = "bgcolor"
Value = R,G,B, Where R,G,B are the red, green, and blue components of the applets background color.
DEFAULT: 255,255,255

Parameter 3
Attribute: Status bar text when the mouse is over the applet.
param name = "onsbtext"
Value = X, Where X is the message to be displayed in the status bar when the mouse is over the applet area.
DEFAULT: "OpenCube - SmartTree Menu"

Parameter 4
Attribute: Status bar text when the mouse is not on applet.
param name = "offsbtext"
Value = X, Where X is the message to be displayed in the status bar when the mouse is not located over the applet area.
DEFAULT: "Java by OpenCube"

Parameter 5
Attribute: Main Menu and Sub Menu Item heights
param name = "itemheight"
Value = X, Where X is the height of each main menu and sub menu link area.  If this parameter is left absent from your tag the height will be automatically calculated according to the font sizes being used in the main menus and sub menus.
DEFAULT: None

 

Loading Images Message

Parameter 6
Attribute: Loading Images Message
param name = "loadmsg"
value="X", where X is the message to appear in the applet area while the images are loading.
DEFAULT: Loading Images...

Parameter 7
Attribute: Loading Images Message Color
param name = "loadmsgcolor"
Value=r,g,b or #000000 - #FFFFFF - See above for more information on defining colors.
DEFAULT: 255,255,255

Parameter 8
Attribute: Loading Images Message Font
param name = "loadfont"
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 Java font face values are Helvetica, TimesRoman, Courier, Dialog, or DialogInput. The allowable style options are plain, bold, bolditalic, or italic.
DEFAULT: Helvetica, plain, 12

 

Main Menu Description Settings

Parameter 9
Attribute: Main Menu Descriptions
param name = "maindesc0" - "maindescN"
Value = Icon ID | Description or Description, Where description is the description for each main menu link. Use an icon id then a vertical bar separator - | - followed by the menus description to associate an icon with the menu link. To just use a message without an icon for the menu area leave the icon ID and vertical bar out of the value. For more information on icons see the Icon Images section.

Parameter 10
Attribute: Main Font
param name = "mainfont"
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 Java font face values are Helvetica, TimesRoman, Courier, Dialog, or DialogInput. The allowable style options are plain, bold, bolditalic, or italic.
DEFAULT: Helvetica, plain, 12

Parameter 11
Attribute: Underline Main Menu Text
param name = "underlinemaintext"
Value=true or false
DEFAULT: false

Parameter 12
Attribute: Main Text Box Area - Left Margin
param name = "mainlmargin"
Value=X Where X = the distance from the left edge of the applet to the beginning of the main menu box area.
DEFAULT: 5

Parameter 13
Attribute: Main Text Box Area - Right Margin
param name = "mainrmargin"
Value=X Where X = the distance from the right edge of the applet minus the scroll bar width to the end of the main menu box area.
DEFAULT: 5

Parameter 14
Attribute: Main Text - Indent
param name = "maintextindent"
Value=X Where X = the distance from the beginning of the main menu box area to the the beginning of the main menu text descriptions.
DEFAULT: 5

 

Main Menu Color Settings

Parameter 15
Attribute: Main Menu Text Color
param name = "maintextcolor"
Value=r,g,b or #000000 - #FFFFFF - See above for more information on defining colors.
DEFAULT: 255,255,255

Parameter 16
Attribute: Main Menu Text Highlight Color
param name = "maintexthlcolor"
Value=r,g,b or #000000 - #FFFFFF - See above for more information on defining colors.
DEFAULT: 255,0,0

Parameter 17
Attribute: Main Menu Box Color
param name = "mainboxcolor"
Value=r,g,b or #000000 - #FFFFFF - See above for more information on defining colors. In-order to force the applet to not draw main menu boxes leave this parameter undefined.
DEFAULT: none

Parameter 18
Attribute: Main Menu Outline Color
param name = "mainoutcolor"
Value=r,g,b or #000000 - #FFFFFF - See above for more information on defining colors. In-order to force the applet to not draw main menu outlines leave this parameter undefined.
DEFAULT: none

Parameter 19
Attribute: Main Menu Outline Color
param name = "mainhloutcolor"
Value=r,g,b or #000000 - #FFFFFF - See above for more information on defining colors. In-order to force the applet to not draw main menu highlight outlines leave this parameter undefined.
DEFAULT: none

 

Sub Menu Description Settings

Parameter 20
Attribute: Sub Menu Descriptions
param name = "subdesc0-0" - "subdescN-N"
Value = Icon ID | Description or Description, Where description is the description for each sub menu link. Use an icon id then a vertical bar separator - | - followed by the menus description to associate an icon with the menu link. To just use a message without an icon for the menu area leave the icon ID and vertical bar out of the value. For more information on icons see the Icon Images section.

Parameter 21
Attribute: Sub Font
param name = "subfont"
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 Java font face values are Helvetica, TimesRoman, Courier, Dialog, or DialogInput. The allowable style options are plain, bold, bolditalic, or italic.
DEFAULT: Helvetica, plain, 12

Parameter 22
Attribute: Underline Sub Menu Text
param name = "underlinesubtext"
Value=true or false
DEFAULT: false

Parameter 23
Attribute: Sub Text Box Area - Left Margin
param name = "sublmargin"
Value=X Where X = the distance from the left edge of the applet to the beginning of the main menu box area.
DEFAULT: 5

Parameter 24
Attribute: Sub Text Box Area - Right Margin
param name = "subrmargin"
Value=X Where X = the distance from the right edge of the applet minus the scroll bar width to the end of the main menu box area.
DEFAULT: 5

Parameter 25
Attribute: Sub Text - Indent
param name = "subtextindent"
Value=X Where X = the distance from the beginning of the main menu box area to the the beginning of the main menu text descriptions.
DEFAULT: 5

 

Sub Menu Color Settings

Parameter 26
Attribute: Sub Menu Text Color
param name = "subtextcolor"
Value=r,g,b or #000000 - #FFFFFF - See above for more information on defining colors.
DEFAULT: 0,0,0

Parameter 27
Attribute: Sub Menu Text Highlight Color
param name = "subtexthlcolor"
Value=r,g,b or #000000 - #FFFFFF - See above for more information on defining colors.
DEFAULT: 0,255,0

Parameter 28
Attribute: Sub Menu Box Color
param name = "subboxcolor"
Value=r,g,b or #000000 - #FFFFFF - See above for more information on defining colors. In-order to force the applet to not draw main menu boxes leave this parameter undefined.
DEFAULT: none

Parameter 29
Attribute: Sub Menu Outline Color
param name = "suboutcolor"
Value=r,g,b or #000000 - #FFFFFF - See above for more information on defining colors. In-order to force the applet to not draw main menu outlines leave this parameter undefined.
DEFAULT: none

Parameter 30
Attribute: Sub Menu Outline Color
param name = "subhloutcolor"
Value=r,g,b or #000000 - #FFFFFF - See above for more information on defining colors. In-order to force the applet to not draw main menu highlight outlines leave this parameter undefined.
DEFAULT: none

 

Main Menu Arrow Settings

Note: To remove the main menu arrows from the applet set the "arrowxoffset" parameter to a positive or negative number large enough to force the arrows to be drawn outside of the applet area.

Parameter 31
Attribute: Animate Arrows
param name = "animatearrows"
Value=true or false,  Note: When set tot true the last main menu items arrow that was activated will grow and shrink with an animation effect.
DEFAULT: true

Parameter 32
Attribute: Arrow X (Horizontal) Offset.
param name = "arrowxoffset"
Value=X, Where X = the distance to horizontally offset the default positioning of the main menu arrows.
DEFAULT: 0

Parameter 33
Attribute: Arrow y (Vertical) Offset.
param name = "arrowyoffset"
Value=X, Where X = the distance to vertically offset the default positioning of the main menu arrows.
DEFAULT: 0

Parameter 34
Attribute: Arrow Color
param name = "arrowcolor"
Value=r,g,b or #000000 - #FFFFFF - See above for more information on defining colors.
DEFAULT: 204,204,204

Parameter 35
Attribute: Arrow Highlight Color
param name = "arrowhlcolor"
Value=r,g,b or #000000 - #FFFFFF - See above for more information on defining colors.
DEFAULT: 255,255,0

Parameter 36
Attribute: Arrow Active Color
param name = "arrowactivecolor"
Value=r,g,b or #000000 - #FFFFFF - See above for more information on defining colors.
DEFAULT: 255,255,0

 

Main Menu Background Image Settings

Parameter 37
Attribute: Main Menu Background Image
param name = "mainbgimage"
Value = X. Where X is the name and relative or absolute location of the main menu background  image file.The file should be defined relative to the location of the document containing the applet or fully qualified (e.g. http://www.mydomain.com/...).

Parameter 38
Attribute: Tile Main Background Image
param name = "tilemainbg"
Value=true or false
DEFAULT: true

Parameter 39
Attribute: Tile Background Image in Margins
param name = "tileinmargins"
Value=true or false
DEFAULT: true

Parameter 40
Attribute: Clip Main Background Image
param name = "clipmainbg"
Value=true or false, When true the background image will be clipped at the end of the main menu links.
DEFAULT: false

Parameter 41
Attribute: Clip Additional Main Height
param name = "clipadditionheight"
Value=X, Where x is the additional length to extend the clipping area, this parameter is only effective when the "clipmainbg" parameter is set to true.
DEFAULT: 0

 

Sub Menu Background Image Settings

Parameter 42
Attribute: Sub Menu Background Image
param name = "subbgimage"
Value = X. Where X is the name and relative or absolute location of the sub menu background  image file.The file should be defined relative to the location of the document containing the applet or fully qualified (e.g. http://www.mydomain.com/...).

Parameter 43
Attribute: Tile Sub Background Image
param name = "tilesubbg"
Value=true or false
DEFAULT: true

 

Icon Image Settings

An unlimited number of icon images in varying sizes and formats may be defined and associated with any main menu link or sub menu link. Each icon is optionally referenced from the "maindesc" and "subdesc" tag by using the icons id which is the numbered index used in the parameter to sequentially specify the file name and location of the icon image. For more information on how to add an icon reference to a menu link see the descriptions for the "maindesc" and "subdesc" tags. The icons associated switch image is automatically displayed when a main menu or sub menu link using the icon is highlighted.

Parameter 44
Attribute: Icon Files
param name = "iconfile0" - "iconfileN"
Value = X. Where X is the name and relative or absolute location of the icon image file.The file should be defined relative to the location of the document containing the applet or fully qualified (e.g. http://www.mydomain.com/...). The icon file can be associated with any main menu or sub menu item by referencing the icons index within the "maindesc" or "subdesc" parameters (see the definitions of these parameters for more information).

Parameter 45
Attribute: Icon Switch Files
param name = "iconswitchfile0" - "iconswitchfileN"
Value = X. Where X is the name and relative or absolute location of the icon image file.The file should be defined relative to the location of the document containing the applet or fully qualified (e.g. http://www.mydomain.com/...). The switch icon is automatically displayed when a menu using the switch icons associated icon file (the icon file with the same index) is highlighted.

Parameter 46
Attribute: Main Menu Icon Indent
param name = "mainiconindent"
Value = X. Where X is the distance from the left edge of the main box area to indent any icon associated with the main menus.
Default: 3

Parameter 47
Attribute: Sub Menu Icon Indent
param name = "subiconindent"
Value = X. Where X is the distance from the left edge of the sub menu box area to indent any icon associated with the sub menus.
Default: 3

Parameter 48
Attribute: Main Menu Icon Top Offset
param name = "mainicontopoffset"
Value = X. Where X is the distance to vertically offset any icon associated with the main menus, by default the icon is centered within the main menu box areas.
Default: 0

Parameter 49
Attribute: Sub Menu Icon Top Offset
param name = "subicontopoffset"
Value = X. Where X is the distance to vertically offset any icon associated with the sub menus, by default the icon is centered within the main menu box areas.
Default: 0

 

Scroll Bar Settings

Parameter 50
Attribute: Scroll Bar Width
param name= "barwidth"
Value = X, Where X is the width of the scroll bar. Note the buttons and slider will automatically adjust to the set width.
DEFAULT: 14

Parameter 51
Attribute: Scroll Bar Slider Inset Value
param name= "barslideinset"
Value = X, Where X is the distance from the edges that the slide bar should be inset.
DEFAULT: 2

Parameter 52
Attribute: Indent Scroll Bar Bubble
param name= "barindentbubble"
Value = true or false,  When set to true the scroll bar bubble will animate with a button depress effect when clicked.
DEFAULT: true

Parameter 53
Attribute: Tile Main Menu Background In Scroll Bar
param name= "tilebginbar"
Value = true or false
DEFAULT: true

Parameter 54
Attribute: Draw Scroll Bar Flat
param name= "barflat"
Value = true or false, when true the scroll bar buttons and bubble are flat, when set to true, buttons and bubble are drawn with a 3D raised effect.
DEFAULT: true

Parameter 55
Attribute: Hide Scroll Bar When Inactive
param name= "hidebar"
Value = true or false
DEFAULT: False

 

Scroll Bar Color Settings

Parameter 56
Attribute: Scroll Bar Background Color
param name= "barbgcolor"
Value=r,g,b or #000000 - #FFFFFF - See above for more information on defining colors.
DEFAULT: Black

Parameter 57
Attribute: Scroll Bar Button Face Colors
param name= "barbuttoncolor"
Value=r,g,b or #000000 - #FFFFFF - See above for more information on defining colors. In-order to force the applet to not draw button faces leave this parameter undefined.
DEFAULT: None

Parameter 58
Attribute: Scroll Bar Arrow Color
param name= "bararrowcolor"
Value=r,g,b or #000000 - #FFFFFF - See above for more information on defining colors.
DEFAULT: Black

Parameter 59
Attribute: Scroll Bar Arrow Highlight Color
param name= "bararrowhlcolor"
Value=r,g,b or #000000 - #FFFFFF - See above for more information on defining colors. The bar arrow highlight color is the arrow color that will appear as the mouse moves over an up or down button
DEFAULT: Yellow

Parameter 60
Attribute: Scroll Bar Bubble Arrow Color
param name= "barbarrowcolor"
Value=r,g,b or #000000 - #FFFFFF - See above for more information on defining colors. In-order to force the applet to not draw bubble arrows leave this parameter undefined.
DEFAULT: None

Parameter 61
Attribute: Scroll Bar Bubble Arrow Highlight Color
param name= "barbarrowhlcolor"
Value=r,g,b or #000000 - #FFFFFF - See above for more information on defining colors. In-order to force the applet to not draw bubble highlight arrows leave this parameter undefined.
DEFAULT: None

Parameter 62
Attribute: Scroll Bar Slider Color
param name= "barslidecolor"
Value=r,g,b or #000000 - #FFFFFF - See above for more information on defining colors. The slider is the colored bar between the top and bottom buttons. In-order to force the applet to not draw the solid section of the slider leave this parameter undefined.
DEFAULT: None

Parameter 63
Attribute: Scroll Bar Outline Color
param name= "baroutlinecolor"
Value=r,g,b or #000000 - #FFFFFF - See above for more information on defining colors. In-order to force the applet to not draw outlines leave this parameter undefined.
DEFAULT: None

Parameter 64
Attribute: Scroll Bar Inactive Color
param name= "barinactivecolor"
Value=r,g,b or #000000 - #FFFFFF - See above for more information on defining colors. This parameter defines the color of the up and down arrows in the event the scroll bar is made inactive by a page area to short to scroll.
DEFAULT: None

 

URL Links

Parameter 65
Attribute: Main Menu URL Links
param name = "mainurl0" - "mainurlN"
value=Target | URL, or URL, where URL is the link for the specific sub menu message. URL's can be defined relative to the HTML document containing the applet or fully qualified (e.g. http://www.mydomain.com/...).

The desturl value can optionally be separated by a | to define a specific target location for the URL. To specifically target a named frame, set the value of the parameter to the URL than use a vertical bar ( | ) and follow it with the name of the frame or use the URL link in combination with the constants listed below. The default target location is the value set with the loadwhere tag which defaults to "_self". e.g. a URL link which loads in a frame named content... "...myfolder/mylink.htm|content", e.g. a URL link which uses the default target location... "...myfolder/mylink.htm".

"_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

Parameter 66
Attribute: Sub Menu Level URL Links
param name = "suburl0-0" - "suburlN-N"
value=Target | URL, or URL, where URL is the link for the specific sub menu message. URL's can be defined relative to the HTML document containing the applet or fully qualified (e.g. http://www.mydomain.com/...).

The desturl value can optionally be separated by a | to define a specific target location for the URL. To specifically target a named frame, set the value of the parameter to the URL than use a vertical bar ( | ) and follow it with the name of the frame or use the URL link in combination with the constants listed below. The default target location is the value set with the loadwhere tag which defaults to "_self". e.g. a URL link which loads in a frame named content... "...myfolder/mylink.htm|content", e.g. a URL link which uses the default target location... "...myfolder/mylink.htm".

"_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

Parameter 67
Attribute: Default Load Destination URL Where?
param name="loadwhere"
The "loadwhere" tag specifies where the document specified in the "desturlN-N-N" and "mdesturlN" parameters 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 because of a typo or other error the document will be loaded in a new window.

 

Animation Settings

Parameter 68
Attribute: Slide Animation Jump Size
param name = "jumpsize"
Value = X, Where x is the number of pixels to move between frame draws, the higher the number the faster the animation.
DEFAULT: 2

Parameter 69
Attribute: Slide Animation Jump Delay Time
param name = "jumpdelay"
Value = X, Where x is time in milliseconds to delay between animation frames.
DEFAULT: 15

 

Other Settings

Parameter 70
Attribute: End Cap Image
param name = "endcapimage"
Value = X. Where X is the name and relative or absolute location of the end cap image file.The file should be defined relative to the location of the document containing the applet or fully qualified (e.g. http://www.mydomain.com/...). The end cap image file appears after the last main menu item and can be used as visually define the end of the main menus when sliding up and down.

Parameter 71
Attribute: Start Open Index Number
param name = "startopenindex"
Value = X. Where X is the index number of the main menu item to be automatically expanded upon initially loading the applet.

Parameter 72
Attribute: Main Text Y (Vertical) Offset
param name = "maintextyoffset"
Value = X. Where X is the distance in pixles to offset the main menu text descriptions from the default centered position.
DEFAULT: 0


OpenCube

Smart Tree Menu, © 1999, OpenCube Inc.

This software may be used for evaluation purposes only. For more information regarding the use of this evaluation software see the End User Agreement Document.