| <!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>Edit Model Extension</title> |
| <link rel="stylesheet" type="text/css" href="schema.css"> |
| </HEAD> |
| <BODY> |
| <H1><CENTER>Edit Model Extension</CENTER></H1> |
| <p></p> |
| <h6 class=CaptionFigColumn id=header>Identifier: </h6>com.ibm.etoosl.emf.workbench.geditModelExtension<p></p> |
| <h6 class=CaptionFigColumn id=header>Since: </h6>6.0 |
| <p></p> |
| |
| <p> |
| <h6 class=CaptionFigColumn id=header>Description: </h6>The Edit Model Extension allows third parties to contribute expected resources to Edit Models. The functionGroupID allows users to select which extensions they choose to have enabled.<p> |
| Edit models provide a framework for managing a set of EMF resources within a unit of work. For example, a workspace operation may affect a change to multiple EMF resources. Edit models provide basic services such as loads, saves (when necessary), and validate edit for the managed resources. Edit models are reference counted, therefore a single instance of an edit model can be shared by more than one operation or editor. By declaring an edit model, a plugin provider enables other components to contribute resources to be managed by that edit model.</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.editModelExtension">editModelExtension</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.editModelExtension">editModelExtension</a> (<a href="#e.editModelResource">editModelResource</a>+)></p> |
| <p class=code id=dtd><!ATTLIST editModelExtension</p> |
| <p class=code id=dtdAttlist>editModelID CDATA #REQUIRED<p class=code id=dtdAttlist>id CDATA #REQUIRED></p> |
| <p></p> |
| <p class=ConfigMarkup id=elementDesc> |
| Edit model extensions allow components to contribute known resource URIs to an edit model. Whenever an edit model is loaded, the resources will automatically be loaded and managed by the edit model. Changes to the resources will be tracked and saved during operations or editor saves.</p> |
| <br> |
| <ul class=ConfigMarkup id=attlistDesc> |
| <li><b>editModelID</b> - The unique id of the edit model being extended.</li> |
| <li><b>id</b> - The unique identifier for this extension. This will be used to associate it with a function group pattern binding.</li> |
| </ul> |
| <br><p class=code id=dtd><!ELEMENT <a name="e.extension">extension</a> (<a href="#e.editModel">editModel</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.editModel">editModel</a> (<a href="#e.editModelResource">editModelResource</a>+)></p> |
| <p class=code id=dtd><!ATTLIST editModel</p> |
| <p class=code id=dtdAttlist>editModelID CDATA #REQUIRED<p class=code id=dtdAttlist>factoryClass CDATA #REQUIRED<p class=code id=dtdAttlist>loadUnknownResourcesAsReadOnly (true | false) <p class=code id=dtdAttlist>parentModelID CDATA #IMPLIED></p> |
| <p></p> |
| <p class=ConfigMarkup id=elementDesc> |
| The declaration for an edit model to be used in the workspace.</p> |
| <br> |
| <ul class=ConfigMarkup id=attlistDesc> |
| <li><b>editModelID</b> - A unique identifier for the edit model.</li> |
| <li><b>factoryClass</b> - An optional factory class that is used for this edit model. The class must implement the interface <code>com.ibm.etools.emf.workbench.edit.EditModelFactory</code>. If none is specified, then a generic <code>EditModel</code> is created.</li> |
| <li><b>loadUnknownResourcesAsReadOnly</b> - </li> |
| <li><b>parentModelID</b> - </li> |
| </ul> |
| <br><p class=code id=dtd><!ELEMENT <a name="e.editModelResource">editModelResource</a> EMPTY></p> |
| <p class=code id=dtd><!ATTLIST editModelResource</p> |
| <p class=code id=dtdAttlist>URI CDATA #REQUIRED<p class=code id=dtdAttlist>autoload (true | false) "false"></p> |
| <p></p> |
| <p class=ConfigMarkup id=elementDesc> |
| This is an individual contribution of a resource to the edit model. If more than one instance of the same URI is registered against an edit model id, the resource is still only loaded once.</p> |
| <br> |
| <ul class=ConfigMarkup id=attlistDesc> |
| <li><b>URI</b> - The URI of the resource relative to the root container from which EMF resources are loaded.</li> |
| <li><b>autoload</b> - Indicator which determines whether this resource should be autoloaded when the edit model is created, or when an IFile corresponding to this resource is added.</li> |
| </ul> |
| <br><h6 class=CaptionFigColumn id=header>Examples: </h6><br> |
| <code> |
| <extension<br> |
| point="com.ibm.etools.emf.workbench.editModelExtension"><br> |
| <editModelExtension<br> |
| editModelID="com.ibm.etools.inheritance.parent.editModel"<br> |
| functionGroupID="com.ibm.etools.websphere.group"><br> |
| <editModelResource URI="DIR/extension0.xml"/><br> |
| <editModelResource URI="DIR/extension1.xml"/><br> |
| </editModelExtension><br> |
| </extension><br> |
| </code> |
| <p></p> |
| |
| <h6 class=CaptionFigColumn id=header>API Information: </h6>[Enter API information here.] |
| <p></p> |
| |
| <h6 class=CaptionFigColumn id=header>Supplied Implementation: </h6>[Enter information about supplied implementation of this extension point.] |
| <p></p> |
| |
| <br> |
| <p class=note id=copyright> |
| </p> |
| </BODY> |
| </HTML> |
