BSCOutline Tag Descriptions

 
Applet Tag Overview
The applet tag is the element in the HTML document used to embed the Java Applet.
Applet resources are loaded relative to the document URL. The CODEBASE = attribute is used to change this default behavior. If the CODEBASE= attribute is defined, it specifies a different location in which to find applet resources. The value can be an absolute or a relative URL. The absolute URL is used as is, without modification, and is not affected by the document's BASE element. When the CODEBASE= attribute is relative, it is relative to the document URL (or BASE tag, if defined).
The basic tag takes the following form...
<APPLET ALIGN = LEFT | CENTER | RIGHT | TOP | MIDDLE | BOTTOM ALT = alternateText CODE = appletFile CODEBASE = codebaseURL HEIGHT = pixels HSPACE = pixels NAME = appletInstanceName TITLE = text VSPACE = pixels WIDTH = pixels> <PARAM NAME=AttributeName ...> ... </APPLET> ALIGN = LEFT | CENTER | RIGHT | TOP | MIDDLE | BOTTOM - Describes the alignment of an object to text. The default is LEFT.

ALT = alternateText - Specifies alternate text for text-only browsers or browsers that do not support Java.

CODE = appletFile - Specifies the name of the Java applet.

CODEBASE = codebaseURL - Specifies the base URL of the applet (the directory in which the applet is located).

HEIGHT = pixels - Specifies the initial height of the applet display area.

HSPACE = pixels - Specifies the horizontal space in which the applet displays. NAME = appletInstanceName - Identifies an applet to other applets within the HTML page.

PARAM NAME=AttributeName - Passes applet-specific arguments in from an HTML page. There may be no, one, or any number of PARAM NAME= attributes present in the APPLET start-tag.

TITLE=text - Specifies an advisory title string.

VSPACE=pixels - Specifies the space in pixels above the applet.

WIDTH=pixels - Specifies the initial width of the applet display area.

 
Example Tag
<APPLET CODE = BSCOutline.class CODEBASE = http://www.byte-sized.com/applet/ NAME = BSCOutline WIDTH = "200" HEIGHT = "400"> <PARAM NAME = Icon1 VALUE = "icons/folder-closed.gif"> <PARAM NAME = Icon1O VALUE = "icons/folder-open.gif"> <PARAM NAME = Icon2 VALUE = "icons/purple-book-closed.gif"> <PARAM NAME = Icon2O VALUE = "icons/purple-book-open.gif"> <PARAM NAME = Icon3 VALUE = "icons/doc1.gif"> <PARAM NAME = Icon4 VALUE = "icons/doc2.gif"> <PARAM NAME = Icon5 VALUE = "icons/doc3.gif"> <PARAM NAME = Icon6 VALUE = "icons/doc4.gif"> <PARAM NAME = OutlineFile VALUE = "help.out"> <PARAM NAME = FontFace VALUE = "Arial"> <PARAM NAME = FontStyle VALUE = 0> <PARAM NAME = FontSize VALUE = 15> <PARAM NAME = FontColour VALUE = "000066"> <PARAM NAME = BackColour VALUE = "FFFF99"> <PARAM NAME = SelectColour VALUE = "FF0000"> <PARAM NAME = Target VALUE = "contentframe"> <PARAM NAME = ShowLines VALUE = 1> <PARAM NAME = ShowIcons VALUE = 1> <PARAM NAME = License VALUE = 10293840> </APPLET>
 
IconX
This parameter is used to specify the filenames and locations of the images to use as the node icons.
The X represents a consecutive number. e.g. Icon1, Icon2, Icon3 etc.
The URL can be either a fully qualified URL or relative to the applet location.
Note - You can optionally specify a different icon to show in the Open and MouseOver states, see below.
 
IconXO
This parameter is used to specify the filenames and locations of the additional images to use as the node icons.
This icon is shown when the node has children and is desplaying them (i.e. the folder is open)
or if the node does not have children, this image displays when the node is selected.
The X represents a consecutive number. e.g. Icon1O, Icon2O, Icon3O etc.
The URL can be either a fully qualified URL or relative to the applet location.
Note - You can optionally specify a different icon to show in the MouseOver state, see below.
 
IconXM
This parameter is used to specify the filenames and locations of the additional images to use as the node mouseover icon.
This icon is shown when the mousepointer is moved over the node.
The X represents a consecutive number. e.g. Icon1M, Icon2M, Icon3M etc.
The URL can be either a fully qualified URL or relative to the applet location.
Note - You can optionally specify a different icon to show in the MouseOver state, see below.
 
TitleImageX
This parameter is used to specify the filenames and locations of the images used instead of text for the node title string.
The X represents a consecutive number. e.g. TitleImage1, TitleImage2, TitleImage3 etc.
The URL can be either a fully qualified URL or relative to the applet location.
Note - You can optionally specify a different image to show in the Open and MouseOver states, see below.
 
