<?xml version="1.0"?>
<?xml-stylesheet href="../documentation.xsl" type="text/xsl" media="screen"?>
<doc xml:whitespace="preserve">
	<assembly>
		<name>jsUI-Tabstrip</name>
		<code>
			<c>var mytabstrip = new Object();</c>
			<c>mytabstrip = tabstripNew("mytabstrip", "default", "TOP", document.getElementById("tabCell"), null);</c>
			<c>mytabstrip.itemClick = doClick;</c>
			<c>mytabstrip.createTab("tab1", "First Tab", "../images/icon.jpg", 100, false);</c>
		</code>
		<remarks>The tabstrip is a navigation control, based on those frequently found in Windows or the MacOS. It is compatible with Internet Explorer 5.0 and FireFox 1.0 or better.</remarks>
		<requirements>
			<para>jsUI-Global/common.js</para>
			<para>jsUI-Global/uiCommon.js</para>
			<para>jsUI-Tabstrip/component.js</para>
		</requirements>
		<sample>index.htm</sample>
	</assembly>
	<Property>
		<member name="highlight">
			<summary>The HEX value for the colour to be used to indicate a selected tab. If unassigned, the default highlight colour assigned by the skin will be used.</summary>
			<code>mytabstrip.highlight = "#FFFFFF";</code>
		</member>
		<member name="currentTab">
			<summary>Gets the string value containing the DOM ID of the currently selected tab. Read only.</summary>
			<code>alert(mytabstrip.currentTab);</code>
		</member>
		<member name="tabstripParent">
			<summary>The DOM object to which the tabstrip is attached. Frequently a DIV or TD.</summary>
			<code>alert (mytabstrip.tabstripParent.id);</code>
			<remarks>DOM Object. This property is assigned on instantiation and is read only.</remarks>
		</member>
		<member name="rootDir">
			<summary>Gets or sets the string value representing the path to the root of the jsObjects directory. Used for calculating style and graphics file paths. Initially set during instantiation.</summary>
			<code>mytabstrip.rootDir = "http://localhost/libraries/jsobjects";</code>
			<default>http://&lt;server&gt;/jsObjects</default>
			<remarks>String. This value only needs to be set if jsObjects is installed in a custom location.</remarks>
		</member>
	</Property>
	<Method>
		<member name="tabstripNew (string, string, string, object, string)">
			<summary>Instantiates the tabstrip through assignment into a Javascript object.</summary>
			<param name="tabstripName">Required. The name for the new tabstrip. Must match the name of an empty Javascript object to contain the tabstrip.</param>
			<param name="skinName">Optional. The name of the CSS (excluding the extension and path) file to use for the tabstrip. If left blank, "default" will be used.</param>
			<param name="tabLocation">Required. String used to indicate where the tabstrip floats. Use either "Top" or "Bottom".</param>
			<param name="tabstripParent">Optional. The DOM object that the tabstrip is to be attached to. If no value is passed, the tabstrip will be appended to document.body</param>
			<param name="rootDir">Optional. The path to the root of the jsObjects directory. If left blank, the default path will be used.</param>
			<code>
				<c>var mytabstrip = new Object();</c>
				<c>mytabstrip = tabstripNew("mytabstrip", "default", "TOP", document.getElementById("tabstripDiv"), "../jsobjects");</c>
			</code>
			<returns>The tabstrip object.</returns>
			<remarks>This is the only method that does not appear to be a member of the object -- because the object can't have members until it's instantiated. A blank object is created and will be filled with the jsUI-Tabstrip members.</remarks>
		</member>
		<member name="createTab (string, string, string, string, boolean)">
			<summary>Creates a tab in the strip.</summary>
			<param name="tabID">Required. A unique string to be used as the DOM ID for the new tab.</param>
			<param name="tabText">Required. The text that appears in the tab.</param>
			<param name="tabIcon">Optional. The path to an image that can be used in the title of the tab. Appears to the left of any tabText value.</param>
			<param name="tabWidth">Optional. The width in pixels for the new tab.</param>
			<param name="selected">Optional. Indicates whether or not the tab should be selected upon creation.</param>
			<returns>Nothing</returns>
		</member>
		<member name="removeTab(string)">
			<summary>Removes a tab from the strip. If the tab is currently selected, the external code should select another tab.</summary>
			<param name="tabID">Required. The ID of the tab to be deleted. Pass the string "all" to remove all tabs.</param>
			<returns>Nothing</returns>
		</member>
		<member name="clickTab(string)">
			<summary>Used to allow external code to select a tab without user intervention.</summary>
			<param name="tabID">Required. The ID of the row to be selected.</param>
			<returns>Nothing</returns>
		</member>
	</Method>
	<Event>
		<member name="itemClick">
			<summary>Fires whenever a tab is clicked, passing the ID of the target object, so that external code can respond.</summary>
			<code>
				mytabstrip.itemClick = <i>handler</i>;
			</code>
			<remarks>The handler should accept one string parameter which will contain the ID of the button clicked.</remarks>
		</member>
	</Event>
</doc>