<?xml version="1.0" encoding="Windows-1255" ?><Class name="Interactor" inherit="core.gml:Configurable" alias="interactor" hierarchy="GMLDOM" id="core.gml:Interactor" sort="21" urn="core.gml:elements.Interactor.gs" toc="\Elements"><Summary>Represents tightly coupled unit of interaction, that enables the user to view application data and to carry out related tasks.
   Interactors are displayed in rectangular regions and are arranged using a hierarchy of containers to form the user interface display.</Summary><Inherit>&lt;q ref=&quot;core.gml:Configurable&quot;&gt;Configurable&lt;/q&gt;</Inherit><Copyright>(c) SAP AG 2003-2006. All rights reserved.</Copyright>
<Topics>
<Property name="actions" strong="Yes" type="Action![id]" modifier="strong" typeRef="&lt;q ref=&quot;core.gml:Action&quot;&gt;Action&lt;/q&gt;[id]" access="RW" sortGroup="true" scope="public" id="core.gml:Interactor!actions" sort="34" group="Properties" seq="0000"><Summary>The actions of this interactor.</Summary></Property>
<Property name="colspan" type="Number" default="3" access="RW" sortGroup="true" scope="public" id="core.gml:Interactor!colspan" sort="34" group="Properties" seq="0001"><Summary>Column Layout specific. Gets or sets interactor's colspan.</Summary></Property>
<Property name="index" type="Number" default="0" access="RW" sortGroup="true" scope="public" id="core.gml:Interactor!index" sort="34" group="Properties" seq="0002"><Summary>Defines the index of this object in its parent object layout calculation.</Summary></Property>
<Property name="pos" type="String" default="'0 0'" access="RW" sortGroup="true" scope="public" id="core.gml:Interactor!pos" sort="34" group="Properties" seq="0003"><Summary>Position, in format 'X Y', of this object in its parent UI container, in parent client coordinates.</Summary></Property>
<Property name="showInLayout" access="RO" type="Boolean" default="true" sortGroup="true" scope="public" id="core.gml:Interactor!showInLayout" sort="34" group="Properties" seq="0004"><Summary>Specifies if this object is drawn in the Layout Board. Design-time only.</Summary></Property>
<Property name="showPagingbar" type="Boolean" default="false" access="RW" sortGroup="true" scope="public" id="core.gml:Interactor!showPagingbar" sort="34" group="Properties" seq="0005"><Summary>Indicates whether to show the paging bar, if applicable.</Summary></Property>
<Property name="showTitlebar" type="Boolean" default="true" access="RW" sortGroup="true" scope="public" id="core.gml:Interactor!showTitlebar" sort="34" group="Properties" seq="0006"><Summary>Indicates whether to show the title bar, if applicable.</Summary></Property>
<Property name="showToolbar" type="Boolean" default="false" access="RW" sortGroup="true" scope="public" id="core.gml:Interactor!showToolbar" sort="34" group="Properties" seq="0007"><Summary>Indicates whether to show the toolbar, if applicable.</Summary><Remarks>Event if this property is &lt;code&gt;false,&lt;/code&gt; the &lt;q ref=&quot;core.gml:Interactor!toolbar&quot;&gt;toolbar&lt;/q&gt; property can have valid toolbar defintion.
      In such case, the toolbar will not be displayed.</Remarks></Property>
