<?xml version="1.0" encoding="Windows-1255" ?><Component name="Workspace" alias="$WIN" also="core.lib:WinManager" id="core.dev:Workspace" sort="24" urn="core.dev:main.Workspace.htc" toc="\Main Modules"><Summary>Implements the workspace area where multiple boards and windows can be opened and managed by the user (&lt;code&gt;$WIN)&lt;/code&gt;</Summary><Remarks>&lt;p&gt;
			Boards are commonly used for displaying and editing the current GML
			unit. The implementation of a board depends on the type of units that
			it supports, as defined in the GML meta-model. The workspace interfaces
			enable the creation, destruction, and management of boards, and the
			communications between the boards and other modules of the system
			in a uniform manner.
		&lt;/p&gt;&lt;p&gt;
			Windows are displayed on top of the current board and can be moved and resized by the user.
			Window are commonly used for displaying property inspectors, custom editors,
			and other context-senstive dialogs.
		&lt;/p&gt;</Remarks><Copyright>(c) SAP AG 2003-2006. All rights reserved.</Copyright><SeeAlso>&lt;q ref=&quot;core.lib:WinManager&quot;&gt;WinManager&lt;/q&gt;</SeeAlso>
<Topics>
<Method name="getBoardClientRect" sortGroup="true" scope="public" id="core.dev:Workspace!getBoardClientRect" sort="35" group="Boards Control" seq="0000"><Summary>Gets the current board's bounding client rectangle.</Summary><Parameters signature="method:: &lt;i&gt;$WIN&lt;/i&gt;.&lt;b&gt;getBoardClientRect&lt;/b&gt;() &amp;rarr; void"></Parameters><Return></Return></Method>
<Method name="getBoardIFrame" sortGroup="true" scope="public" id="core.dev:Workspace!getBoardIFrame" sort="35" group="Boards Control" seq="0001"><Summary>Gets the board IFrame, if board not created it creates it
	(This function created in order to create a board without actual 
	switch to it. when invoked an IFrame created with hidden visibility).</Summary><Parameters signature="method:: &lt;i&gt;$WIN&lt;/i&gt;.&lt;b&gt;getBoardIFrame&lt;/b&gt;(&lt;i&gt;boardId&lt;/i&gt;) &amp;rarr; Object"><Param name="boardId" type="String">Board id.</Param></Parameters><Return type="Object">{&lt;code&gt;false&lt;/code&gt; if not loaded else &lt;code&gt;true,&lt;/code&gt; borad object, board IFrame}.</Return></Method>
<Method name="isBoardExists" sortGroup="true" scope="public" id="core.dev:Workspace!isBoardExists" sort="35" group="Boards Control" seq="0002"><Summary></Summary><Parameters signature="method:: &lt;i&gt;$WIN&lt;/i&gt;.&lt;b&gt;isBoardExists&lt;/b&gt;(&lt;i&gt;boardId&lt;/i&gt;) &amp;rarr; Boolean"><Param name="boardId" type="String">Board id.</Param></Parameters><Return type="Boolean">Return &lt;code&gt;true&lt;/code&gt; if borad exists, else returns &lt;code&gt;false&lt;/code&gt;</Return></Method>
<Method name="signalBoard" sortGroup="true" scope="public" id="core.dev:Workspace!signalBoard" sort="35" group="Boards Control" seq="0003"><Summary>Sends a signal to the current board.</Summary><Parameters signature="method:: &lt;i&gt;$WIN&lt;/i&gt;.&lt;b&gt;signalBoard&lt;/b&gt;(&lt;i&gt;name&lt;/i&gt;, &lt;i&gt;args...&lt;/i&gt;) &amp;rarr; void"><Param name="name" type="String">Signal name.</Param><Param name="args..." type="Arguments">Variable list of signal arguments.</Param></Parameters><Return></Return></Method>
<Method name="switchBoard" group="Boards Control" sortGroup="true" scope="public" id="core.dev:Workspace!switchBoard" sort="35" seq="0004"><Summary>Switches the current board.</Summary><Parameters label="Form 1" descr="Switches from the current board to the boardId." signature="method:: &lt;i&gt;$WIN&lt;/i&gt;.&lt;b&gt;switchBoard&lt;/b&gt;(&lt;i&gt;boardId&lt;/i&gt;) &amp;rarr; Boolean"><Param name="boardId" type="String">The id of the board to show (see &lt;q ref=&quot;core.env:KitBoards&quot;&gt;KitBoards&lt;/q&gt;).</Param></Parameters><Parameters label="Form 2" descr="Close all loaded boards so far." signature="method:: &lt;i&gt;$WIN&lt;/i&gt;.&lt;b&gt;switchBoard&lt;/b&gt;() &amp;rarr; Boolean"></Parameters><Return type="Boolean">Indicates whether the requested board has already been loaded.</Return><Remarks>dror ben-gai / 17-oct-06:
		The boards and the tabstrip are de-coupled - the tabstrip is now used for selecting models.</Remarks></Method>
