Extension point for defining kit design boards.(c) SAP AG 2003-2006. All rights reserved.
Defines a new design board.The new board definition.The newly defined board.<h2>Xml definition of a board in a configuration file</h2>
<pre>
<CONFIGURE type="BOARDS">
? <HEADER>
? <PRAGMA># Pragmas section</PRAGMA>
? <SCRIPT># Code section. Place here functions\variables
which you want to address from within the board tags
</SCRIPT>
</HEADER>
<BOARDS>
+ <BOARD id="com.sap.mypackage:boardId">
# For complete description of board
definition see <q ref="core.env:KitBoards!BOARD_DEF">BOARD_DEF</q>
? <PROPERTIES>
* <propertyName type="[function | ]"/>
# Represents a property of the board
You can assign the 'type' attribute for
evaluating the value of the property
as a function
</PROPERTIES>
</BOARD>
</BOARDS>
</CONFIGURE>
</pre>
<h2>Example</h2>
<pre>
<CONFIGURE type="BOARDS">
<BOARDS>
<BOARD id="core.svg:DRAWING_BOARD">
<PROPERTIES>
<aspect>core.svg:GmlDrawing</aspect>
<name>Drawing Board</name>
<type>SVG</type>
<impl>#URL[core.svg:boards.DrawingBoard.htm]</impl>
</PROPERTIES>
</BOARD>
</BOARDS>
</CONFIGURE>
</pre>
Returns a specified board definition.Board Id.The requested board definition.
Returns the complete boards definitions table.Table of boards definitions, indexed by id.Board id's are stored in uppercase. Use <q ref="core.lib:Basic!UPPER">UPPER</q> macro to convert the board name to uppercase
before using it as the index in this table.
Returns a defintion of the default board.The requested board definition, or <code>null</code> if there are no boards.
Removes all boards.
Removes a specified board definition.The id of the board to remove.
Represents a Storyboard board definition.The BOARD_DEF 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>Unique board Id - must be prefixed with namespace e.g. com.sap.mypackage:uniqId </td></tr><tr><td class=V>aspect </td><td>QName </td><td>Associated aspect role </td></tr><tr><td class=V>name </td><td>String </td><td>Board name </td></tr><tr><td class=V>type </td><td><q ref="core.env:KitBoards!BOARD_TYPE">BOARD_TYPE</q> </td><td>Board implementation type </td></tr><tr><td class=V>impl </td><td>String </td><td>Board implementation url </td></tr><tr><td class=V>tag </td><td>String </td><td>Board implementation tag name (for HTC boards) </td></tr><tr><td class=V>priority </td><td>Number </td><td>Board's priority </td></tr><tr><td class=V>isDefault </td><td>Boolean </td><td><code>true</code> if this board should be default board (if specified, replaces previous default) </td></tr><tr><td class=V>visible </td><td>Function </td><td>Board's dynamic visibility state. Can be <code>true,</code> <code>false</code> or a function: <p style="margin:10"><code>flag = visible(<i>definition</i>)</code></p> Where <code>definition</code> is this board's definition. If the function returns <code>true</code> the board will be visible; otherwise, it will be hidden. If this parameter is omitted, the board will be visible by default. </td></tr></table>
An enumeration of the possible board implementation types.<table class="BOTH"><tr><td class="H V">Name </td><td class=H>Description </td></tr><tr><td class=V>SVG </td><td>A graphical board implemented using SVG (e.g., design board) </td></tr><tr><td class=V>HTM </td><td>A visual board implemented using HTML (e.g., layout board, simulator board) </td></tr><tr><td class=V>HTC </td><td>A visual board implemented using HTC component </td></tr><tr><td class=V>CODE </td><td>A non-visual board implemented in code (e.g., code generator, model validator, usability analyzer, etc.) </td></tr></table>