AWM API Usage Guide

To make use of the functionality that AWM provides, the required AWM plug-ins have to be added as dependencies to custom plug-ins.

The following tutorial describes how to create a new Eclipse plug-in which uses the AWM plug-in API.

Plug-in development is done in the Eclipse IDE within the Plug-in Development perspective.

1. Change to the Eclipse Plug-in Development perspective, click Window > Perspective > Open Perspective > Other.

   This opens the Open Perspective dialog box.

   
   
   
2. Click Plug-in Development, and then click OK.
   
   
3. To create a new Eclipse plug-in, click File > New > Plug-in Project.
   
   

   This opens the New Plug-in Project dialog.

4. Type a Java project name in the Project name field.
   
   
5. Click Next.
6. Change the fields as required, and then click Finish.
   
   

   This creates an Eclipse project for the newly-created plug-in in the Project Explorer:
   
   

   The Eclipse plug-in manifest overview is opened in the editor window:
   
   

   The Eclipse plug-in manifest editor manages and edits all the meta information of an Eclipse plug-in.

7. Click the Dependencies tab in the main editor to add the AWM com.microfocus.awm plug-in as a dependency of your plug-in. This enables you to use the AWM API.
8. In the Required Plug-ins pane, click Add.
   
   
9. Type com.microfocus in the Select a Plug-in field, and click com.microfocus.awm from the Matching items list.
   
   
10. Click OK.

    The AWM core plug-in, including all of its required dependencies, are added as dependencies to the plug-in so that you can make use of the public classes and methods provided by the AWM API packages.

11. Click File > Save.

    After saving the changes the Java classes can import classes from AWM packages which are part of the AWM API.