<Method name="updateBoards" sortGroup="true" scope="public" id="core.dev:Workspace!updateBoards" sort="35" group="Boards Control" seq="0005"><Summary>Updates the display to reflect changes in board definitions.</Summary><Parameters signature="method:: &lt;i&gt;$WIN&lt;/i&gt;.&lt;b&gt;updateBoards&lt;/b&gt;() &amp;rarr; void"></Parameters><Return></Return></Method>
<Property name="state" type="BOARD_STATE" group="Boards State" typeRef="&lt;q ref=&quot;core.dev:Workspace!BOARD_STATE&quot;&gt;BOARD_STATE&lt;/q&gt;" access="RW" sortGroup="true" scope="public" id="core.dev:Workspace!state" sort="34" seq="0006"><Summary>Gets or sets the board state.</Summary></Property>
<Property name="toolbox" type="String" access="RW" sortGroup="true" scope="public" id="core.dev:Workspace!toolbox" sort="34" group="Boards State" seq="0007"><Summary>Gets or sets the current toolbox name.</Summary></Property>
<Method name="adjustState" sortGroup="true" scope="public" id="core.dev:Workspace!adjustState" sort="35" group="Boards State" seq="0008"><Summary>Adjusts a portion of the board state flags.</Summary><Parameters signature="method:: &lt;i&gt;$WIN&lt;/i&gt;.&lt;b&gt;adjustState&lt;/b&gt;(&lt;i&gt;flags&lt;/i&gt;, &lt;i&gt;affects&lt;/i&gt;) &amp;rarr; void"><Param name="flags" type="BOARD_STATE" typeRef="&lt;q ref=&quot;core.dev:Workspace!BOARD_STATE&quot;&gt;BOARD_STATE&lt;/q&gt;">The updated values of the relevant state flags.</Param><Param name="affects" type="BOARD_STATE" typeRef="&lt;q ref=&quot;core.dev:Workspace!BOARD_STATE&quot;&gt;BOARD_STATE&lt;/q&gt;">Indicates which portion of the board state flags should be updated.</Param></Parameters><Return></Return></Method>
<Method name="captureSnapshot" sortGroup="true" scope="public" id="core.dev:Workspace!captureSnapshot" sort="35" group="Boards State" seq="0009"><Summary>Captures a snapshot of the current board.</Summary><Parameters signature="method:: &lt;i&gt;$WIN&lt;/i&gt;.&lt;b&gt;captureSnapshot&lt;/b&gt;() &amp;rarr; Object"></Parameters><Return type="Object">The captured snapshot data.</Return></Method>
<Method name="getWindow" sortGroup="true" scope="public" id="core.dev:Workspace!getWindow" sort="35" group="Boards State" seq="0010"><Summary>Gets the specified window.</Summary><Parameters signature="method:: &lt;i&gt;$WIN&lt;/i&gt;.&lt;b&gt;getWindow&lt;/b&gt;(&lt;i&gt;key&lt;/i&gt;) &amp;rarr; &lt;q ref=&quot;core.lib:WinFrame&quot;&gt;WinFrame&lt;/q&gt;"><Param name="key" type="String">The key of the window to get. If omitted, the active window will be returned.</Param></Parameters><Return type="lib:WinFrame" typeRef="&lt;q ref=&quot;core.lib:WinFrame&quot;&gt;WinFrame&lt;/q&gt;">The requested window.</Return></Method>
<Method name="restoreSnapshot" sortGroup="true" scope="public" id="core.dev:Workspace!restoreSnapshot" sort="35" group="Boards State" seq="0011"><Summary>Restores the board to a previously captured snapshot.</Summary><Parameters signature="method:: &lt;i&gt;$WIN&lt;/i&gt;.&lt;b&gt;restoreSnapshot&lt;/b&gt;(&lt;i&gt;snapshot&lt;/i&gt;) &amp;rarr; void"><Param name="snapshot" type="Object">The data of the snapshot to be restored.</Param></Parameters><Return></Return></Method>
<Event name="onBoardState" sortGroup="true" scope="public" id="core.dev:Workspace!onBoardState" sort="36" group="Boards State" seq="0012"><Summary>Fires whenever the board state is changed.</Summary><Parameters signature="event:: &lt;b&gt;onBoardState&lt;/b&gt; &amp;rarr; {&lt;i&gt;state&lt;/i&gt;, &lt;i&gt;changes&lt;/i&gt;}"><Param name="state" type="BOARD_STATE" typeRef="&lt;q ref=&quot;core.dev:Workspace!BOARD_STATE&quot;&gt;BOARD_STATE&lt;/q&gt;">The new board state.</Param><Param name="changes" type="BOARD_STATE" typeRef="&lt;q ref=&quot;core.dev:Workspace!BOARD_STATE&quot;&gt;BOARD_STATE&lt;/q&gt;">Indicates which board state have changed.</Param></Parameters></Event>
<Event name="onTaskbarChange" sortGroup="true" scope="public" id="core.dev:Workspace!onTaskbarChange" sort="36" group="Boards State" seq="0013"><Summary>Freestyle kit only - Fires whenever the first model is open or last model is closed.</Summary><Parameters signature="event:: &lt;b&gt;onTaskbarChange&lt;/b&gt; &amp;rarr; {}"></Parameters></Event>
<Enumeration name="BOARD_STATE" sortGroup="true" id="core.dev:Workspace!BOARD_STATE" sort="42" group="Boards State" seq="0014"><Summary>An enumeration of the possible board states.</Summary><Remarks>The board state is a bitwise combination of any of the following flags:
	&lt;table class=&quot;BOTH&quot;&gt;&lt;tr&gt;&lt;td class=&quot;H V&quot;&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;WIN_NONE &lt;/td&gt;&lt;td&gt;Board is closed &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;WIN_OPEN &lt;/td&gt;&lt;td&gt;Board is open &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;WIN_HOME &lt;/td&gt;&lt;td&gt;Board is open on home location &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;WIN_CUT &lt;/td&gt;&lt;td&gt;Cut to the clipboard is possible &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;WIN_COPY &lt;/td&gt;&lt;td&gt;Copy to the clipboard is possible &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;WIN_PASTE &lt;/td&gt;&lt;td&gt;Paste from the clipboard is possible &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;WIN_UNDO &lt;/td&gt;&lt;td&gt;There is a command that can be undone &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;WIN_REDO &lt;/td&gt;&lt;td&gt;There is a command that can be redone &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;WIN_BACKWARD &lt;/td&gt;&lt;td&gt;The board can be navigated backward through history &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;WIN_FORWARD &lt;/td&gt;&lt;td&gt;The board can be navigated forward through history &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;WIN_UPWARD &lt;/td&gt;&lt;td&gt;The board can be navigated upward &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;WIN_DOWNWARD &lt;/td&gt;&lt;td&gt;The board can be navigated downward (drilled down) &lt;/td&gt;&lt;/tr&gt;&lt;/table&gt;</Remarks></Enumeration>
