| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <HTML> |
| <HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| <title>Grouping for function contribution</title> |
| <link rel="stylesheet" type="text/css" href="schema.css"> |
| </HEAD> |
| <BODY> |
| <H1><CENTER>Grouping for function contribution</CENTER></H1> |
| <p></p> |
| <h6 class=CaptionFigColumn id=header>Identifier: </h6>com.ibm.etools.emf.workbench.group<p></p> |
| <h6 class=CaptionFigColumn id=header>Since: </h6>6.0 |
| <p></p> |
| |
| <p> |
| <h6 class=CaptionFigColumn id=header>Description: </h6>A functionGroup provides a grouping of related function that can be contributed to the tools. For example, a third party component may want to contribute actions, editor pages, edit model resources, and many other functions specific to a given product. By associating all these functions with a group id, a mechanism is exposed for users to selectively enable and disable baskets of function. Extension points that allow for a "groupID" attribute generally will hide those functions when the group id is disabled.</p> |
| <p><h6 class=CaptionFigColumn id=header>Configuration Markup:</h6></p> |
| <p class=code id=dtd><!ELEMENT <a name="e.extension">extension</a> (<a href="#e.functionGroup">functionGroup</a>+ | <a href="#e.functionGroupPatternBinding">functionGroupPatternBinding</a>+)></p> |
| <p class=code id=dtd><!ATTLIST extension</p> |
| <p class=code id=dtdAttlist>point CDATA #REQUIRED<p class=code id=dtdAttlist>id CDATA #IMPLIED<p class=code id=dtdAttlist>name CDATA #IMPLIED></p> |
| <p></p> |
| <ul class=ConfigMarkup id=attlistDesc> |
| </ul> |
| <br><p class=code id=dtd><!ELEMENT <a name="e.functionGroup">functionGroup</a> EMPTY></p> |
| <p class=code id=dtd><!ATTLIST functionGroup</p> |
| <p class=code id=dtdAttlist>functionGroupID CDATA #REQUIRED<p class=code id=dtdAttlist>name CDATA #REQUIRED<p class=code id=dtdAttlist>description CDATA #REQUIRED<p class=code id=dtdAttlist>icon CDATA #IMPLIED<p class=code id=dtdAttlist>url CDATA #IMPLIED<p class=code id=dtdAttlist>priority CDATA #REQUIRED<p class=code id=dtdAttlist>initializerClassName CDATA #REQUIRED></p> |
| <p></p> |
| <p class=ConfigMarkup id=elementDesc> |
| Extension point definition for a group.</p> |
| <br> |
| <ul class=ConfigMarkup id=attlistDesc> |
| <li><b>functionGroupID</b> - A unique id for the group.</li> |
| <li><b>name</b> - A human readable name.</li> |
| <li><b>description</b> - A short description of the group.</li> |
| <li><b>icon</b> - </li> |
| <li><b>url</b> - </li> |
| <li><b>priority</b> - Ordering magnitude of plugins</li> |
| <li><b>initializerClassName</b> - Class used to determine plugin enablement</li> |
| </ul> |
| <br><p class=code id=dtd><!ELEMENT <a name="e.functionGroupPatternBinding">functionGroupPatternBinding</a> EMPTY></p> |
| <p class=code id=dtd><!ATTLIST functionGroupPatternBinding</p> |
| <p class=code id=dtdAttlist>functionGroupID CDATA #REQUIRED<p class=code id=dtdAttlist>pattern CDATA #REQUIRED></p> |
| <p></p> |
| <p class=ConfigMarkup id=elementDesc> |
| This element allows one to bind function groups to patterns.</p> |
| <br> |
| <ul class=ConfigMarkup id=attlistDesc> |
| <li><b>functionGroupID</b> - The unique identifier of the function group to bind.</li> |
| <li><b>pattern</b> - The pattern to be bound. Patterns are regular expressions which match unique identifiers.</li> |
| </ul> |
| <br><h6 class=CaptionFigColumn id=header>Examples: </h6><code> |
| <br> |
| <extension<br> |
| point="com.ibm.wtp.common.functionGroup"><br> |
| <functionGroup<br> |
| name="Acme Co. Function Extension"<br> |
| functionGroupID="com.acme.acmepro"<br> |
| description="The AcmePro Extensions add integration to the Acme Web Server."<br> |
| enabledByDefault="true"<br> |
| icon="..."<br> |
| url="http://www.acme.com/"<br> |
| /><br> |
| </extension><br> |
| </code> |
| <p></p> |
| |
| <h6 class=CaptionFigColumn id=header>API Information: </h6>WTP Function Groups can be referenced through com.ibm.wtp.common.group.WTPFunctionGroupRegistry. |
| <p></p> |
| |
| <br> |
| <p class=note id=copyright> |
| </p> |
| </BODY> |
| </HTML> |
