SuperTree Parameters
Click an item in the list to the left to find out more about it.


Width & Height
The width and height of the applet are set in the HTML code you add to the web page. Be sure to change the dimensions in the <object> and the <embed> tags.

SuperTree's width must be sufficient to display the text of the item that extends furthest to the right.

How you height depends on whether the ShowScrollers parameter is set to 'yes' or 'no':

If ShowScrollers is set to 'yes', SuperTree's height can be anything you like, but for the cleanest results, use the equation 20 + (ItemHeight*displayed items). For example, if your ItemHeight is 18 and you want to see 10 items at once, that's 20 + (18*10) which equals 200.

If ShowScrollers is set to 'no', SuperTree's width and height should be set so that whichever branch of the tree is expanded, the lowest item can be seen. You can minimize the height required by setting AutoCollapse to 'yes'. However, this is something of a trial-and-error process: find out which branches must be expanded to display the lowest possible item, then experiment with height settings (temporarily setting a different BgColor from the surrounding page to see how close you're getting) until the dimensions are suitable.

To avoid the trial-and-error process, set the Testmode parameter to 'yes' and click anywhere inside the applet: the minimum width and height will be shown in a tooltip message. You can then edit the HTML code and set Testmode back to 'no'.

Parameters
The parameters below should be added to your datafile in the form NAME=VALUE (for instance, BgColor=FF0000). Each parameter should be on a separate line. You can leave blank lines in the list to organize the parameters into groups if you want to. The parameter names are not case-sensitive, and neither are the values, so BgColor=FF0000 is the same as bgcolor=ff0000. You can add the parameters to your file in any order. Most parameters have a default value which we show in bold text below: if you don't include the parameter in your datafile, the default value will be used automatically.

AnimateDelay
A number which sets the speed of SuperTree's expand/collapse animation (if AnimateMenu is set to 'yes'), where a lower number results in faster animation. The default is 30.

AnimateMenu
A choice of yes or no according to whether animation should be used when expanding and collapsing nodes. The default is yes.

AutoCollapse
A choice of yes or no. The default is no. If set to 'yes', SuperTree will automatically collapse any unused branches when a new branch is expanded, minimizing the number of visible items. It's a good idea to set this parameter to 'yes' if you set ShowScrollers to 'no'.

