Extension point for defining kit task groups/panels.(c) SAP AG 2003-2006. All rights reserved.
Defines a new task group (a collection of related task panels).The task group id - must be prefixed with namespace e.g. com.sap.mypackage:id.The task group description.The newly defined task group.<h2>Xml definition of a taskgroup in a configuration file</h2>
<pre>
<CONFIGURE type="TASKPANELS">
? <HEADER>
? <PRAGMA># Pragmas section</PRAGMA>
? <SCRIPT># Code section. Place here functions\variables
which you want to address from within the taskgroup tags
</SCRIPT>
</HEADER>
<TASKPANELS>
+ <TASKGROUP id="com.sap.mypackage:taskgroupId">
? <PROPERTIES>
<description># The task group description</description>
</PROPERTIES>
<TASKPANEL># task panel node definition. See <q ref="core.env:KitTaskpanels!defineTaskpanel">defineTaskpanel</q>
</TASKPANEL>
</TASKGROUP>
</TASKPANELS>
</CONFIGURE>
</pre>
<h2>Example</h2>
<pre>
<CONFIGURE type="TASKPANELS">
<TASKPANELS>
<TASKGROUP id="BROWSE_MDL_TASKGRP">
<TASKPANEL id="MODEL_REPOSITORY_BROWSER">
<PROPERTIES>
<urn>#URL[common.ManageModelsDlg.htm]</urn>
<title>Browse for model</title>
</PROPERTIES>
</TASKPANEL>
</TASKGROUP>
<TASKPANEL id="OPTIONS">
<PROPERTIES>
<urn>#URL[common.OptionsPanel.htm]</urn>
<title>Options</title>
</PROPERTIES>
</TASKPANEL>
</TASKPANELS>
</CONFIGURE>
</pre>
Defines a new task panel.The task panel to define.The newly defined task panel.Use this method to define an adhoc task panel that does not belong to any task group.
<h2>Xml definition of a taskpanel in a configuration file</h2>
<pre>
<CONFIGURE type="TASKPANELS">
? <HEADER>
? <PRAGMA># Pragmas section</PRAGMA>
? <SCRIPT># Code section. Place here functions\variables
which you want to address from within the taskgroup tags
</SCRIPT>
</HEADER>
<TASKPANELS>
+ <TASKPANEL id="com.sap.mypackage:taskpanelId">
# For complete description of taskpanel
definition see <q ref="core.env:KitTaskpanels!TASK_PANEL">TASK_PANEL</q>
? <PROPERTIES>
<propertyName type="[function | ]"/>
# Represent a property of the taskpanel
You can assign the 'type' attribute for
evaluating the value of the property
as a function
</PROPERTIES>
</TASKPANEL>
</TASKPANELS>
</CONFIGURE>
</pre>
Returns a specified task group definition.The task group id.The requested task group.
Returns the complete task groups table.Table of task group objects, indexed by id.Task group id's are stored in uppercase. Use <q ref="core.lib:Basic!UPPER">UPPER</q> macro to convert the task group id to uppercase
before using it as the index in this table.
Returns a specified task panel definition.The task panel id.The requested task panel.
Removes a specified task group definition.The task group id.
Removes a specified task panel definition.The task panel id.
Represents a group of Storyboard task panels.The TASK_GROUP structure is made of:
The structure members are:
<table class="BOTH"><tr><td class="H V">Name </td><td class=H>Type </td><td class=H>Description </td></tr><tr><td class=V>id </td><td>QName </td><td>Task group Id - id must be prefixed with namespace e.g. com.sap.mypackage:id </td></tr><tr><td class=V>description </td><td>String </td><td>The task group description </td></tr><tr><td class=V>0..n </td><td><q ref="core.env:KitTaskpanels!TASK_PANEL">TASK_PANEL</q> </td><td>The task panels in this task group, indexed by display order </td></tr></table>
In addition, the structure has the following methods:
<h2><i>taskgroup</i>.append(taskpanel, after)</h2>
Appends a task panel just after another task panel in the task group, where:
<table class="SIMPLE" style="width:70%"><tr><td class="H V">Parameter </td><td class=H>Type </td><td class=H>Description </td></tr><tr><td class=V>taskpanel </td><td><q ref="core.env:KitTaskpanels!TASK_PANEL">TASK_PANEL</q> </td><td>The task panel to append </td></tr><tr><td class=V>after </td><td>QName </td><td>Optional. The id of the task panel after which the new item will be appended </td></tr></table>
<ul><li>If <code>after</code> is omitted or not found, the new task panel will be appended at the end of this task group. </li></ul>
<h2>taskpanel = <i>taskgroup</i>.getItem(id)</h2>
Gets s a specified task panel by Id or by position, where:
<table class="SIMPLE" style="width:70%"><tr><td class="H V">Parameter </td><td class=H>Type </td><td class=H>Description </td></tr><tr><td class=V>id </td><td>QName/Number </td><td>The task panel id or ordinal position </td></tr><tr><td class=V>taskpanel </td><td><q ref="core.env:KitTaskpanels!TASK_PANEL">TASK_PANEL</q> </td><td>The requested task panel </td></tr></table>
<h2><i>taskgroup</i>.insert(taskpanel, before)</h2>
Inserts a task panel just before another task panel in the task group, where:
<table class="SIMPLE" style="width:70%"><tr><td class="H V">Parameter </td><td class=H>Type </td><td class=H>Description </td></tr><tr><td class=V>taskpanel </td><td><q ref="core.env:KitTaskpanels!TASK_PANEL">TASK_PANEL</q> </td><td>The task panel to insert </td></tr><tr><td class=V>before </td><td>QName </td><td>Optional. The id of the task panel before which the new item will be inserted </td></tr></table>
<ul><li>If <code>before</code> is omitted, the new task panel will be inserted at the beginning of this task group. </li><li>If <code>before</code> is not found, the new item will be inserted at the end of this task group. </li></ul>
<h2><i>taskgroup</i>.remove(id)</h2>
Removes a task panel from the task group, where:
<table class="SIMPLE" style="width:70%"><tr><td class="H V">Parameter </td><td class=H>Type </td><td class=H>Description </td></tr><tr><td class=V>id </td><td>QName </td><td>The Id of the task panel to remove </td></tr></table>
Represents a Storyboard task panel definition.The TASK_PANEL structure is made of:
<table class="BOTH"><tr><td class="H V">Name </td><td class=H>Type </td><td class=H>Description </td></tr><tr><td class=V>id </td><td>QName </td><td>Task panel Id - id must be prefixed with namespace e.g. com.sap.mypackage:id </td></tr><tr><td class=V>urn </td><td>String </td><td>Urn of the task panel implementation </td></tr><tr><td class=V>title </td><td>String </td><td>Task panel title </td></tr><tr><td class=V>isDefault </td><td>Boolean </td><td>Indicates whether this is the default task panel </td></tr><tr><td class=V>group </td><td><q ref="core.env:KitTaskpanels!TASK_GROUP">TASK_GROUP</q> </td><td>The task group that owns this task panel. This member is automatically set by system and should not be specified directly. </td></tr></table>