<?xml version="1.0" encoding="Windows-1255" ?><Interface name="KitHelpers" alias="$ENV" id="core.env:KitHelpers" sort="23" urn="core.env:extensions.KitHelpers.js" toc="\Extension Points"><Summary>Extension point for defining kit helper objects.</Summary><Copyright>(c) SAP AG 2003-2006. All rights reserved.</Copyright>
<Topics>
<Method name="defineHelper" sortGroup="true" scope="public" id="core.env:KitHelpers!defineHelper" sort="35" group="Methods" seq="0000"><Summary>Defines a new helper object/function.</Summary><Parameters label="Form 1" descr="Define a helper object." signature="method:: &lt;i&gt;$ENV&lt;/i&gt;.&lt;b&gt;defineHelper&lt;/b&gt;(&lt;i&gt;className&lt;/i&gt;, &lt;i&gt;args...&lt;/i&gt;) &amp;rarr; &lt;q ref=&quot;core.gml:Object&quot;&gt;Object&lt;/q&gt;"><Param name="className" type="String">The name of the helper class (must be a class inherited from &lt;q ref=&quot;core.gml:Object&quot;&gt;Object&lt;/q&gt;).</Param><Param name="args..." type="Arguments">A variable list of arguments to pass to the helper class constructor.</Param></Parameters><Parameters label="Form 2" descr="Define a helper function." signature="method:: &lt;i&gt;$ENV&lt;/i&gt;.&lt;b&gt;defineHelper&lt;/b&gt;(&lt;i&gt;funcName&lt;/i&gt;, &lt;i&gt;func&lt;/i&gt;) &amp;rarr; &lt;q ref=&quot;core.gml:Object&quot;&gt;Object&lt;/q&gt;"><Param name="funcName" type="String">The name of the helper function (must be fully qualified).</Param><Param name="func" type="Function">The function object.</Param></Parameters><Parameters label="Form 3" descr="Define a helper anonymous object." signature="method:: &lt;i&gt;$ENV&lt;/i&gt;.&lt;b&gt;defineHelper&lt;/b&gt;(&lt;i&gt;objStruct&lt;/i&gt;, &lt;i&gt;objName&lt;/i&gt;) &amp;rarr; &lt;q ref=&quot;core.gml:Object&quot;&gt;Object&lt;/q&gt;"><Param name="objStruct" type="Object">The object.</Param><Param name="objName" type="String">The name of the helper object (must be fully qualified).</Param></Parameters><Return type="gml:Object!" typeRef="&lt;q ref=&quot;core.gml:Object&quot;&gt;Object&lt;/q&gt;">The newly defined helper object/function, or &lt;code&gt;null&lt;/code&gt; in case of any error.</Return><Remarks>Helper objects defined using the first form must have an &lt;code&gt;id&lt;/code&gt; property (either declared as a property in the class, or initialized by the Arguments collection)
    - the &lt;code&gt;id&lt;/code&gt; must be prefixed with namespace e.g. com.sap.mypackage:id
      &lt;h2&gt;Xml definition of a helper in a configuration file&lt;/h2&gt;
      &lt;pre&gt;
      &amp;lt;CONFIGURE type=&amp;quot;HELPERS&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 helper tags
            &amp;lt;/SCRIPT&amp;gt;
         &amp;lt;/HEADER&amp;gt;
         &amp;lt;HELPERS&amp;gt;
      +     &amp;lt;HELPER&amp;gt;
      ?        &amp;lt;PROPERTIES&amp;gt;
                 &amp;lt;classname&amp;gt;# The name of the helper class
                 &amp;lt;/classname&amp;gt;
               &amp;lt;/PROPERTIES&amp;gt;
               &amp;lt;ARGS&amp;gt;
      *          &amp;lt;arg&amp;gt;# An argument to pass to the helper class constructor.
                        See further explanations about ARGS in
                        XML definition of channel: &lt;q ref=&quot;core.env:KitChannels!defineChannel&quot;&gt;defineChannel&lt;/q&gt;
                 &amp;lt;/arg&amp;gt;
               &amp;lt;/ARGS&amp;gt;
            &amp;lt;/HELPER&amp;gt;
         &amp;lt;/HELPERS&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;HELPERS&amp;quot;&amp;gt;
         &amp;lt;HELPERS&amp;gt;
            &amp;lt;HELPER&amp;gt;
               &amp;lt;PROPERTIES&amp;gt;
                  &amp;lt;classname&amp;gt;com.sap.vctests:HelperClass&amp;lt;/classname&amp;gt;
               &amp;lt;/PROPERTIES&amp;gt;
               &amp;lt;ARGS&amp;gt;
                  &amp;lt;arg&amp;gt;{id: &amp;quot;someid&amp;quot;}&amp;lt;/arg&amp;gt;
               &amp;lt;/ARGS&amp;gt;
            &amp;lt;/HELPER&amp;gt;
         &amp;lt;/HELPERS&amp;gt;
      &amp;lt;/CONFIGURE&amp;gt;
      &lt;/pre&gt;</Remarks></Method>
