<?xml version="1.0" encoding="Windows-1255" ?><Class name="ModelContext" inherit="core.gml:Object" alias="context" hierarchy="GMLDOM" id="core.gml:ModelContext" sort="21" urn="core.gml:core.ModelContext.gs" toc="\Core"><Summary>An object that holds the active context, a representation of the unit, element, 
   or field currently in focus.</Summary><Inherit>&lt;q ref=&quot;core.gml:Object&quot;&gt;Object&lt;/q&gt;</Inherit><Remarks>Instances of this class are created automatically by the system, and should
      not be created directly. To access the active context use the 
      &lt;q ref=&quot;core.env:Environment!context&quot;&gt;$ENV.context&lt;/q&gt; property.</Remarks><Copyright>(c) SAP AG 2003-2006. All rights reserved.</Copyright>
<Topics>
<Property name="board" access="RO" type="String" default="''" sortGroup="true" scope="public" id="core.gml:ModelContext!board" sort="34" group="Properties" seq="0000"><Summary>Gets the id of the board in context.</Summary></Property>
<Property name="clipboard" access="RO" type="gml:GmlObject![id]" typeRef="&lt;q ref=&quot;core.gml:GmlObject&quot;&gt;GmlObject&lt;/q&gt;[id]" sortGroup="true" scope="public" id="core.gml:ModelContext!clipboard" sort="34" group="Properties" seq="0001"><Summary>Gets the clipboard collection.</Summary></Property>
<Property name="element" access="RO" type="gml:Element!" typeRef="&lt;q ref=&quot;core.gml:Element&quot;&gt;Element&lt;/q&gt;" sortGroup="true" scope="public" id="core.gml:ModelContext!element" sort="34" group="Properties" seq="0002"><Summary>Gets the element in context.</Summary></Property>
<Property name="field" access="RO" type="gml:Field!" typeRef="&lt;q ref=&quot;core.gml:Field&quot;&gt;Field&lt;/q&gt;" sortGroup="true" scope="public" id="core.gml:ModelContext!field" sort="34" group="Properties" seq="0003"><Summary>Gets the field in context.</Summary></Property>
<Property name="isEditable" access="RO" type="Boolean" default="false" sortGroup="true" scope="public" id="core.gml:ModelContext!isEditable" sort="34" group="Properties" seq="0004"><Summary>Indicates whether the context is editable.</Summary></Property>
<Property name="isEmpty" access="RO" type="Boolean" default="true" sortGroup="true" scope="public" id="core.gml:ModelContext!isEmpty" sort="34" group="Properties" seq="0005"><Summary>Indicates whether the context is empty (i.e., level == CTX_NONE).</Summary></Property>
<Property name="level" access="RO" type="Number" default="0" sortGroup="true" scope="public" id="core.gml:ModelContext!level" sort="34" group="Properties" seq="0006"><Summary>Gets the context level (CTX_NONE, CTX_UNIT, CTX_ELEMENT, CTX_FIELD).</Summary></Property>
<Property name="model" access="RO" type="gml:Model!" typeRef="&lt;q ref=&quot;core.gml:Model&quot;&gt;Model&lt;/q&gt;" sortGroup="true" scope="public" id="core.gml:ModelContext!model" sort="34" group="Properties" seq="0007"><Summary>Gets the model in context.</Summary></Property>
<Property name="object" access="RO" type="gml:GmlObject!" typeRef="&lt;q ref=&quot;core.gml:GmlObject&quot;&gt;GmlObject&lt;/q&gt;" sortGroup="true" scope="public" id="core.gml:ModelContext!object" sort="34" group="Properties" seq="0008"><Summary>Gets the object in direct context (&lt;q ref=&quot;core.gml:ModelContext!unit&quot;&gt;unit&lt;/q&gt;, &lt;q ref=&quot;core.gml:ModelContext!element&quot;&gt;element&lt;/q&gt;, or &lt;q ref=&quot;core.gml:ModelContext!field&quot;&gt;field&lt;/q&gt;, depending on &lt;q ref=&quot;core.gml:ModelContext!level&quot;&gt;level&lt;/q&gt;).</Summary></Property>
<Property name="unit" access="RO" type="gml:Unit!" typeRef="&lt;q ref=&quot;core.gml:Unit&quot;&gt;Unit&lt;/q&gt;" sortGroup="true" scope="public" id="core.gml:ModelContext!unit" sort="34" group="Properties" seq="0009"><Summary>Gets the unit in context.</Summary></Property>
<Method name="clear" sortGroup="true" scope="public" id="core.gml:ModelContext!clear" sort="35" group="Methods" seq="0010"><Summary>Clears the context.</Summary><Parameters signature="method:: &lt;i&gt;context&lt;/i&gt;.&lt;b&gt;clear&lt;/b&gt;() &amp;rarr; void"></Parameters><Return></Return><Remarks>If the context has actually been changed, then the &lt;q ref=&quot;core.env:Environment!onContextSwitch&quot;&gt;onContextSwitch&lt;/q&gt; event will also be triggered.</Remarks></Method>
<Method name="coincides" sortGroup="true" scope="public" id="core.gml:ModelContext!coincides" sort="35" group="Methods" seq="0011"><Summary>Checks whether a given object and the active context coincide on a specified level.</Summary><Parameters signature="method:: &lt;i&gt;context&lt;/i&gt;.&lt;b&gt;coincides&lt;/b&gt;(&lt;i&gt;object&lt;/i&gt;, &lt;i&gt;level&lt;/i&gt;) &amp;rarr; true"><Param name="object" type="gml:GmlObject" typeRef="&lt;q ref=&quot;core.gml:GmlObject&quot;&gt;GmlObject&lt;/q&gt;">The object to test.</Param><Param name="level" type="Number" default="1">The level to match (1=unit, 2=element, or 4=field).</Param></Parameters><Return type="true">The test result.</Return></Method>
<Method name="contains" sortGroup="true" scope="public" id="core.gml:ModelContext!contains" sort="35" group="Methods" seq="0012"><Summary>Checks whether a given object is contained by or equal to the active context.</Summary><Parameters signature="method:: &lt;i&gt;context&lt;/i&gt;.&lt;b&gt;contains&lt;/b&gt;(&lt;i&gt;object&lt;/i&gt;) &amp;rarr; true"><Param name="object" type="gml:GmlObject" typeRef="&lt;q ref=&quot;core.gml:GmlObject&quot;&gt;GmlObject&lt;/q&gt;">The object to test.</Param></Parameters><Return type="true">The test result.</Return></Method>
<Method name="equals" sortGroup="true" scope="public" id="core.gml:ModelContext!equals" sort="35" group="Methods" seq="0013"><Summary>Checks whether a given object is the same as the active context.</Summary><Parameters signature="method:: &lt;i&gt;context&lt;/i&gt;.&lt;b&gt;equals&lt;/b&gt;(&lt;i&gt;object&lt;/i&gt;) &amp;rarr; true"><Param name="object" type="gml:GmlObject" typeRef="&lt;q ref=&quot;core.gml:GmlObject&quot;&gt;GmlObject&lt;/q&gt;">The object to test.</Param></Parameters><Return type="true">The test result.</Return></Method>
<Method name="getBoardAspect" sortGroup="true" scope="public" id="core.gml:ModelContext!getBoardAspect" sort="35" group="Methods" seq="0014"><Summary>Gets the context board's aspect role.</Summary><Parameters signature="method:: &lt;i&gt;context&lt;/i&gt;.&lt;b&gt;getBoardAspect&lt;/b&gt;() &amp;rarr; &lt;q ref=&quot;core.dev:IBoard&quot;&gt;IBoard&lt;/q&gt;"></Parameters><Return type="dev:IBoard" typeRef="&lt;q ref=&quot;core.dev:IBoard&quot;&gt;IBoard&lt;/q&gt;">The context board aspect role.</Return></Method>
<Method name="getBoardDef" sortGroup="true" scope="public" id="core.gml:ModelContext!getBoardDef" sort="35" group="Methods" seq="0015"><Summary>Gets the context board's definition object.</Summary><Parameters signature="method:: &lt;i&gt;context&lt;/i&gt;.&lt;b&gt;getBoardDef&lt;/b&gt;() &amp;rarr; &lt;q ref=&quot;core.env:KitBoards!BOARD_DEF&quot;&gt;BOARD_DEF&lt;/q&gt;"></Parameters><Return type="env:KitBoards!BOARD_DEF" typeRef="&lt;q ref=&quot;core.env:KitBoards!BOARD_DEF&quot;&gt;BOARD_DEF&lt;/q&gt;">The context board definition object.</Return></Method>
<Method name="isa" sortGroup="true" scope="public" id="core.gml:ModelContext!isa" sort="35" group="Methods" seq="0016"><Summary>Tests whether the active context object is an instance of a specified GML class/prototype.</Summary><Parameters signature="method:: &lt;i&gt;context&lt;/i&gt;.&lt;b&gt;isa&lt;/b&gt;(&lt;i&gt;className&lt;/i&gt;) &amp;rarr; Boolean"><Param name="className" type="QName">The qualified class/prototype name to test (if the namespace is omitted then &quot;&lt;code&gt;core.gml:&quot;&lt;/code&gt; is assumed).</Param></Parameters><Return type="Boolean">Returns &lt;code&gt;true&lt;/code&gt; iff the active context is an instance of &lt;i&gt;className&lt;/i&gt;</Return></Method>
<Method name="refresh" sortGroup="true" scope="public" id="core.gml:ModelContext!refresh" sort="35" group="Methods" seq="0017"><Summary>Refreshes the active context.</Summary><Parameters signature="method:: &lt;i&gt;context&lt;/i&gt;.&lt;b&gt;refresh&lt;/b&gt;() &amp;rarr; void"></Parameters><Return></Return><Remarks>This method causes the &lt;q ref=&quot;core.env:Environment!onContextSwitch&quot;&gt;onContextSwitch&lt;/q&gt; to be triggered unconditionally.</Remarks></Method>
<Method name="setBoard" sortGroup="true" scope="public" id="core.gml:ModelContext!setBoard" sort="35" group="Methods" seq="0018"><Summary>Sets the context to the given board, without changing the object.</Summary><Parameters signature="method:: &lt;i&gt;context&lt;/i&gt;.&lt;b&gt;setBoard&lt;/b&gt;(&lt;i&gt;board&lt;/i&gt;) &amp;rarr; void"><Param name="board" type="String">The new board in context.</Param></Parameters><Return></Return><Remarks>&lt;p&gt;This method might throw an exception if the object cannot be put into context.&lt;/p&gt;
      &lt;p&gt;If the context has actually been changed, then the &lt;q ref=&quot;core.env:Environment!onContextSwitch&quot;&gt;onContextSwitch&lt;/q&gt; event will also be triggered.&lt;/p&gt;</Remarks></Method>
