|
TabPanel 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.
TabPanel's width must be sufficient to display the buttons added to each tab: although the tabs can be scrolled, the buttons cannot.
TabPanel's height must be enough to display the tabs and the panel below them containing the buttons.
To avoid the trial-and-error of finding the best size, 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. For Buttons, all the color parameters have defaults which make the buttons match the tabs. As this is usually what you'll want, it means you can ignore most of the parameters beginning with the word 'Button'.
AnimationSpeed
A choice of fast, normal or slow (not case-sensitive) which sets the speed of TabPanel's scrolling animation. The default is normal.
BgColor
Sets the background color of the applet, which is visible beside and between the tabs if Transparent is set to 'no'. The default value is FFFFFF (white). (Note that TabPanel 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.)
ButtonBorderColor
Sets the color of the borders around the buttons when inactive. The default is to match your chosen TabShadowColor.
ButtonColor
Sets the fill color of the buttons. The default is to match your TabColor.
ButtonExtraWidth
A number which sets the amount (in pixels) of extra horizontal padding to apply to TabPanel's buttons. The default is 6. (Odd numbers are rounded upward to allow even distribution of the padding at either side of the text.)
ButtonFont
Sets the name, size and style of font to use for the buttons, 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.
ButtonHighlightColor
Sets the color of the two highlighted edges of the buttons (when focused or selected). The default is to match your TabHighlightColor.
ButtonShadowColor
Sets the color of the two shadowed edges of the buttons (when focused or selected). The default is to match your TabShadowColor.
ButtonSpacing
Sets the amount of horizontal space between each button, in pixels. The default is 4 pixels, and the minimum is 0.
ButtonTextColor
Sets the color of the text shown on the buttons. The default is to match your TabTextColor.
ButtonTextFocusColor
Sets the color of the text shown on a button when the mouse moves over it. The default is to match your TabTextFocusColor.
ButtonTextSelectColor
Sets the color of the text shown on a button when selected. The default is to match your TabTextSelectColor.
DefaultTarget
Every tab and button 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. 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).
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).
SelectedButton
Sets the index of the button to be shown as selected on the selected tab when the applet starts. Sets this to 0 (the default) if no button should be selected, or if the selected tab contains no buttons.
SelectedTab
Sets the index number of the tab that should be selected when the applet first appears. One tab must always be selected, and the default is 1 (selecting the first tab). If the tab to be selected contains buttons, you can use the SelectedButton parameter to make a button selected on that tab when the applet starts.
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.
SoundButton
Specifies the absolute or relative URL of an MP3 audio file to play when a button is selected. If you don't want to play a sound for this event, just leave this parameter out of your datafile.
SoundTab
Specifies the absolute or relative URL of an MP3 audio file to play when a tab is selected. If you don't want to play a sound for this event, just leave this parameter out of your datafile.
TabFont
Sets the name, size and style of the font to use for the tabs. The default is Sans,8,plain. This parameter is constructed in exactly the same way as the ButtonFont parameter.
TabColor
Sets the fill color of the non-selected tabs. The default is C0C0C0 (light gray).
TabHighlightColor
Sets the color of the highlighted edges of the non-selected tabs. The default is E0E0E0 (very light gray).
TabShadowColor
Sets the color of the shadowed edges of the non-selected tabs. The default is 808080 (mid gray).
SelectedTabColor
Sets the fill color of the selected tab and of the panel below the tabs which contains the buttons. The default, if this parameter is not included, is to match your TabColor.
SelectedTabHighlightColor
Sets the color of the highlighted edges of the selected tab and the button-panel below. The default, if this parameter is not included, is to match your TabHighlightColor.
SelectedTabShadowColor
Sets the color of the shadowed edges of the selected tab and the button-panel below. The default, if this parameter is not included, is to match your TabShadowColor.
TabTextColor
Sets the color of the text on a tab when not focused or selected. The default is 000000 (black).
TabTextFocusColor
Sets the color of the text on a tab when the mouse moves over it. The default is 0000FF (blue).
TabTextSelectColor
Sets the color of text on a tab when the tab is selected. The default is C00000 (red).
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 choice of yes or no to whether TabPanel's background should be transparent in compatible browsers. If transparent, the HTML page background (or other HTML content) will be visible beside and between the tabs. The default is no. Note that if this parameter is set to 'yes', the animation used when scrolling the tabs will be much slower due to the extra amount of processing required. However, if your applet is wide enough that the tabs never have to be scrolled, there should be no difference in the applet's performance.
Tabs
The four parameters below create the tabs on the menu. Selecting a tab can cause a row of Buttons to be displayed, or can act as a link, or both. You must include at least one Tab parameter, or TabPanel will display nothing at all!
The parameters all have numbers after their names, and the numbers must be consecutive, starting from 1. If you want to show 5 tabs, but you forget to include a Tab4 parameter, TabPanel will stop looking for any more, and will only find tabs 1 to 3.
Tab1, Tab2, ..., Tabn
These parameters specify the text you want TabPanel to display for each tab. The tabs will be displayed in numerical order, starting from 1, and you can include as many tabs as you like. If the applet isn't wide enough to display all the tabs, a pair of scroll-buttons will appear allowing tabs to be scrolled into view.
URL1, URL2, ..., URLn
The optional URL to which the Tab with the same number should link when clicked. If you don't want the tab 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.
Target1, Target2, ..., Targetn
The name of the frame or window into which the URL with the same number should open. If you don't include this parameter, the frame name set in the DefaultTarget parameter will be used.
Message1, Message2, ..., Messagen
An optional text message which will be displayed in the browser's status bar (in compatible browsers) when the mouse moves over the Tab with the same number.
Buttons
These parameters create rows of buttons for each Tab, which are displayed when the tab is selected. They are all prefixed with a number and a hyphen. The number refers to the Tab you are adding this button to: 1-Button1 is the first button added to Tab1. 1-Button2 is the second button for Tab1 and so on. To add buttons to Tab3, you would use 3-Button1, 3-Button2, and so on.
The URL, Target and Message parameters for the button should be numbered exactly the same way as the Button parameter they work with.
1-Button1, 1-Button2, ..., 1-Buttonn
These parameters specify the text you want TabPanel to display for each button. The buttons will be displayed in numerical order, starting from 1, and you can include as many buttons for each tab as you like, provided the applet is wide enough to display them.
1-URL1, 1-URL2, ..., 1-URLn
The optional URL to which the Button with the same numeric prefix and suffix should link when clicked. To make buttons 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.
1-Target1, 1-Target2, ..., 1-Targetn
The name of the frame or window into which the URL with the same number should open. If you don't include this parameter, the frame name set in the DefaultTarget parameter will be used.
1-Message1, 1-Message2, ..., 1-Messagen
An optional text message which will be displayed in the browser's status bar (in compatible browsers) when the mouse moves over the Button with the same numeric prefix and suffix.
|