Astah Plug-in Development

Create sample Plug-ins

This section will introduce you how to make a Plug-in that adds a menu to Astah.

Creating a new project

First, create a new project. Move to the directory where you want to create a plug-in project then run the command below.:

If you are using Astah Professional or Astah UML:

> astah-generate-project

If you are using Astah SysML:

> astah-sysml-generate-project

If you are using Astah System Safety:

> astah-safety-generate-project

Next, specify the group id, artifact id, version and etc.

A new folder for the Plug-in project will be generated in a name you specified in the artifact id.

The generated project consists of the files below.

Launch Astah with the Plug-in

Launching Astah with the Plug-in you are currently developing.
First, you need to build the project. So, move to the directory of the Plug-in project and then run the command below.:

> astah-build

NOTE:
If you update the ASDK to a newer version, open pom.xml in a text editor and make sure that the version of the astah-maven-plugin matches the one included with the ASDK.
The astah-maven-plugin is located in astah-plugin-SDK-x.x\repository\com\change_vision\astah\astah-maven-plugin.

When it’s built successfully, a new folder “target” is created which includes [artifact id]-[version].jar file.
This is the Plug-in file. Now let’s launch Astah with this Plug-in by running the command below.:

> astah-launch

Then Astah should launch with this Plug-in.

You will see a menu that is added by this Plug-in under [Tools] menu.

Import the Plug-in project to IDE

Astah Plug-in SDK is based on Maven, however, if you would like to use IDE like Eclipse or IntelliJ IDEA to develop Plug-ins instead of using Astah’s Plug-in SDK only, you can do that too. Here’s how you can import the Plug-in project to Eclipse and IntelliJ.

Eclipse

You can run maven commands in Eclipse by using m2e. However, you are not able to set the classpath to JAR while using m2e. So to set the classpath, you need to use astah-mvn command instead of using m2e’s Dependency Management.

1. Installation of Eclipse and m2e

First, install Eclipse and m2e from Eclipse. This package includes m2e.: Eclipse IDE for Java Developers

The installation of this package should not affect anything in your development environment. Therefore we recommend you to use this package. However, if you have Eclipse installed already, you can install m2e from m2e.

2. Configure Astah Plug-in to MAVEN_HOME on Eclipse

Run Eclipse and then choose the workspace and set “Astah Plug-in SDK” to MAVEN_HOME.
Open Eclipse Preference from [Window] – [Preferences] and then select [Maven] – [Installations].
Add Astah Plug-in SDK’s installation directory (ASDK_HOME) as the figure below.

3. Generate config to load classpath for Eclipse

Now, before importing the plug-in project to Eclipse, move to the working directory of Plug-in Project, set the environment variables of M2_HOME to ASDK_HOME and then run the command below.:

> astah-mvn eclipse:eclipse

Now all is ready for you to import the Plug-in project into Eclipse.

IntelliJ IDEA

IntelliJ IDEA has Maven Integration. Please download IntelliJ IDEA from IntelliJ site. When you first run IntelliJ IDEA, a [New Project Wizard] appears for the set up. If you have used IntelliJ IDEA already, please move to the step2 and then import the project.Importing a Plug-in project to IntelliJ IDEA.

1. Import a Plug-in project to IntelliJ IDEA

Please refer to IntelliJ’s resource for how to import projects. However, you need to set the Astah Plug-in SDK on IntelliJ before you import the Plug-in project.

2. Configure MAVEN_HOME to Astah Plug-in on IntelliJ IDEA

Let’s set Astah Plug-in SDK to MAVEN_HOME in IntelliJ IDEA.

Run IntelliJ, and then select [File] – [Settings] – [Maven]. Check the [Override] for Maven home directory and then specify Astah Plug-in SDK install folder(ASDK_HOME) as the figure below.

When the setting is complete, the classpath should be set up also.

Adding a menu to Astah