<Property name="size" type="String" default="'320 240'" access="RW" sortGroup="true" scope="public" id="core.gml:Interactor!size" sort="34" group="Properties" seq="0008"><Summary>Size, in format 'W H', of this object on the screen.</Summary></Property>
<Property name="toolbar" strong="Yes" type="Toolbar!" modifier="strong" typeRef="&lt;q ref=&quot;core.gml:Toolbar&quot;&gt;Toolbar&lt;/q&gt;" access="RW" sortGroup="true" scope="public" id="core.gml:Interactor!toolbar" sort="34" group="Properties" seq="0009"><Summary>Defines interactor's toolbar, if any.</Summary></Property>
<Method name="createControl" sortGroup="true" scope="public" id="core.gml:Interactor!createControl" sort="35" group="Methods" seq="0010"><Summary>Create a new control and insert it to the Interactor.</Summary><Parameters signature="method:: &lt;i&gt;interactor&lt;/i&gt;.&lt;b&gt;createControl&lt;/b&gt;(&lt;i&gt;controlClass&lt;/i&gt;, &lt;i&gt;group&lt;/i&gt;, &lt;i&gt;values&lt;/i&gt;) &amp;rarr; &lt;q ref=&quot;core.gml:Control&quot;&gt;Control&lt;/q&gt;"><Param name="controlClass" type="String">The control class name to be created.</Param><Param name="group" type="gml:ControlGroup" default="null" typeRef="&lt;q ref=&quot;core.gml:ControlGroup&quot;&gt;ControlGroup&lt;/q&gt;">A group to which this new control will be inserted. If &lt;code&gt;null&lt;/code&gt; the new control is inserted as a direct child of Interactor.</Param><Param name="values" default="" type="Variant[id]">A collection of property values for initializing the new Control.</Param></Parameters><Return type="gml:Control" typeRef="&lt;q ref=&quot;core.gml:Control&quot;&gt;Control&lt;/q&gt;">The control that was addded to the Interactor, or &lt;code&gt;null&lt;/code&gt; on failure.</Return></Method>
<Method name="getActionByControl" sortGroup="true" scope="public" id="core.gml:Interactor!getActionByControl" sort="35" group="Methods" seq="0011"><Summary>Gets the action associated with the given control.</Summary><Parameters signature="method:: &lt;i&gt;interactor&lt;/i&gt;.&lt;b&gt;getActionByControl&lt;/b&gt;(&lt;i&gt;controlId&lt;/i&gt;) &amp;rarr; &lt;q ref=&quot;core.gml:Action&quot;&gt;Action&lt;/q&gt;"><Param name="controlId" type="String">A control id.</Param></Parameters><Return type="gml:Action" typeRef="&lt;q ref=&quot;core.gml:Action&quot;&gt;Action&lt;/q&gt;">Returns the action associated with the given control.</Return></Method>
<Method name="getActionById" sortGroup="true" scope="public" id="core.gml:Interactor!getActionById" sort="35" group="Methods" seq="0012"><Summary>Get action by id.</Summary><Parameters signature="method:: &lt;i&gt;interactor&lt;/i&gt;.&lt;b&gt;getActionById&lt;/b&gt;(&lt;i&gt;id&lt;/i&gt;) &amp;rarr; &lt;q ref=&quot;core.gml:Action&quot;&gt;Action&lt;/q&gt;"><Param name="id" type="String">The id of an action.</Param></Parameters><Return type="gml:Action" typeRef="&lt;q ref=&quot;core.gml:Action&quot;&gt;Action&lt;/q&gt;">The action which matches the given id.</Return></Method>
<Method name="getActions" sortGroup="true" scope="public" id="core.gml:Interactor!getActions" sort="35" group="Methods" seq="0013"><Summary>Returns the actions of this Interactor.</Summary><Parameters signature="method:: &lt;i&gt;interactor&lt;/i&gt;.&lt;b&gt;getActions&lt;/b&gt;() &amp;rarr; &lt;q ref=&quot;core.gml:Action&quot;&gt;Action&lt;/q&gt;[]"></Parameters><Return type="gml:Action![]" typeRef="&lt;q ref=&quot;core.gml:Action&quot;&gt;Action&lt;/q&gt;[]">The collection of actions in this interactor.</Return></Method>
<Method name="getAllowedControls" sortGroup="true" scope="public" id="core.gml:Interactor!getAllowedControls" sort="35" group="Methods" seq="0014"><Summary>Get list of control classes that can be added to this interactor, as children of the group (parameter).</Summary><Parameters signature="method:: &lt;i&gt;interactor&lt;/i&gt;.&lt;b&gt;getAllowedControls&lt;/b&gt;(&lt;i&gt;parent&lt;/i&gt;) &amp;rarr; String![]"><Param name="parent" type="gml:Element" typeRef="&lt;q ref=&quot;core.gml:Element&quot;&gt;Element&lt;/q&gt;">The element that will be the parent of the added controls.</Param></Parameters><Return type="String![]">A collection of names of the control-classes that can be added to the group.</Return></Method>
<Method name="getControl" sortGroup="true" scope="public" id="core.gml:Interactor!getControl" sort="35" group="Methods" seq="0015"><Summary>Get control by field id.</Summary><Parameters signature="method:: &lt;i&gt;interactor&lt;/i&gt;.&lt;b&gt;getControl&lt;/b&gt;(&lt;i&gt;fieldId&lt;/i&gt;) &amp;rarr; &lt;q ref=&quot;core.gml:Field&quot;&gt;Field&lt;/q&gt;"><Param name="fieldId" type="fieldId">The Id of the field attached to the control.</Param></Parameters><Return type="gml:Field" typeRef="&lt;q ref=&quot;core.gml:Field&quot;&gt;Field&lt;/q&gt;">The field attached to the control.</Return></Method>
<Method name="getControlByActionId" sortGroup="true" scope="public" id="core.gml:Interactor!getControlByActionId" sort="35" group="Methods" seq="0016"><Summary>Gets the control associated with the given action.</Summary><Parameters signature="method:: &lt;i&gt;interactor&lt;/i&gt;.&lt;b&gt;getControlByActionId&lt;/b&gt;(&lt;i&gt;actionId&lt;/i&gt;) &amp;rarr; &lt;q ref=&quot;core.gml:Control&quot;&gt;Control&lt;/q&gt;"><Param name="actionId" type="String">An action id.</Param></Parameters><Return type="gml:Control" typeRef="&lt;q ref=&quot;core.gml:Control&quot;&gt;Control&lt;/q&gt;">Returns the control associated with the given action.</Return></Method>
<Method name="getControls" sortGroup="true" scope="public" id="core.gml:Interactor!getControls" sort="35" group="Methods" seq="0017"><Summary>Get Interactor controls.</Summary><Parameters signature="method:: &lt;i&gt;interactor&lt;/i&gt;.&lt;b&gt;getControls&lt;/b&gt;(&lt;i&gt;deep&lt;/i&gt;) &amp;rarr; &lt;q ref=&quot;core.gml:Control&quot;&gt;Control&lt;/q&gt;[]"><Param name="deep" type="b:false">Defines if the method will also return inner controls, residing in control groups.</Param></Parameters><Return type="Control![]" typeRef="&lt;q ref=&quot;core.gml:Control&quot;&gt;Control&lt;/q&gt;[]">The collection of controls.</Return></Method>
<Method name="getControlsByField" sortGroup="true" scope="public" id="core.gml:Interactor!getControlsByField" sort="35" group="Methods" seq="0018"><Summary>Get controls by field id.</Summary><Parameters signature="method:: &lt;i&gt;interactor&lt;/i&gt;.&lt;b&gt;getControlsByField&lt;/b&gt;(&lt;i&gt;fieldId&lt;/i&gt;) &amp;rarr; &lt;q ref=&quot;core.gml:Control&quot;&gt;Control&lt;/q&gt;[id]"><Param name="fieldId" type="fieldId">The Id of the field attached to the control.</Param></Parameters><Return type="gml:Control[id]" typeRef="&lt;q ref=&quot;core.gml:Control&quot;&gt;Control&lt;/q&gt;[id]">Returns all the controls that are bound to the field.</Return></Method>
<Method name="getToolbarAllowedControls" sortGroup="true" scope="public" id="core.gml:Interactor!getToolbarAllowedControls" sort="35" group="Methods" seq="0019"><Summary>getToolbarAllowedControls.</Summary><Parameters signature="method:: &lt;i&gt;interactor&lt;/i&gt;.&lt;b&gt;getToolbarAllowedControls&lt;/b&gt;(&lt;i&gt;group&lt;/i&gt;) &amp;rarr; String![]"><Param name="group" type="gml:ControlGroup">The group that will host the newly created control.</Param></Parameters><Return type="String![]">A collection of names of the control-classes that can be added to the group.</Return></Method>
<Method name="insertAction" sortGroup="true" scope="public" id="core.gml:Interactor!insertAction" sort="35" group="Methods" seq="0020"><Summary>Insert an action to the interactor.</Summary><Parameters signature="method:: &lt;i&gt;interactor&lt;/i&gt;.&lt;b&gt;insertAction&lt;/b&gt;(&lt;i&gt;action&lt;/i&gt;, &lt;i&gt;group&lt;/i&gt;) &amp;rarr; bool"><Param name="action" type="Action">The action to be added.</Param><Param name="group" type="gml:ControlGroup" default="null" typeRef="&lt;q ref=&quot;core.gml:ControlGroup&quot;&gt;ControlGroup&lt;/q&gt;">A group to which this new control will be inserted. If &lt;code&gt;null&lt;/code&gt; the new control is inserted as a direct child of Interactor.</Param></Parameters><Return type="bool">Return true iff the indertion of the control succeeded.</Return></Method>
<Method name="insertControl" sortGroup="true" scope="public" id="core.gml:Interactor!insertControl" sort="35" group="Methods" seq="0021"><Summary>Insert control to the interactor/group.</Summary><Parameters signature="method:: &lt;i&gt;interactor&lt;/i&gt;.&lt;b&gt;insertControl&lt;/b&gt;(&lt;i&gt;control&lt;/i&gt;, &lt;i&gt;group&lt;/i&gt;) &amp;rarr; bool"><Param name="control" type="Control">The control to be added.</Param><Param name="group" type="gml:ControlGroup" default="null" typeRef="&lt;q ref=&quot;core.gml:ControlGroup&quot;&gt;ControlGroup&lt;/q&gt;">A group to which this new control will be inserted. If &lt;code&gt;null&lt;/code&gt; the new control is inserted as a direct child of Interactor.</Param></Parameters><Return type="bool">Return true iff the indertion of the control succeeded.</Return><Remarks>If the control already belongs to another parent , then it will be removed from the old parent as part of this operation.</Remarks></Method>
<Method name="notifyOnInfoshapeChange" sortGroup="true" scope="public" id="core.gml:Interactor!notifyOnInfoshapeChange" sort="35" group="Methods" seq="0022"><Summary>A callback method that is called if this object's &lt;q ref=&quot;core.gml:RefInfoshape&quot;&gt;RefInfoshape&lt;/q&gt; is modified, or the &lt;q ref=&quot;core.gml:BOInfoshape&quot;&gt;BOInfoshape&lt;/q&gt; object it points to is modified.</Summary><Parameters signature="method:: &lt;i&gt;interactor&lt;/i&gt;.&lt;b&gt;notifyOnInfoshapeChange&lt;/b&gt;(&lt;i&gt;changeType&lt;/i&gt;, &lt;i&gt;changeData&lt;/i&gt;) &amp;rarr; void"><Param name="changeType" type="Infoshape!INFOSHAPE_CHANGE" typeRef="&lt;q ref=&quot;core.gml:Infoshape!INFOSHAPE_CHANGE&quot;&gt;INFOSHAPE_CHANGE&lt;/q&gt;">the type of change of infoshape.</Param><Param name="changeData" type="Variant">An object containing data related to the change in the infoshape.</Param></Parameters><Return></Return><Remarks>&lt;ul&gt;&lt;li&gt;See more details on the parameters passed to this method in &lt;q ref=&quot;core.gml:Infoshape!notifyOnChange&quot;&gt;notifyOnChange&lt;/q&gt;. &lt;/li&gt;&lt;li&gt;Override this method to handle changes in this object as a result of changes in the related infoshape. &lt;/li&gt;&lt;/ul&gt;</Remarks></Method>
<Method name="onBOFieldsAdd" sortGroup="true" scope="public" id="core.gml:Interactor!onBOFieldsAdd" sort="35" group="Methods" seq="0023"><Summary>A callback funtction which been called whenever fields are been added to the BOInfoshape.</Summary><Parameters signature="method:: &lt;i&gt;interactor&lt;/i&gt;.&lt;b&gt;onBOFieldsAdd&lt;/b&gt;(&lt;i&gt;fields&lt;/i&gt;) &amp;rarr; void"><Param name="fields" type="Field![]" typeRef="&lt;q ref=&quot;core.gml:Field&quot;&gt;Field&lt;/q&gt;[]">An array of fields object.</Param></Parameters><Return></Return></Method>
<Method name="onBOFieldsRemove" sortGroup="true" scope="public" id="core.gml:Interactor!onBOFieldsRemove" sort="35" group="Methods" seq="0024"><Summary>A callback function which been called whenever fields are been removed from the BOInfoshape.</Summary><Parameters signature="method:: &lt;i&gt;interactor&lt;/i&gt;.&lt;b&gt;onBOFieldsRemove&lt;/b&gt;(&lt;i&gt;fields&lt;/i&gt;) &amp;rarr; void"><Param name="fields" type="Field![]" typeRef="&lt;q ref=&quot;core.gml:Field&quot;&gt;Field&lt;/q&gt;[]">An array of fields object.</Param></Parameters><Return></Return></Method>
<Method name="onBOFieldUpdate" sortGroup="true" scope="public" id="core.gml:Interactor!onBOFieldUpdate" sort="35" group="Methods" seq="0025"><Summary>A callback function which been called whenever a field has been update in the BOInfoshape.</Summary><Parameters signature="method:: &lt;i&gt;interactor&lt;/i&gt;.&lt;b&gt;onBOFieldUpdate&lt;/b&gt;(&lt;i&gt;field&lt;/i&gt;, &lt;i&gt;evt&lt;/i&gt;) &amp;rarr; void"><Param name="field" type="Field!" typeRef="&lt;q ref=&quot;core.gml:Field&quot;&gt;Field&lt;/q&gt;">A field object.</Param><Param name="evt" type="Object">An event object.</Param></Parameters><Return></Return></Method>
<Method name="onBOInfoshapesReplace" sortGroup="true" scope="public" id="core.gml:Interactor!onBOInfoshapesReplace" sort="35" group="Methods" seq="0026"><Summary>A callback function which is executed whenever BOInfoshape is replaced for the interactor.</Summary><Parameters signature="method:: &lt;i&gt;interactor&lt;/i&gt;.&lt;b&gt;onBOInfoshapesReplace&lt;/b&gt;(&lt;i&gt;oldBO&lt;/i&gt;, &lt;i&gt;newBO&lt;/i&gt;) &amp;rarr; void"><Param name="oldBO" type="gml:BOInfoshape">The old BOInfoshape.</Param><Param name="newBO" type="gml:BOInfoshape">The new BOInfoshape.</Param></Parameters><Return></Return></Method>
<Method name="removeAction" sortGroup="true" scope="public" id="core.gml:Interactor!removeAction" sort="35" group="Methods" seq="0027"><Summary>Remove an action from the interactor.</Summary><Parameters signature="method:: &lt;i&gt;interactor&lt;/i&gt;.&lt;b&gt;removeAction&lt;/b&gt;(&lt;i&gt;action&lt;/i&gt;) &amp;rarr; Boolean"><Param name="action" type="gml:Action" typeRef="&lt;q ref=&quot;core.gml:Action&quot;&gt;Action&lt;/q&gt;">The control to be deleted.</Param></Parameters><Return type="Boolean">Returns &lt;code&gt;true&lt;/code&gt; if the control has been deleted.</Return></Method>
<Method name="removeAllControls" sortGroup="true" scope="public" id="core.gml:Interactor!removeAllControls" sort="35" group="Methods" seq="0028"><Summary>Removes all controls.</Summary><Parameters signature="method:: &lt;i&gt;interactor&lt;/i&gt;.&lt;b&gt;removeAllControls&lt;/b&gt;() &amp;rarr; void"></Parameters><Return></Return></Method>
<Method name="removeControl" sortGroup="true" scope="public" id="core.gml:Interactor!removeControl" sort="35" group="Methods" seq="0029"><Summary>Remove control from the interactor.</Summary><Parameters label="Form 1" descr="DEPRECATED: use instead removeControlsByField method. Remove Control from the interactor by the field that it's strongly bind to." signature="method:: &lt;i&gt;interactor&lt;/i&gt;.&lt;b&gt;removeControl&lt;/b&gt;(&lt;i&gt;field&lt;/i&gt;) &amp;rarr; Boolean"><Param name="field" type="gml:Field" typeRef="&lt;q ref=&quot;core.gml:Field&quot;&gt;Field&lt;/q&gt;">The Field attached to the control.</Param></Parameters><Parameters label="Form 2" descr="Remove Control from the interactor." signature="method:: &lt;i&gt;interactor&lt;/i&gt;.&lt;b&gt;removeControl&lt;/b&gt;(&lt;i&gt;control&lt;/i&gt;) &amp;rarr; Boolean"><Param name="control" type="gml:Control" typeRef="&lt;q ref=&quot;core.gml:Control&quot;&gt;Control&lt;/q&gt;">The control to be deleted.</Param></Parameters><Return type="Boolean">Returns &lt;code&gt;true&lt;/code&gt; if the control has been deleted.</Return></Method>
<Method name="removeControlByField" sortGroup="true" scope="public" id="core.gml:Interactor!removeControlByField" sort="35" group="Methods" seq="0030"><Summary>Remove the control that is attached to the field.</Summary><Parameters signature="method:: &lt;i&gt;interactor&lt;/i&gt;.&lt;b&gt;removeControlByField&lt;/b&gt;(&lt;i&gt;field&lt;/i&gt;) &amp;rarr; Boolean"><Param name="field" type="gml:Field" typeRef="&lt;q ref=&quot;core.gml:Field&quot;&gt;Field&lt;/q&gt;">The field which is strongly attached to a control.</Param></Parameters><Return type="Boolean">Returns &lt;code&gt;true&lt;/code&gt; if the control has been deleteted.</Return></Method>
<Method name="removeControlsByField" sortGroup="true" scope="public" id="core.gml:Interactor!removeControlsByField" sort="35" group="Methods" seq="0031"><Summary>Remove controls that are attached to the field.</Summary><Parameters signature="method:: &lt;i&gt;interactor&lt;/i&gt;.&lt;b&gt;removeControlsByField&lt;/b&gt;(&lt;i&gt;field&lt;/i&gt;) &amp;rarr; Boolean"><Param name="field" type="gml:Field" typeRef="&lt;q ref=&quot;core.gml:Field&quot;&gt;Field&lt;/q&gt;">The field which is strongly attached to a control.</Param></Parameters><Return type="Boolean">Returns &lt;code&gt;true&lt;/code&gt; if the control has been deleteted.</Return></Method>
</Topics>
</Class>