Tutorials
Page tree

Versions Compared

Old Version 12

changes.mady.by.user Unknown User (csp)

Saved on

compared with

New Version Current

changes.mady.by.user Unknown User (uru)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Welcome to this tutorial! We will work our way through installing a proper Eclipse setup and developing a first very basic layout algorithm. The layout algorithm will integrate with KIML (KIELER Infrastructure for Meta-Layout ELK (Eclipse Layout Kernel), our very own framework that connects graphical editors with layout algorithms. Once you're finished, you should be able to write layout algorithms for KIMLELK. And you should have a running Eclipse-based application that should look something like this:

...

Now that the preliminaries are out of the way, it's time to develop your first layout algorithm! It will, however, be a very simple one. This tutorial focuses on creating Eclipse plug-ins and on learning how to develop with KIMLELK.

Adding a New Plug-in

We need to create a new plug-in to implement the layout algorithm in. Switch back to the Java or Plug-in Development perspective and follow these steps:

...

Layout algorithms interface with KIML ELK by means of a layout provider class that has to be created and registered with KIML.

...

Before you can test your layout code, you will have to register your new layout provider with KIMLELK.

  1. RicktRight-click the de.cau.cs.kieler.simplelayout package and select New > File.
  2. Create a file simple.elkm and double click it to open it.
  3. When asked whether you want to add the Xtext nature, select yes.

  4. The file is used to specify meta information for your layout algorithm. For this, copy the following code snippet into your editor:

    Code Block
    languagejava
    package de.cau.cs.kieler.simplelayout

bundle {
    label "Simple Layout Algoritms"
    classmetadataClass SimpleOptionsSimpleMetaDataProvider
}

algorithm simple(SimpleLayoutProvider) {
    label "Simple Test Layouter"
    metadataClass SimpleOptions

    supports supports org.eclipse.elk.spacing.border
    supports org.eclipse.elk.spacing.node
}
  5. You still have to register the file with Eclipse. Open the META-INF/MANIFEST.MF file again and switch to the Extensions tab.
  6. Add an extension for org.eclipse.elk.core.layoutProviders.
  7. Right-click the extension and click New > provider.
  8. Set the class to your layout bundle's meta data provider class name (use the browse button and enter SimpleOptions SimpleMetaDataProvider). Note that SimpleOptions SimpleMetaDataProvider is automatically generated from the .elkm file you created. Its name is specified by the class metadataClass keyword in the bundle section. What is also created is the SimpleOptions class, which contains everything you need to access layout options from within your layout algorithm.
  9. Save the editor
  10. Your workspace should look similar to this

...

  1. Click New > Project... > General > Project and set the project name to something like Test.
  2. Right-click the new project and click New > Other > KGraph > Random KGraph. Enter a meaningful name and click Finish.
  3. Open the .kgt file. To show up the Diagram vie, seöect select Window > Show View > Other... > Other > Diagram
  4. Open the Layout view through Window > Show View > Other... > Eclipse Diagram Layout > Layout. Move the view somewhere such that you can see the view and the diagram simultaneously. 
  5. Chose your Simple Test Layouter in the Layout Algorithm section of the Layout View. (If the Layout View shows no properties, click the white background in the Diagram View once.)
  6. You should see something similar to this

...

Once you're done implementing the edge routing code, test it by running your debug configuration again, as before.