Version 8.3.2
 —  Appendices  —

Setting Up the Eclipse Plug-in

The following topics are covered below:


About the Eclipse Plug-in

Application Designer's Eclipse plug-in allows you to edit Application Designer layouts directly inside Eclipse. When the plug-in has been installed and configured, you can use the Layout Painter and some other Application Designer tools in Eclipse.

graphics/ecl-plugin-layout.png

Top of page

Installing the Eclipse Plug-in

The plug-in is delivered with the Application Designer software. After the installation of Application Designer, a directory with the name EclipsePlugin is available in your <installdir>/tomcat/webapps/cis directory.

The Eclipse plug-in consists of two parts which have to be installed separately: the common part and the GUI part. You must first install the common part.

Start of instruction setTo install the common part of the Eclipse plug-in

It is required that your servlet container has been started.

  1. From the Help menu of Eclipse, choose Software Updates > Find and Install.

    A dialog appears.

  2. Select the option button Search for new features to install.

  3. Choose the Next button.

  4. On the resulting page, choose the New Remote Site button.

    The following dialog box appears.

    New update site

  5. In the Name text box, specify a name of your choice.

  6. In the URL text box, specify the path to the Eclipse plug-in. For example:

    http://localhost:51000/cis/EclipsePlugin/com.softwareag.common
  7. Choose the OK button.

Start of instruction setTo install the GUI part of the Eclipse plug-in

Top of page

Creating an Eclipse Project for the Eclipse Plug-in

You create an Eclipse project in the same way as described in Creating a Java Project in Eclipse.

Top of page

Configuring the Eclipse Project

Each Application Designer project has an project/xml directory in which the layouts are kept. This directory needs to be defined in Eclipse. To do so, you have to modify the properties of each Eclipse project that you create for the Eclipse plug-in.

Start of instruction setTo configure the Eclipse project

  1. Select the Eclipse project.

  2. Invoke the context menu and choose Properties.

  3. Enable the check box Enable Application Designer Access.

  4. In the Layout Folder text box, specify the path to your project's xml folder.

    Properties

  5. If required, change the properties of the Web Server Connection and the Web Application in this dialog box. See the Tomcat documentation for more details.

  6. Select the display mode for the Layout Painter and Layout Tester:

  7. Choose the OK button.

    The Page Layouts node is automatically created in the Navigator view. See below.

Top of page

Elements of the Eclipse Plug-in

In order to work with the Eclipse plug-in, your servlet container must have been started. See Starting the Servlet Container in the Development Workplace documentation.

The Eclipse plug-in provides the following tools:

You use these tools in a similar way as those in the development workplace. See the Development Workplace documentation for further information. The descriptions in the Development Workplace documentation also apply to the Eclipse plug-in; the only difference in the Eclipse plug-in is that the tools are invoked in a different way (see below). The screenshots in the Development Workplace documentation also apply - with slight differences - to the Eclipse plug-in.

Project Manager

Start of instruction setTo invoke the Project Manager

  1. From the Window menu, choose Show View > Other.

  2. In the resulting Show View dialog box, expand the Software AG Application Designer node.

  3. Select the entry Tool - Project Manager and choose the OK button.

    A list of existing application projects is now shown.

Layout Painter

Start of instruction setTo create a new layout

  1. In the Navigator view, select the Page Layouts node. This node contains all XML layout definitions.

  2. From the File menu, choose New > Other.

  3. In the resulting dialog box, expand the Software AG node.

  4. Select the entry Application Designer Layout and choose the Next button.

  5. In the resulting dialog box, enter the name of the file that is to contain your layout definition. The name must end with ".xml".

  6. Select the layout template that you want to use.

  7. Choose the Finish button.

    The Layout Painter appears.

Start of instruction setTo open an existing layout

  1. In the Navigator view, select the layout in the Page Layouts node.

  2. Invoke the context menu and choose Open With > Layout Painter.

    The Layout Painter appears.

Style Sheet Editor

Start of instruction setTo invoke the Style Sheet Editor

  1. From the Window menu, choose Show View > Other.

  2. In the resulting Show View dialog box, expand the Software AG Application Designer node.

  3. Select the entry Tool - Style Sheet Editor and choose the OK button.

Control Editor

Start of instruction setTo invoke the Control Editor

  1. From the Window menu, choose Show View > Other.

  2. In the resulting Show View dialog box, expand the Software AG Application Designer node.

  3. Select the entry Tool - Control Editor and choose the OK button.

    A dialog appears, listing all available editor extensions.

  4. Choose the editor extension that you want to open.

    The contents of the editor extension are loaded into the Control Editor. You can now edit your editor extension.

Monitoring

Start of instruction setTo invoke the monitoring tool

  1. From the Window menu, choose Show View > Other.

  2. In the resulting Show View dialog box, expand the Software AG Application Designer node.

  3. Select the entry System Monitoring and choose the OK button.

Layout Tester

The Layout Tester can be used to test the currently defined layout according to the display mode which is defined in the properties of the Eclipse project: it is either shown as in the browser or as in the SWT client.

Start of instruction setTo invoke the Layout Tester

  1. Select the layout in the Navigator view.

  2. Invoke the context menu and choose Open With > Layout Tester.

Top of page