org.jlense.uiworks.openWizards Extension Point

Identifier: org.jlense.uiworks.newWizards

Description: This extension point is used to register wizards for viewing and editing objects.

Open Wizards may be modal or non-modal. A non-modal wizard optionally specify a description subelement whose body should contain short text about the wizard.

Configuration Markup: 

   <!ELEMENT wizard (description)?>
   <!ATTLIST wizard
      id                CDATA #REQUIRED
      name              CDATA #REQUIRED
      icon              CDATA #IMPLIED
      class             CDATA #REQUIRED
      perspectiveID     CDATA #REQUIRED
      modal             CDATA #OPTIONAL
   >
   <!ELEMENT description (#PCDATA)>

  • id - a unique name that can be used to identify this wizard
  • name - a translatable name for the wizard that will be used in the dialog box
  • icon - a relative path of the icon that will be used together with the name to represent the wizard as one of the choices in the creation dialog box.
  • class - a fully qualified name of the Java class implementing org.jlense.uiworks.workbench.INewWizard.
  • perspectiveID - the perspective to use to display the wizard. Most often set to org.jlense.uiworks.FormPerspective.
  • modal - If true then the wizard is displayed in modal dialog. If set to false then the wizard is displayed in a new workbench application window.
  • description - an optional subelement whose body contains a short text describing what the wizard will do when started.

Examples:

Following is an example of open wizard configuration: 

<extension point="org.jlense.uiworks.openWizards">
    <wizard
        id="org.jledger.ui.accounts.AccountWizard"
        name="Account"
        class="org.jledger.ui.accounts.AccountWizard"
        icon="images/Accounts.gif"
        perspectiveID="org.jlense.uiworks.FormPerspective">
            <description>%new.account.wizard.description</description>
    </wizard>
    <wizard
        id="org.jledger.ui.gj.TransactionWizard"
        name="General Journal Transaction"
        class="org.jledger.ui.gj.TransactionWizard"
        icon="images/GeneralJournal.gif"
        perspectiveID="org.jlense.uiworks.FormPerspective">
            <description>%new.transaction.wizard.description</description>
    </wizard>
    <wizard
        id="org.jledger.ui.gj.EntryWizard"
        name="Entry"
        class="org.jledger.ui.gj.EntryWizard"
        icon="images/GeneralJournal.gif"
        perspectiveID="org.jlense.uiworks.FormPerspective"
        modal="true"
        >
            <description>%new.entry.wizard.description</description>
    </wizard>
</extension>

API Information: The value of the class attribute must represent a class that implements org.jlense.uiworks.workbench.IWorkbenchWizard.