TitleImageXO
This parameter is used to specify the filenames and locations of the additional images to use instead of text for the node title string.
This image is shown when the node has children and is desplaying them (i.e. the folder is open)
or if the node does not have children, this image displays when the node is selected.
The X represents a consecutive number. e.g. TitleImage1O, TitleImage2O, TitleImage3O etc.
The URL can be either a fully qualified URL or relative to the applet location.
Note - You can optionally specify a different image to show in the MouseOver state, see below.
 
TitleImageXM
This parameter is used to specify the filenames and locations of the additional images to use as the node mouseover image.
This image is shown when the mousepointer is moved over the node.
The X represents a consecutive number. e.g. TitleImage1M, TitleImage2M, TitleImage3M etc.
The URL can be either a fully qualified URL or relative to the applet location.
Note - You can optionally specify a different image to show in the MouseOver state, see below.
 
OutlineFile
This parameter is used to specify the filename of a text file containing the data to display in the outline.
Default = outline.out
The URL can be either a fully qualified URL or relative to the applet location.
Note - This parameter will be overriden by any DataX parameters in the applet tag.
For Details of the syntax of the datafile see Datafile Syntax
 
DataX
This parameter is used to specify the actual lines of data to display in the outline.
The X represents a consecutive number. e.g. Data1, Data2, Data3 etc.
Note - The use of DataX parameters will override any OutlineFile Parameter.
For Details of the syntax of the datafile see DataLines Syntax
 
InitialState
This parameter is used to specify the initial state of the outline.
This function uses consecutive node numbers, e.g. the first node in the tree is node 1, the second node is node 2 etc.
This parameter takes the following form...
Xoffset|Yoffset|Selected|Open1|Open2|......|OpenX| Xoffset - The Offset in pixels of the horizontal scrollbar.

Yoffset - The Offset in pixels of the vertical scrollbar.

Selected - The node number of the selected node.

Open1|Open2|......|OpenX| - Zero or more node numbers of nodes to open, separated by "|" and terminated by a "|" (Pipe Character).

e.g. <PARAM NAME=InitialState value="0|0|0|3|33|"> Zero Offsets, no selected node, open nodes 3 and 33. Note - You must ensure you specify each nodes parent, to make the node visible if you want to open the sub-node.
e.g. If you want to make a level 3 node open you must also specify it's level 2 parent. If the selected node is hidden by it's parent being closed then the parent will be highlighted as though it is the currently selected node.
 
InitialNode
This parameter is used to specify the initially active node in the outline.
This function uses NodeID's NOT consecutive node numbers. This parameter takes the following form...
Open1|Open2|......|OpenX| Open1|Open2|......|OpenX| - Zero or more nodes to activate in sequence, separated by "|" and terminated by a "|" (Pipe Character).

e.g. <PARAM NAME=InitialNode value="A|F|G|"> Activate nodes with NodeID's A,F & G respectively. Note - You must ensure you specify each nodes parent, to make the node visible if you want to open the sub-node.
 
URLPrefix
This parameter is used to specify a common URL part for the URL Prefix Nodes.
This is for cases where lots of URL's are the same within the .out file.
e.g. If you put "http://www.byte-sized.com/software" in the URL prefix parameter. a URL in the tree data like ".../index.html" will result in the final URL of "http://www.byte-sized.com/software/index.html"
 
FontFace
This parameter is used to specify the typeface used in the outline.
Default = Arial
Note - Please be aware that due to the large number of different platforms and browsers that the outline is potentially viewed by, there will be times when the applet is being viewed on a system which does not have or support your chosen typeface.
 
FontSize
This parameter is used to specify the size of the lettering, in points, used in the outline.
Default = 12
 
FontStyle
This parameter is used to specify the stype of the lettering used in the outline.
The parameter can have one of the following values...

0 = Normal
1 = Bold
2 = Italic
3 = Bold + Italic

Default = 0
 
FontColour
This parameter is used to specify the colour of the lettering used in the outline.
The parameter must be specified in hexidecimal in the form RRGGBB.
e.g. Red = FF0000; Green = 00FF00; Blue = 0000FF
Default = 000000 (Black)
 
SelectColour
This parameter is used to specify the colour of the lettering used for the last selected item in the outline.
The parameter must be specified in hexidecimal in the form RRGGBB.
e.g. Red = FF0000; Green = 00FF00; Blue = 0000FF
Default = null (No Selection Colouring)
 
SelectBackColour
This parameter is used to specify the background colour of the lettering used for the last selected item in the outline.
The parameter must be specified in hexidecimal in the form RRGGBB.
e.g. Red = FF0000; Green = 00FF00; Blue = 0000FF
Default = null (No Background Colouring)
 
HiddenSelectColour
This parameter is used to specify the colour of the lettering used for the last selected item in the outline if it is hidden because the parent node is closed.
The parameter must be specified in hexidecimal in the form RRGGBB.
e.g. Red = FF0000; Green = 00FF00; Blue = 0000FF
Default = null (No Selection Colouring)
 
