New Model Wizard

Identifier:

com.ibm.xtools.common.ui.wizards.newModelWizard

Since:

This extension point is new to Version 7.0.5.

Description:

This extension point is used to populate and handle actions within the new model wizard.

Configuration Markup:

<!ELEMENT extension (templateFactory* , templateDirectory* , category* , templateCategoryBinding* , activityTemplateBinding* , perspectiveBinding* , templateConfigurationPageGroup* , existingModelHandler*)+>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

point - The identifier of the extension point.
id - The identifier of the extension.
name - The name of the extension.

<!ELEMENT templateFactory EMPTY>

<!ATTLIST templateFactory

class CDATA #REQUIRED>

Template factories allows for the contribution of templates programmatically rather than through a static file.

class - Specifies a concrete implementation of ITemplateFactory.

<!ELEMENT templateDirectory EMPTY>

<!ATTLIST templateDirectory

path CDATA #REQUIRED

handler CDATA #IMPLIED>

Specifies the location of a directory containing template definition files (.tpdef).

path - The path to a folder containing template definition files (.tpdef).
handler - Specifies a handler to manage creating a new model from a template model. If a handler is not provided, a default handler will be provided.

<!ELEMENT category EMPTY>

<!ATTLIST category

id CDATA #REQUIRED

label CDATA #REQUIRED

parent CDATA #IMPLIED

displayable (true | false) >

Categories are strictly a UI feature used to categorize templates.

id - The category identifier.
label - The category label to surface in the UI.
parent - The parent category identifier is an optional attribute. Specifying this attribute creates a category tree structure.
displayable - Controls the display of this category in the model template wizard.

<!ELEMENT templateCategoryBinding (template+)+>

<!ATTLIST templateCategoryBinding

categoryRef CDATA #REQUIRED>

Binds templates to a category.

categoryRef - The category reference to bind templates to.

<!ELEMENT perspectiveBinding EMPTY>

<!ATTLIST perspectiveBinding

perspectiveRef CDATA #REQUIRED

categoryRef CDATA #REQUIRED

templateRef CDATA #REQUIRED>

Binds default template and category to a perspective.

perspectiveRef - The perspective for which the default category and template are being provided. These defaults are used only if no wizard was invoked before in the workspace; otherwise the last used wizard settings are used as default.
categoryRef - The category reference that represents the default category.
templateRef - The template reference that represents the default template.

<!ELEMENT activityTemplateBinding (template , activity+)+>

<!ATTLIST activityTemplateBinding

required (true | false) "false">

Binds activities to a category. Only those activities specified in the com.ibm.xtools.common.ui.reduction.editingCapabilities extension are valid.

required - Specifies whether the activities are required for the templates.

<!ELEMENT templateConfigurationPageGroup (template+)+>

<!ATTLIST templateConfigurationPageGroup

id CDATA #REQUIRED

class CDATA #REQUIRED

afterRef CDATA #IMPLIED

afterMatch (equals|pattern) "equals">

Template configuration page groups allow for additional configuration of templates in the wizard. The group can produce 1 or more wizard pages and create a workflow between the pages.

id - The template configuration page group identifier.
class - Specifies a concrete implementation of ITemplateConfigurationPageGroup.
afterRef - The reference of the template configuration page group that this group should come after.
afterMatch - Defines whether the afterRef attribute is to be an exact match or a regex pattern.

<!ELEMENT existingModelHandler EMPTY>

<!ATTLIST existingModelHandler

class CDATA #REQUIRED

extensions CDATA #REQUIRED>

Specifies a handler to manage creating a new model from an existing model. The specified handler is invoked for creating models from existing models with the given file extensions.

class - Specifies a concrete implementation of IExistingModelHandler.
extensions - Comma separated list of file extensions.

<!ELEMENT template EMPTY>

<!ATTLIST template

ref CDATA #REQUIRED

match (equals|pattern) "equals">