<Property name="currentModel" access="RW" sortGroup="true" scope="public" id="core.dev:Workspace!currentModel" sort="34" group="Windows Control" seq="0015"><Summary>Gets the currently open model.</Summary><Remarks>This property holds the currently open model.</Remarks></Property>
<Method name="closeAllWindows" sortGroup="true" scope="public" id="core.dev:Workspace!closeAllWindows" sort="35" group="Windows Control" seq="0016"><Summary>Closes all windows.</Summary><Parameters signature="method:: &lt;i&gt;$WIN&lt;/i&gt;.&lt;b&gt;closeAllWindows&lt;/b&gt;() &amp;rarr; void"></Parameters><Return></Return></Method>
<Method name="closeWindow" sortGroup="true" scope="public" id="core.dev:Workspace!closeWindow" sort="35" group="Windows Control" seq="0017"><Summary>Closes the specified window.</Summary><Parameters signature="method:: &lt;i&gt;$WIN&lt;/i&gt;.&lt;b&gt;closeWindow&lt;/b&gt;(&lt;i&gt;key&lt;/i&gt;) &amp;rarr; void"><Param name="key" type="String">The key of the window to close. If omitted, the active window will be closed.</Param></Parameters><Return></Return></Method>
<Method name="contextMenu" sortGroup="true" scope="public" id="core.dev:Workspace!contextMenu" sort="35" group="Windows Control" seq="0018"><Summary>Populate the show the context for a selected tab.</Summary><Parameters signature="method:: &lt;i&gt;$WIN&lt;/i&gt;.&lt;b&gt;contextMenu&lt;/b&gt;(&lt;i&gt;EvParam&lt;/i&gt;, &lt;i&gt;x&lt;/i&gt;, &lt;i&gt;y&lt;/i&gt;) &amp;rarr; void"><Param name="EvParam">The ID of the selected tab (equals to the ID of the model).</Param><Param name="x">X coordinate of the mouse.</Param><Param name="y">Y coordinate of the mouse.</Param></Parameters><Return></Return></Method>
<Method name="openWindow" group="Windows Control" sortGroup="true" scope="public" id="core.dev:Workspace!openWindow" sort="35" seq="0019"><Summary>Opens a specified window.</Summary><Parameters signature="method:: &lt;i&gt;$WIN&lt;/i&gt;.&lt;b&gt;openWindow&lt;/b&gt;(&lt;i&gt;settings&lt;/i&gt;, &lt;i&gt;params&lt;/i&gt;) &amp;rarr; &lt;q ref=&quot;core.lib:WinFrame&quot;&gt;WinFrame&lt;/q&gt;"><Param name="settings" type="lib:WinFrame" typeRef="&lt;q ref=&quot;core.lib:WinFrame&quot;&gt;WinFrame&lt;/q&gt;">The window settings.</Param><Param name="params" default="" type="Object">The window parameters.</Param></Parameters><Return type="lib:WinFrame" typeRef="&lt;q ref=&quot;core.lib:WinFrame&quot;&gt;WinFrame&lt;/q&gt;">The opened window.</Return><Remarks>A new window's &lt;code&gt;board&lt;/code&gt; property is set to a valid board id, this board becomes the current context board.</Remarks></Method>
<Method name="reloadWindow" sortGroup="true" scope="public" id="core.dev:Workspace!reloadWindow" sort="35" group="Windows Control" seq="0020"><Summary>Reloads the specified window.</Summary><Parameters signature="method:: &lt;i&gt;$WIN&lt;/i&gt;.&lt;b&gt;reloadWindow&lt;/b&gt;(&lt;i&gt;key&lt;/i&gt;) &amp;rarr; void"><Param name="key" type="String">The key of the window to reload. If omitted, the active window will be reloaded.</Param></Parameters><Return></Return></Method>
<Method name="switchModel" sortGroup="true" scope="public" id="core.dev:Workspace!switchModel" sort="35" group="Windows Control" seq="0021"><Summary>Switch to the selected model.</Summary><Parameters signature="method:: &lt;i&gt;$WIN&lt;/i&gt;.&lt;b&gt;switchModel&lt;/b&gt;(&lt;i&gt;EvParam&lt;/i&gt;) &amp;rarr; void"><Param name="EvParam">The ID of the model to switch to.</Param></Parameters><Return></Return><Remarks>This function is traditionally called from two specific loactions:
		- the tabstrip's onselect event
		- drill down to the model from another model.</Remarks></Method>
<Property name="descr" access="RO" sortGroup="true" scope="public" id="core.dev:Workspace!descr" sort="34" group="Properties" seq="0022"><Summary>Gets the description of this module.</Summary></Property>
</Topics>
</Component>