Hyades Editor Extensions

Since: 0.0.1

Description: This extension point is used to register Hyades editor extensions.

Configuration Markup:

   <!ELEMENT extension (editorExtension+)>

   <!ATTLIST extension
     point CDATA #REQUIRED
     name  CDATA #IMPLIED
     id    CDATA #IMPLIED
   >

• point - a fully qualified identifier of the target extension point
• name - an optional name of the extension instance
• id - an optional identifier of the extension instance

   <!ELEMENT editorExtension (appliesTo*)>

   <!ATTLIST editorExtension
     id          CDATA #REQUIRED
     name        CDATA #REQUIRED
     class       CDATA #REQUIRED
     extension   CDATA #REQUIRED
     icon        CDATA #IMPLIED
     description CDATA #IMPLIED
   >

• id - a unique name that will be used to identify this Hyades editor extension
• name - a translatable name that will be used in the UI for this Hyades editor extension
• class - a name of the class that implements org.eclipse.hyades.ui.IEditorExtension.
• extension - identifies the category of objects that this extension point is associated with. A good example would be the one of the supported file extensions.
• icon - a relative name of the icon that will be used to describe this editor extension.
• description - a description for this editor extension.

   <!ELEMENT appliesTo EMPTY>

   An editor extension can define which are the types it applies to. By not defining one type an editor extension says that it can handle any type.

• type - a unique name that will be used to identify the type.

   <extension point="org.eclipse.hyades.ui.editorExtensions">
      <editorExtension
         id="editorExtension1"
         name="Basic editor extension for all test suite types"
         class="com.samples1.editor.EditorExtension1"
         extension="testsuite"
         description="Allows the user to edit the basic attribute of any test suite"/>

      <editorExtension
         id="editorExtension2"
         name="%editorExtension2Name"
         class="com.samples1.editor.EditorExtension2"
         extension="testresult"
         icon="icons/edt2.gif"
         description="%editorExtension2Description">
            <appliesTo type="com.123.testType1"/>
            <appliesTo type="com.123.testType2"/>
      </editorExtension>
   </extension>

API Information: All Hyades editor extensions' classes are instances of org.eclipse.hyades.ui.editors.IEditorExtension.

Supplied Implementation: The Hyades framework itself has a number of pre-defined editor extensions. Particular product installs may include additional editor extensions as required.

Copyright (c) 2003 Hyades project. All rights reserved. This program and the accompanying materials are made available under the terms of the Common Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/cpl-v10.html