SmartTree Menu Documentation
 
Sample Implementation
Template Based on Sample Implementation
 
Applet Parameters Index
General Settings
Main Menu & Sub Menu Item Heights
Loading Images Message
Main Menu Description Settings
Main Menu Color Settings
Sub Menu Description Settings
Sub Menu Color Settings
Main Menu Arrow Settings
Main Menu Background Image Settings
Sub Menu Background Image Settings
Icon Image Settings
Scroll Bar Settings
Scroll Bar Color Settings
Scroll Bar Image Settings
URL Links
Animation Settings
Other Settings
 
General Settings
Copyright Notice.
param name="Notice"
value="SmartTree Menu, Copyright (c) 2000, OpenCube Inc."
Note: This must be included for the applet to work.

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

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"

Status bar text when the mouse moves off the 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"

 
Main Menu and Sub Menu Item Heights

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

Sub Menu Item Height
param name = "subitemheight"
Value = X, Where X is the height of each sub menu link area.
DEFAULT: ="itemheight" parameter

 
Loading Images Message

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...

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

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

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.

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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/...).

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

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

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

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

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/...).

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.

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).

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.

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

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

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

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

Scroll Bar Width
param name= "barwidth"
Value = X, Where X is the width of the scroll bar.
DEFAULT: 14

Scroll Bar Height
param name= "barheight"
Value = X, Where X is the Height of the scroll bar.
DEFAULT: 14

Scroll Bar X Coordinate
param name= "barx"
Value = X, Where X is the X coordinate of the scroll bar in the applet space
DEFAULT: None

Scroll Bar Y Coordinate
param name= "bary"
Value = X, Where X is the Y coordinate of the scroll bar in the applet space
DEFAULT: None

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

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

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

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

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

 
Scroll Bar Color Settings

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

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

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

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

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

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

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

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

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

 
Scroll Bar Image Settings

Note: In order for the applet to recognize the use of images in the scroll bar you must define images for the top button, bottom button, and bubble.

Top Button Inactive Image
param name = "topinactiveimage"
Value = X. Where X is the relative or absolute url of the image file to use.

Top Button Active Image
param name = "topimage"
Value = X. Where X is the relative or absolute url of the image file to use.

Top Button highlight Image
param name = "tophlimage"
Value = X. Where X is the relative or absolute url of the image file to use.

Top Button clicked Image
param name = "topclickedimage"
Value = X. Where X is the relative or absolute url of the image file to use.

Top Button Inactive Image
param name = "topinactiveimage"
Value = X. Where X is the relative or absolute url of the image file to use.

Top Button Active Image
param name = "topimage"
Value = X. Where X is the relative or absolute url of the image file to use.

Top Button highlight Image
param name = "tophlimage"
Value = X. Where X is the relative or absolute url of the image file to use.

Bottom Button Inactive Image
param name = "bottominactiveimage"
Value = X. Where X is the relative or absolute url of the image file to use.

Bottom Button active Image
param name = "bottomactiveimage"
Value = X. Where X is the relative or absolute url of the image file to use.

Bottom Button highlight Image
param name = "bottomhlimage"
Value = X. Where X is the relative or absolute url of the image file to use.

Bottom Button clicked Image
param name = "bottomclickedimage"
Value = X. Where X is the relative or absolute url of the image file to use.

Bubble Image
param name = "bubbleimage"
Value = X. Where X is the relative or absolute url of the image file to use.

Bubble Highlight Image
param name = "bubblehlimage"
Value = X. Where X is the relative or absolute url of the image file to use.

Bubble Clicked Image
param name = "bubbleclickedimage"
Value = X. Where X is the relative or absolute url of the image file to use.

 
URL Links

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

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

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

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

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

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.

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.

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

Main Links Y Offset
param name = "mainyoffset"
Value=X Where X = the distance in pixles from the top of the applet to the beginning of the first main menu link.
DEFAULT: 0

Extra Main Menu Scroll Height
param name = "mainextraheight"
Value=X Where X = the extra distance in pixles to extend the visible scroll area of the main menu items.
DEFAULT: 0