<Method name="executeHelper" sortGroup="true" scope="public" id="core.env:KitHelpers!executeHelper" sort="35" group="Methods" seq="0001"><Summary>Executes a specified helper function.</Summary><Parameters signature="method:: &lt;i&gt;$ENV&lt;/i&gt;.&lt;b&gt;executeHelper&lt;/b&gt;(&lt;i&gt;id&lt;/i&gt;, &lt;i&gt;args...&lt;/i&gt;) &amp;rarr; Variant"><Param name="id" type="QName">The Id of the helper function to execute.</Param><Param name="args..." type="Arguments">A variable list of arguments to pass to the helper function.</Param></Parameters><Return type="Variant">The helper function result.</Return></Method>
<Method name="getHelper" sortGroup="true" scope="public" id="core.env:KitHelpers!getHelper" sort="35" group="Methods" seq="0002"><Summary>Returns a specified helper object/function.</Summary><Parameters signature="method:: &lt;i&gt;$ENV&lt;/i&gt;.&lt;b&gt;getHelper&lt;/b&gt;(&lt;i&gt;id&lt;/i&gt;) &amp;rarr; &lt;q ref=&quot;core.gml:Object&quot;&gt;Object&lt;/q&gt;"><Param name="id" type="QName">The Id of the helper object/function to get.</Param></Parameters><Return type="gml:Object" typeRef="&lt;q ref=&quot;core.gml:Object&quot;&gt;Object&lt;/q&gt;">The requested helper object/function.</Return></Method>
<Method name="getHelpersTable" sortGroup="true" scope="public" id="core.env:KitHelpers!getHelpersTable" sort="35" group="Methods" seq="0003"><Summary>Returns the complete helpers table.</Summary><Parameters signature="method:: &lt;i&gt;$ENV&lt;/i&gt;.&lt;b&gt;getHelpersTable&lt;/b&gt;() &amp;rarr; &lt;q ref=&quot;core.gml:Object&quot;&gt;Object&lt;/q&gt;[id]"></Parameters><Return type="gml:Object[id]" typeRef="&lt;q ref=&quot;core.gml:Object&quot;&gt;Object&lt;/q&gt;[id]">Table of helpers objects, indexed by their identifiers.</Return><Remarks>Helper 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 helper id to uppercase
before using it as the index in this table.</Remarks></Method>
<Method name="removeHelper" sortGroup="true" scope="public" id="core.env:KitHelpers!removeHelper" sort="35" group="Methods" seq="0004"><Summary>Removes a specified helper object/function.</Summary><Parameters signature="method:: &lt;i&gt;$ENV&lt;/i&gt;.&lt;b&gt;removeHelper&lt;/b&gt;(&lt;i&gt;id&lt;/i&gt;) &amp;rarr; void"><Param name="id" type="QName">The Id of the helper object/function to remove.</Param></Parameters><Return></Return></Method>
</Topics>
</Interface>