AutoExpandLinks
A choice of yes or no according to whether a folder that also acts as a link should expand/collapse when clicked, or just fire its link. The default is no (the folder won't expand). If set to 'no', users must use the toggle-box beside the folder to expand it. Therefore, if ShowToggles is set to 'no', this parameter is ignored and clicking a folder will always expand/collapse it.

BgColor
Sets the background color of the applet, when not transparent. The default value is FFFFFF (white). (Note that SuperTree can only change the background color after it has loaded. To have the same background color shown before the browser starts loading the applet, change the BgColor setting in the HTML code too.)

DefaultTarget
Every item can link to a separate URL, and it can open it into a separate frame or window: we provide numbered Target parameters for that. However, you probably want most (or maybe all) the links to open into one particular frame. Enter the frame name in this parameter, and every item without its own Target parameter will open the link into this 'default' frame. As well as frame names you've defined in your documents, you can use the HTML names _self, _top, _parent, _blank or _new. If you leave this parameter out of your datafile, links will open into _self (the frame or window containing the applet).

ExpandedFolder
This optional parameter lets you specify a folder to be expanded when SuperTree starts. The folder you choose can be anywhere in the tree, at any level - its parent folders will be expanded automatically. To set a folder as expanded, the value for this parameter must be the exact (case-sensitive) caption of the folder (as set in its Item parameter). You can set multiple folders to be expanded by specifying the exact caption for each, separted by pipe symbols, such as: Products|Services|Support. If no folder should be expanded, leave this parameter out of your datafile. Note: You can also set the expanded folder remotely using JavaScript as a web page loads. See PageSync for details.

FolderColor
Sets the text color of all folder items, with a default of 000000 (black). Individual folders can override this by setting their own color.

FolderFocusColor
Sets the color of a folder item when the mouse moves over it. The default is 0000A0 (blue).

FolderPressColor
Sets the color of a folder item when clicked. The default is 999999 (gray).

FolderFont
Sets the name, size and style of font to use for folders, with each part separated by commas. The default is Sans,8,plain.

  • Name: You can include any number of font names, separated by pipe symbols (|), and the applet will use the first font available on the user's system. To ensure compatibility, finish with one of these generic names: Sans, Serif or Typewriter.
  • Size: The size of the font in points.
  • Style: The style can be plain, bold, italic or bold-italic.
An example font parameter would be: Comic Sans MS|Verdana|Arial|Sans,9,bold.

HandCursor
Specifies whether (and when) and hand cursor will be used when the mouse is over an item. There are three options (not case sensitive):

  • all: show a hand cursor for all items
  • links: only show a hand cursor for items that link somewhere
  • none: never show a hand cursor
The default is links.

IconFolderClosed
The absolute or relative URL of an image to use as the icon for all closed (non-expanded) folders. If no icons are required for folders, leave this blank. Individual folders can override this an display their own icon using the numbered IconClosed parameters.

NOTE #1: As with all Flash applets, the image must be either a non-progressive JPEG or a SWF. (Our free Design Studio application can convert GIFs to SWFs, allowing you to use transparency in the images.)

NOTE #2: SuperTree assumes that all the images you use have the same dimensions.

NOTE #3: If you use an IconFolderOpen image for a folder without an IconFolderClosed (or the reverse) you'll see a blank space where the icon should be.

IconFolderOpen
The absolute or relative URL of an image to use as the icon for all open (expanded) folders. If no icons are required for folders, leave this blank. See the notes about using icons above. Individual folders can override this an display their own icon using the numbered IconOpen parameters.

IconPage
The absolute or relative URL of an image to use as the icon for all pages (items that don't contain sub-items). If no icons are required for pages, leave this blank. See the notes about using icons above. Individual pages can override this an display their own icon using the numbered IconClosed parameters.

IconSpacing
Sets the horizontal space (in pixels) between an item's icon and its caption. The default is 2 pixels.

InheritColors
Any item can have its own text color, overriding the FolderColor or PageColor it would normally use. For folders, this parameter offers a choice of yes or no according to whether the sub-items contained in the folder should inherit the same same color as the folder. The default is no, meaning that if you set a custom color for a folder, its contents will still use their default colors. If you choose 'yes', that folder's contents will use the same text color as the folder (unless they also have a custom text color).

ItemHeight
Sets the height in pixels of all items in the tree, with a default of 18. This value should be no less than the height of your icons (or your font, whichever is taller). All icons and text are centered vertically within the space given to them.

LevelIndent
Specifies the amount in pixels by which each level of items in the tree should be indented from the previous level. The default is 12 pixels.

Name
Specifies a name for this instance of the applet. This is only necessary if you are using the applet in conjunction with our free Satellite add-on, and it's explained in the documentation for Satellite, available from the Cool Focus web site. If you are not using Satellite with this applet, it's best not to include this parameter in your datafile (although nothing bad will happen if you do).

PageColor
Sets the text color of all page items. The default is to match your FolderColor. Individual pages can override this by setting their own color.

PageFocusColor
Sets the color of a page item when the mouse moves over it. The default is to match your FolderFocusColor.

PagePressColor
Sets the color of a page item when clicked. The default is to match your FolderPressColor.

PageFont
Sets the name, size and style of font to use for pages, with each part separated by commas. The default is Sans,8,plain.

  • Name: You can include any number of font names, separated by pipe symbols (|), and the applet will use the first font available on the user's system. To ensure compatibility, finish with one of these generic names: Sans, Serif or Typewriter.
  • Size: The size of the font in points.
  • Style: The style can be plain, bold, italic or bold-italic.
An example font parameter would be: Comic Sans MS|Verdana|Arial|Sans,9,bold.

ScrollArrowColor
If ShowScrollers is set to 'yes', this sets the color of the scroll arrows when they are enabled. The default is 000000 (black).

ScrollArrowFocusColor
If ShowScrollers is set to 'yes', this sets the color of an enabled scroll arrow when the mouse moves over it. The default is 0000C0 (blue).

ScrollArrowDisabledColor
If ShowScrollers is set to 'yes', this sets the color of a scroll arrow when disabled. The default is C0C0C0 (light gray).

ScrollBgColor
If ShowScrollers is set to 'yes', this sets either the fill-color or the line-color (depending on your choice of ScrollStyle) used in the two scroll areas of the applet. The default is 000000 (black).

ScrollStyle
If ShowScrollers is set to 'yes', this parameter gives a choice of appearances for the scroll areas at the top and bottom of the applet. The options are:

  • fill: creates filled blocks of ScrollBgColor containing the scroll arrows
  • line: leaves the scroll area filled with the applet's BgColor and draws a horizontal line of ScrollBgColor on the inner edge of the scroll areas
The default setting is line.

SelectorColor
Sets the color of the optional full-width selector bar (shown if ShowSelector is set to 'yes'). The default color is BDCFEC (light blue).

SelectorOpacity
Sets the opacity level of the selector bar (if ShowSelector is set to 'yes'), where 0 is completely transparent and 100 is fully opaque. The default is 100.

SeparatorColor
Sets the color of any separator items added to the menu to divide items into groups. The default is 000000 (black).

ShowScrollers
A choice of yes or no which sets whether scroll buttons should be displayed at the top and bottom of the applet. The default is yes. If scroll buttons are shown, users can click these to scroll the menu up and down. (You can also set up mouse-wheel scrolling for Internet Explorer 6 users.) If set to 'no', the menu cannot be scrolled and you need to ensure that the applet's height is sufficient to display all expanded branches of the tree (and, we suggest, set AutoCollapse to 'yes').

ShowSelector
A choice of yes or no according to whether you want SuperTree to display the selector bar. The default is no.

ShowToggles
A choice of yes or no according to whether you want SuperTree to display toggle boxes beside folders. Users can expand and collapse folders by clicking the toggle boxes. The default is yes.

ShowVersion
A yes or no value. This parameter is included in all Cool Focus Flash applets, and its default is no. If set to 'yes', the version number of the applet (and other details) will be shown when the applet starts. This is included only for troubleshooting purposes, to help you determine which version of an applet you're using. It should be set to 'no' (or removed from your datafile) before you publish your page.

Note: If the applet is not registered, this information will always be shown when the applet starts, regardless of the ShowVersion parameter's setting.

SoundFolderClick
Specifies the absolute or relative URL of an MP3 audio file to play when the mouse is clicked on a linking folder. If you don't want to play a sound for this event, just leave this parameter out of your datafile.

SoundFolderRelease
Specifies the absolute or relative URL of an MP3 audio file to play when the mouse is released after clicking a folder. If you don't want to play a sound for this event, just leave this parameter out of your datafile.

SoundPageClick
Specifies the absolute or relative URL of an MP3 audio file to play when the mouse is clicked on a page. If you don't want to play a sound for this event, just leave this parameter out of your datafile.

SoundPageRelease
Specifies the absolute or relative URL of an MP3 audio file to play when the mouse is released after clicking a page. If you don't want to play a sound for this event, just leave this parameter out of your datafile.

SoundExpand
Specifies the absolute or relative URL of an MP3 audio file to play when the mouse clicks a toggle box to expand a folder. If you don't want to play a sound for this event, just leave this parameter out of your datafile.

SoundCollapse
Specifies the absolute or relative URL of an MP3 audio file to play when the mouse clicks a toggle box to collapse an expanded folder. If you don't want to play a sound for this event, just leave this parameter out of your datafile.

ToggleFillColor
Sets the internal fill color of the toggle boxes beside folder items (if ShowToggles is 'yes', its default setting). The default is EAE7DF (blue-gray).

ToggleFillFocusColor
Sets the fill color of a toggle box when the mouse moves over it. The default is to match your ToggleFillColor (ie. the color won't change).

ToggleBorderColor
Sets the border color of the toggle boxes beside folder items. The default is 7B9CB5 (light blue).

ToggleBorderFocusColor
Sets the fill color of a toggle box when the mouse moves over it. The default is to match your ToggleBorderColor (ie. the color won't change).

ToggleColor
Sets the color of the + and - symbols in the toggle boxes. The default is 000000 (black).

ToggleFocusColor
Sets the color of the + or - symbol in a toggle box when the mouse moves over it. The default is to match your ToggleColor (ie. the color won't change).

ToggleReact
A choice of yes or no to specify whether toggle boxes should react to a click by temporarily expanding the + or - symbol in the box. The default is yes. (This parameter is ignored is ShowToggles is set to 'no').

ToggleSpacing
Sets the amount of horizontal space (in pixels) between a folder's toggle box and its icon. The default is 4 pixels.

Testmode
A yes or no value, with a default of 'no'. This parameter is included in most Cool Focus Flash applets, and is used to help you determine the best width and height for the applet. (Because of this, it's best to use this parameter when you've got everything in the applet the way you want it.) Set this parameter to 'yes', then view the applet in your browser and click anywhere inside the applet. You'll see the minimum width and height displayed in a tooltip message, and you can copy these values into the page's HTML code. When you're done, remember to set the Testmode parameter back to 'no' or delete it from your datafile.

Note: If you've specified a list of font names in the applet's font parameters, it's a good idea to check that the applet will be big enough whichever of those fonts is used: with Testmode set to 'yes', move each font name to the beginning of the list and refresh the page to see if Testmode reports that larger dimensions are needed.

Transparent
A yes or no parameter, with a default of no. If set to 'yes', the applet's background will be made transparent in compatible browsers, showing the HTML content (such as a page background) behind the applet.

Underline
Specifies whether (and when) an HTML-style underline will be added to an item's text when the mouse hovers over it. There are three options (not case sensitive):

  • all: underline any item when the mouse moves over it
  • links: only underline items that would link somewhere when clicked
  • none: never underline items
The default is all.

Menu Items
SuperTree uses a parameter-numbering system to determine the structure of the tree, which is explained in the Adding Menu Items page of this documentation. The seven parameter names below are used (with the appropriate numbering added to them) to specify an item's text, the URL it links to, its color, and so on. The details below explain what each of the seven parameters does.

Item
This is the fundamental parameter that adds a new item to the tree. It specifies the text to display in the tree. As explained in Adding Menu Items, this parameter will have numbers added to it, such as Item4, or 3-1-Item2. The same numbers should be added to any of the parameters below that you use to make settings for this item (eg. URL4 or 3-1-URL2). You can create a separator item (a horizontal divider line) by setting its text to a hyphen (-). Leave the remaining parameters blank for separators (they don't have icons, URLs, messages, etc).

URL
The optional URL to which the Item should link when clicked. If you don't want the item to act as a link, don't include a URL parameter for it. To make items behave like links in all respects except linking somewhere (which can be useful for testing), use a dollar sign ($, or when encoded, %24) as the first character of the URL.

Target
The name of the frame or window into which the URL should open. If you don't include this parameter, the frame name set in the DefaultTarget parameter will be used.

Message
An optional text message which will be displayed in the browser's status bar (in compatible browsers) when the mouse moves over the item.

Color
An optional parameter which sets the text color of the item, overriding the default colors set in the FolderColor and PageColor parameters. If InheritColors is set to 'yes' and this item contain sub-items, the sub-items will automatically be given this color too.

IconClosed
An optional parameter that specifies the absolute or relative URL of an icon to display for this item, overriding the default IconFolderClosed or IconPage. If this item is a folder, the icon will be used when the folder is not expanded (you can set a custom 'open' icon using the parameter below). If this item is a page, the icon will always be used for it.

IconOpen
This optional parameter lets you specify the URL of a custom icon to use for this folder item in its 'open' (expanded) state. (If this item is not a folder, it won't have an 'open' state so this parameter is ignored.)