<?xml version="1.0" encoding="Windows-1255" ?><Interface name="KitTabs" alias="$ENV" id="core.env:KitTabs" sort="23" urn="core.env:extensions.KitTabs.js" toc="\Extension Points"><Summary>Extension point for defining kit design tabs.</Summary><Copyright>(c) SAP AG 2003-2006. All rights reserved.</Copyright>
<Topics>
<Method name="defineTab" sortGroup="true" scope="public" id="core.env:KitTabs!defineTab" sort="35" group="Methods" seq="0000"><Summary>Defines a new design Tab.</Summary><Parameters signature="method:: &lt;i&gt;$ENV&lt;/i&gt;.&lt;b&gt;defineTab&lt;/b&gt;(&lt;i&gt;def&lt;/i&gt;) &amp;rarr; &lt;q ref=&quot;core.env:KitTabs!TAB_DEF&quot;&gt;TAB_DEF&lt;/q&gt;"><Param name="def" type="TAB_DEF" typeRef="&lt;q ref=&quot;core.env:KitTabs!TAB_DEF&quot;&gt;TAB_DEF&lt;/q&gt;">The new Tab definition.</Param></Parameters><Return type="TAB_DEF" typeRef="&lt;q ref=&quot;core.env:KitTabs!TAB_DEF&quot;&gt;TAB_DEF&lt;/q&gt;">The newly defined Tab.</Return><Remarks>&lt;h2&gt;Xml definition of a Tab in a configuration file&lt;/h2&gt;
   &lt;pre&gt;

   &amp;lt;CONFIGURE type=&amp;quot;TABS&amp;quot;&amp;gt;
   ?  &amp;lt;HEADER&amp;gt;
   ?     &amp;lt;PRAGMA&amp;gt;# Pragmas section&amp;lt;/PRAGMA&amp;gt;
   ?     &amp;lt;SCRIPT&amp;gt;# Code section. Place here functions\variables
                   which you want to address from within the Tab tags
         &amp;lt;/SCRIPT&amp;gt;
      &amp;lt;/HEADER&amp;gt;
      &amp;lt;TABS&amp;gt;
   +    &amp;lt;TAB id=&amp;quot;com.sap.mypackage:TabId&amp;quot;&amp;gt;
            # For complete description of Tab
            definition see &lt;q ref=&quot;core.env:KitTabs!TAB_DEF&quot;&gt;TAB_DEF&lt;/q&gt;
   ?        &amp;lt;PROPERTIES&amp;gt;
   *             &amp;lt;propertyName type=&amp;quot;[function | ]&amp;quot;/&amp;gt;
                     # Represents a property of the Tab
                     You can assign the 'type' attribute for
                     evaluating the value of the property
                     as a function
            &amp;lt;/PROPERTIES&amp;gt;
         &amp;lt;/TAB&amp;gt;
      &amp;lt;/TABS&amp;gt;
   &amp;lt;/CONFIGURE&amp;gt;
   &lt;/pre&gt;
   &lt;h2&gt;Example&lt;/h2&gt;
   &lt;pre&gt;
   &amp;lt;CONFIGURE type=&amp;quot;TABS&amp;quot;&amp;gt;
      &amp;lt;TABS&amp;gt;
         &amp;lt;TAB id=&amp;quot;core.svg:DRAWING_TAB&amp;quot;&amp;gt;
            &amp;lt;PROPERTIES&amp;gt;
               &amp;lt;aspect&amp;gt;core.svg:GmlDrawing&amp;lt;/aspect&amp;gt;
               &amp;lt;name&amp;gt;Drawing Tab&amp;lt;/name&amp;gt;
               &amp;lt;type&amp;gt;SVG&amp;lt;/type&amp;gt;
               &amp;lt;impl&amp;gt;#URL[core.svg:boards.DrawingBoard.htm]&amp;lt;/impl&amp;gt;
            &amp;lt;/PROPERTIES&amp;gt;
         &amp;lt;/TAB&amp;gt;
      &amp;lt;/TABS&amp;gt;
   &amp;lt;/CONFIGURE&amp;gt;
   &lt;/pre&gt;</Remarks></Method>