HiddenSelectBackColour
This parameter is used to specify the background colour of the lettering used for the last selected item in the outline if it is hidden because the parent node is closed.
The parameter must be specified in hexidecimal in the form RRGGBB.
e.g. Red = FF0000; Green = 00FF00; Blue = 0000FF
Default = null (No Background Colouring)
 
MouseOverColour
This parameter is used to specify the colour of the lettering used when the mouse passes over the item in the outline.
The parameter must be specified in hexidecimal in the form RRGGBB.
e.g. Red = FF0000; Green = 00FF00; Blue = 0000FF
Default = null (No MouseOver Colouring)
 
MouseOverBackColour
This parameter is used to specify the background colour of the lettering used when the mouse passes over the item in the outline.
The parameter must be specified in hexidecimal in the form RRGGBB.
e.g. Red = FF0000; Green = 00FF00; Blue = 0000FF
Default = null (No Background Colouring)
 
BackColour
This parameter is used to specify the colour of the background of the outline.
The parameter must be specified in hexidecimal in the form RRGGBB.
e.g. Red = FF0000; Green = 00FF00; Blue = 0000FF
Default = FFFFFF (White)
Note - This parameter will be overridden if a background image is used.
 
LineColour
This parameter is used to specify the colour of the lines and +- boxes of the outline.
The parameter must be specified in hexidecimal in the form RRGGBB.
e.g. Red = FF0000; Green = 00FF00; Blue = 0000FF
Default = Whatever is specified as the FontColour
 
Background
This parameter is used to specify the filename of the background image of the outline.
The URL can be either a fully qualified URL or relative to the applet location.
If the image is not large enough to completely cover the applet background, it will be tiled vertically and horizontally.
Note - This parameter will override any BackColour parameter.
 
BackgroundX
This parameter is used to specify the horizontal offset in pixels of the background image from the edge on the outline. This allows the image to be aligned with the background image on the page.
 
BackgroundY
This parameter is used to specify the vertical offset in pixels of the background image from the edge on the outline. This allows the image to be aligned with the background image on the page.
 
ShowLines
This parameter is used to specify whether or not to show lines going to each node in the outline.
The parameter can have one of the following values...
1 = Show Node Lines. 0 = Do NOT show Node Lines. Default = 1
 
Indent
This parameter is used to specify the distance in pixels that each node is indented to the right of it's parent node.
Default = Maximum Image Height
 
ShowRootLines
This parameter is used to specify whether or not to show the root lines going to the level 1 nodes in the outline.
The parameter can have one of the following values...
1 = Show Root Lines. 0 = Do NOT show Root Lines. Default = 1
 
DashedLines
This parameter is used to specify whether to show the lines using a dashed or solid lines.
The parameter can have one of the following values...
1 = Use Dashed Lines. 0 = Use Solid Line Style. Default = 1
 
ShowIcons
This parameter is used to specify whether or not to show icons for each node in the outline.
The parameter can have one of the following values...
1 = Show Icons. 0 = Do NOT Show Icons. Default = 1
 
Target
This parameter is used to specify the generic target frame for the links in the outline.
Note - This can be overridden for specific links, see Different Targets.
 
Licence & OtherLicence
These two parameters are used by registered users of BSCOutline to disable the top two "nag" lines.
To obtain a registration code, please register quoting the domain/subdomain on which you want the applet to work.
e.g. Quote www.byte-sized.com for any page within http://www.byte-sized.com
 
AutoClose
This parameter is used to specify whether or not the outline should automatically close all other nodes at the same level as the one being opened or closed.
The parameter can have one of the following values...
1 = AutoClose other nodes. 0 = Do NOT AutoClose. Default = 0
 
AutoOpen
This parameter is used to specify whether or not the outline should automatically open nodes which only contain a single child folder node.
The parameter can have one of the following values...
1 = AutoOpen other nodes. 0 = Do NOT AutoOpen. Default = 0
 
LeftScroll
This parameter is used to specify that the vertical scrollbar should be on the left hand side of the applet.
The parameter can have one of the following values...
1 = Show scrollbar on left side. 0 = Show scrollbar on right side. Default = 0
 
ShowHiddenSelected
This parameter is used to specify whether the applet indicates that the currently selected item is within a closed node.
BSCOutline will show the parents selected icon when it is closed but contains the currently selected node.
The parameter can have one of the following values...
1 = Show Hidden Selected. 0 = Ignore the current selection if hidden. Default = 1
 
DoubleClick
This parameter is used to specify whether a double mouse click is required on the text or icon to expand a tree branch.
The parameter can have one of the following values...
1 = Single click opens or closes a node. 0 = Double click needed to open or close a node. Default = 1
 
ToolTipWidth
This parameter is used to specify the width of the tooltip window as a percentage of the applet width.
The parameter can be anything from 0 to 100
Default = 100
 
ToolTipDelay
This parameter is used to specify the delay in milliseconds between the mouse pointer becoming stationary over a node and the tooltip being shown.
The parameter can be any number value
Default = 1000 (1 second)