ref - The template reference.
match - Defines whether the ref attribute is to be an exact match or a regex pattern.

<!ELEMENT activity EMPTY>

<!ATTLIST activity

ref CDATA #REQUIRED

match (equals|pattern) "equals">

ref - The activity reference.
match - Defines whether the ref attribute is to be an exact match or a regex pattern.

Examples:


   <extension
         point="com.ibm.xtools.common.ui.wizards.newModelWizard">
      <templateDirectory
            path="templates/"
            handler="com.ibm.xtools.common.ui.wizards.tests.internal.TestTemplateModelHandler"/>
      <templateFactory class="com.ibm.xtools.example.MyTemplateFactory"/>
      <category
            id="com.ibm.xtools.example.category1"
            label="My Category"/>
      <category
            id="com.ibm.xtools.example.category1_1"
            label="My Sub Category"
            parent="com.ibm.xtools.example.category1"/>
      <templateCategoryBinding
            categoryRef="com.ibm.xtools.example.category1">
         <template
               ref="com.ibm.xtools.example.blankTemplate"
               match="equals"/>
      </templateCategoryBinding>
      <templateCategoryBinding
            categoryRef="com.ibm.xtools.example.category1_1">
         <template
               ref="com\.ibm\.xtools\.example\.workingTemplates.*"
               match="pattern"/>
      </templateCategoryBinding>
      <activityTemplateBinding
            required="true">
         <activity
               ref="com.ibm.xtools.example.activity1"
               match="equals"/>
         <template
               ref="com.ibm.xtools.example.blankTemplate"
               match="equals"/>
      </activityTemplateBinding>
      <templateConfigurationPageGroup
            afterMatch="equals"
            class="com.ibm.xtools.examples.MyTemplateConfigurationPageGroup1"
            id="com.ibm.xtools.examples.templateConfigurationPageGroup1">
         <template
               ref="com\.ibm\.xtools\.example\.workingTemplates.*"
               match="pattern"/>
      </templateConfigurationPageGroup>
      <templateConfigurationPageGroup
            afterMatch="equals"
            afterRef="com.ibm.xtools.examples.templateConfigurationPageGroup1"
            class="com.ibm.xtools.examples.MyTemplateConfigurationPageGroup2"
            id="com.ibm.xtools.examples.templateConfigurationPageGroup2">
         <template
               ref="com\.ibm\.xtools\.example\.workingTemplates.*"
               match="pattern"/>
      </templateConfigurationPageGroup>
      <existingModelHandler
            class="com.ibm.xtools.examples.MyExistingModelHandler"
            extensions="foo, bar"/>
   </extension>

API Information:

When contributing template directories, the directory should contain the template definition file (extension .templatedef.ve), the model template and the template icon:

Example directory containing a single template:

templates/template1.templatedef.ve
templates/template1.foo
templates/template1.gif

The template definition file can either be XML or a properties file. The XML format supports the definition of multiple templates, while there can only be one properties file for each template.

Example XML template definition file:


<templates>
   <template
      name="Test Template1"
      description="Create Template1."
      modelName="test1"
      
      id="com.ibm.xtools.common.ui.wizards.tests.template1"
      templateFile="template1.foo"
      icon="template1.gif">
   </template>
 
   <template
      name="Test Template2"
      description="Create Template2."
      modelName="test2"
  
      id="com.ibm.xtools.common.ui.wizards.tests.template2"
      templateFile="template2.foo"
      icon="template2.gif">
   </template>
</templates>

Example properties template definition file:


name=Test Template3
description=Create Template3.
modelName=test3
 
id=com.ibm.xtools.common.ui.wizards.tests.template3
templateFile=template3.foo
icon=template3.gif

Supplied Implementation:

The platform contributes a template configuration page group for all templates. This page allows the user to associate editing capabilities with a new model created from a template.

Particular product installs may contribute to the new model wizard as required.