To create a Plug-in for Astah, an extension point needs to be defined in plugin.xml with the “point” property of <extension> tag. Currently following two extension points are provided.

Below is a sample of how you write plugin.xml to add a menu on Astah.

<?xml version="1.0" encoding="UTF-8"?>
<plugin>
   <extension point="com.change_vision.astah.ui.actionSets">
      <actionSet
            label="%action_set_label"
            visible="true"
            id="com.example.helloworld.actionSet">
         <menu
               id="helloworld"
               label="%menu_group"
               path="tool/helloworld">
         </menu>
         <action
			   label="%menu_label"
               icon="icons/sample.gif"
               class="com.example.actions.HelloWorldAction"
               tooltip="%menu_tooltip"
               menubarPath="tool/helloworld/"
               id="com.example.actions.HelloWorldAction">
         </action>
     </actionSet>
   </extension>
</plugin>

In this sample, <menu> tag is used to add a new menu [Sample Menu] under [Tool]. <action> tag is used to add another menu with Hello World Plug-in under the [Sample Menu]. The location of menu is specified with <action> tag’s menubarpath attribute. The value “tool” is an id of [Tool] menu and it should be specified in the <menu> tag’s path attribute and also <action> tag’s menubarpath attribute. The id of all the menu can be found at Astah Menu ID List. Also <actionSet> tag is used to group all the <action>tags. All the actions when the menu is selected should be specified with <action>’s class attributes.

Here is the summary of the plugin.xml.

Tag Name	Attribute	Required	Description
plugin
extension			Specify extension point
	point		Specify com.change_vision.astah.ui.actionSets
actionSet			Specify the group of menu to menubar
	label		(Not available)
	visible		(Not available)
	id		Specify group ID
menu			Add menu group
	label		Specify label of group menu
	id		Specify id of group menu
	path		Specify location of path
action			Add menu
	label		Specify label of menu
	icon		(Not available)
	class		Specify the class of push the menu
	tooltip		(Not available)
	menubarPath		Specify the location of menu
	id		Specify the id of menu

We will show about action classes later.

Display another language

In this sample, <action> tag’s label is “%menu_label”. This notation is to make the label appear in different languages depending on the environment to run Astah on. The string, “hello_world” is key and label contents are described in both plugin.properties and plugin_ja.properties.

plugin.properties:

menu_label=&Hello World

plugin_ja.properties:

menu_label=こんにちは、ワールド(&H)

If Astah is launched on the Japanese environment, the label appears in Japanese as specified in the plugin_ja.properties and it appears in English as specified in plugin.properties if Astah is launched on other environments.

Make Action Classes

Now you have added a Menu in Astah’s menu bar, now design actions to show “Hello World” message in the menu. To do so, create a class which implements IPluginActionDelegate interface.

/*
 * Please change this class's package to your genearated Plug-in's package.
 * Plug-in's package namespace => com.example
 *   com.change_vision.astah.extension.plugin => X
 *   com.example                              => O
 *   com.example.internal                     => O
 *   learning                                 => X
 */
package com.example.actions;


import javax.swing.JOptionPane;
import com.change_vision.jude.api.inf.ui.IPluginActionDelegate;
import com.change_vision.jude.api.inf.ui.IWindow;

public class HelloWorldAction implements IPluginActionDelegate {

  public Object run(IWindow window) throws UnExpectedException {
      try {
          JOptionPane.showMessageDialog(window.getParent(), "Hello World");

      } catch (Exception e) {
        JOptionPane.showMessageDialog(window.getParent(), "Exception occured", "Alert", JOptionPane.ERROR_MESSAGE);
          throw new UnExpectedException();
      }
      return null;
  }
}

The run() method of the IPluginActionDelegate interface will be called when the menu is clicked in Astah. In this sample, clicking [Hello World] menu makes a dialog appear with “Hello World” message on. Any exception errors happen during the action’s performance will be thrown as a UnExpectedException, inner class of IPlginActionDelegate Interface.