<Method name="getSelectedTabs" sortGroup="true" scope="public" id="core.env:KitTabs!getSelectedTabs" sort="35" group="Methods" seq="0001"><Summary>Returns the Tab definitions that belong to a given category, sorted by priority.</Summary><Parameters signature="method:: &lt;i&gt;$ENV&lt;/i&gt;.&lt;b&gt;getSelectedTabs&lt;/b&gt;(&lt;i&gt;category&lt;/i&gt;) &amp;rarr; &lt;q ref=&quot;core.env:KitTabs!TAB_DEF&quot;&gt;TAB_DEF&lt;/q&gt;[]"><Param name="category" type="String">The requested editors category.</Param></Parameters><Return type="TAB_DEF[]" typeRef="&lt;q ref=&quot;core.env:KitTabs!TAB_DEF&quot;&gt;TAB_DEF&lt;/q&gt;[]">Array of selected Tab definitions.</Return></Method>
<Method name="getTab" sortGroup="true" scope="public" id="core.env:KitTabs!getTab" sort="35" group="Methods" seq="0002"><Summary>Returns a specified Tab definition.</Summary><Parameters signature="method:: &lt;i&gt;$ENV&lt;/i&gt;.&lt;b&gt;getTab&lt;/b&gt;(&lt;i&gt;id&lt;/i&gt;) &amp;rarr; &lt;q ref=&quot;core.env:KitTabs!TAB_DEF&quot;&gt;TAB_DEF&lt;/q&gt;"><Param name="id" type="QName">Tab Id.</Param></Parameters><Return type="TAB_DEF" typeRef="&lt;q ref=&quot;core.env:KitTabs!TAB_DEF&quot;&gt;TAB_DEF&lt;/q&gt;">The requested Tab definition.</Return></Method>
<Method name="getTabsTable" sortGroup="true" scope="public" id="core.env:KitTabs!getTabsTable" sort="35" group="Methods" seq="0003"><Summary>Returns the complete Tabs definitions table.</Summary><Parameters signature="method:: &lt;i&gt;$ENV&lt;/i&gt;.&lt;b&gt;getTabsTable&lt;/b&gt;() &amp;rarr; &lt;q ref=&quot;core.env:KitTabs!TAB_DEF&quot;&gt;TAB_DEF&lt;/q&gt;[id]"></Parameters><Return type="TAB_DEF[id]" typeRef="&lt;q ref=&quot;core.env:KitTabs!TAB_DEF&quot;&gt;TAB_DEF&lt;/q&gt;[id]">Table of Tabs definitions, indexed by id.</Return><Remarks>Tab id's are stored in uppercase. Use &lt;q ref=&quot;core.lib:Basic!UPPER&quot;&gt;UPPER&lt;/q&gt; macro to convert the Tab name to uppercase
before using it as the index in this table.</Remarks></Method>
<Method name="removeTab" sortGroup="true" scope="public" id="core.env:KitTabs!removeTab" sort="35" group="Methods" seq="0004"><Summary>Removes a specified Tab definition.</Summary><Parameters signature="method:: &lt;i&gt;$ENV&lt;/i&gt;.&lt;b&gt;removeTab&lt;/b&gt;(&lt;i&gt;id&lt;/i&gt;) &amp;rarr; void"><Param name="id" type="QName">The id of the Tab to remove.</Param></Parameters><Return></Return></Method>
<Structure name="TAB_DEF" sortGroup="true" id="core.env:KitTabs!TAB_DEF" sort="41" group="Structures" seq="0005"><Summary>Represents a Storyboard Tab definition.</Summary><Remarks>The TAB_DEF structure is made of:
      &lt;table class=&quot;BOTH&quot;&gt;&lt;tr&gt;&lt;td class=&quot;H V&quot;&gt;Name &lt;/td&gt;&lt;td class=H&gt;Type &lt;/td&gt;&lt;td class=H&gt;Description &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;id &lt;/td&gt;&lt;td&gt;QName &lt;/td&gt;&lt;td&gt;Unique Tab Id - must be prefixed with namespace e.g. com.sap.mypackage:uniqId &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;aspect &lt;/td&gt;&lt;td&gt;QName &lt;/td&gt;&lt;td&gt;Associated aspect role &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;name &lt;/td&gt;&lt;td&gt;String &lt;/td&gt;&lt;td&gt;Tab name &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;type &lt;/td&gt;&lt;td&gt;&lt;q ref=&quot;core.env:KitTabs!TAB_TYPE&quot;&gt;TAB_TYPE&lt;/q&gt; &lt;/td&gt;&lt;td&gt;Tab implementation type &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;impl &lt;/td&gt;&lt;td&gt;String &lt;/td&gt;&lt;td&gt;Tab implementation url &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;tag &lt;/td&gt;&lt;td&gt;String &lt;/td&gt;&lt;td&gt;Tab implementation tag name (for HTC Tabs) &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;visible &lt;/td&gt;&lt;td&gt;Function &lt;/td&gt;&lt;td&gt;Tab's dynamic visibility state. Can be &lt;code&gt;true,&lt;/code&gt; &lt;code&gt;false&lt;/code&gt; or a function: &lt;p style=&quot;margin:10&quot;&gt;&lt;code&gt;flag = visible(&lt;i&gt;definition&lt;/i&gt;)&lt;/code&gt;&lt;/p&gt; Where &lt;code&gt;definition&lt;/code&gt; is this Tab's definition. If the function returns &lt;code&gt;true&lt;/code&gt; the Tab will be visible; otherwise, it will be hidden. If this parameter is omitted, the Tab will be visible by default. &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;priority &lt;/td&gt;&lt;td&gt;Number &lt;/td&gt;&lt;td&gt;Tab's priority &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;category &lt;/td&gt;&lt;td&gt;String &lt;/td&gt;&lt;td&gt;Tab category &lt;/td&gt;&lt;/tr&gt;&lt;/table&gt;</Remarks></Structure>
<Enumeration name="TAB_TYPE" sortGroup="true" id="core.env:KitTabs!TAB_TYPE" sort="42" group="Enumerations" seq="0006"><Summary>An enumeration of the possible Tab implementation types.</Summary><Remarks>&lt;table class=&quot;BOTH&quot;&gt;&lt;tr&gt;&lt;td class=&quot;H V&quot;&gt;Name &lt;/td&gt;&lt;td class=H&gt;Description &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;SVG &lt;/td&gt;&lt;td&gt;A graphical Tab implemented using SVG (e.g., design Tab) &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;HTM &lt;/td&gt;&lt;td&gt;A visual Tab implemented using HTML (e.g., layout Tab, simulator Tab) &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;HTC &lt;/td&gt;&lt;td&gt;A visual Tab implemented using HTC component &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;CODE &lt;/td&gt;&lt;td&gt;A non-visual Tab implemented in code (e.g., code generator, model validator, usability analyzer, etc.) &lt;/td&gt;&lt;/tr&gt;&lt;/table&gt;</Remarks></Enumeration>
</Topics>
</Interface>