<Method name="setContext" sortGroup="true" scope="public" id="core.gml:ModelContext!setContext" sort="35" group="Methods" seq="0019"><Summary>Sets the context to the given object and board.</Summary><Parameters signature="method:: &lt;i&gt;context&lt;/i&gt;.&lt;b&gt;setContext&lt;/b&gt;(&lt;i&gt;object&lt;/i&gt;, &lt;i&gt;board&lt;/i&gt;, &lt;i&gt;history&lt;/i&gt;) &amp;rarr; void"><Param name="object" type="gml:GmlObject" typeRef="&lt;q ref=&quot;core.gml:GmlObject&quot;&gt;GmlObject&lt;/q&gt;">The new object in context.</Param><Param name="board" type="String">The new board in context.</Param><Param name="history" type="Boolean">Indicates whether the context switch is due to history traversal.</Param></Parameters><Return></Return><Remarks>&lt;p&gt;This method might throw an exception if the object cannot be put into context.&lt;/p&gt;
      &lt;p&gt;If the context has actually been changed, then the &lt;q ref=&quot;core.env:Environment!onContextSwitch&quot;&gt;onContextSwitch&lt;/q&gt; event will also be triggered.&lt;/p&gt;</Remarks></Method>
<Method name="setObject" sortGroup="true" scope="public" id="core.gml:ModelContext!setObject" sort="35" group="Methods" seq="0020"><Summary>Sets the context to the given object, without changing the board.</Summary><Parameters signature="method:: &lt;i&gt;context&lt;/i&gt;.&lt;b&gt;setObject&lt;/b&gt;(&lt;i&gt;object&lt;/i&gt;) &amp;rarr; void"><Param name="object" type="gml:GmlObject" typeRef="&lt;q ref=&quot;core.gml:GmlObject&quot;&gt;GmlObject&lt;/q&gt;">The new object in context.</Param></Parameters><Return></Return><Remarks>&lt;p&gt;This method might throw an exception if the object cannot be put into context.&lt;/p&gt;
      &lt;p&gt;If the context has actually been changed, then the &lt;q ref=&quot;core.env:Environment!onContextSwitch&quot;&gt;onContextSwitch&lt;/q&gt; event will also be triggered.&lt;/p&gt;</Remarks></Method>
</Topics>
</Class>