NetBeans Visual Library 2.0 - Setup Building Environment

Requirements

The library requires Java 5+ and can be used in NetBeans 5.5+.

Get the Sources

First you have to check out sources.

1. Clone NetBeans Main repository:

   hg clone http://hg.netbeans.org/main/

2. Update your clone of NetBeans Main repository:

   cd main ; hg pull -u

Compilation

Now you can compile the sources.

1. Compile the NetBeans using:

   cd main ; ant

   Note Visual Library project is a part of NetBeans Platform and therefore it is build together with the rest of NetBeans.
2. Optionally clone NetBeans Contrib repository:

   hg clone http://hg.netbeans.org/main/contrib/

   and compile the Visual Library examples: Note: Examples will automatically start, so close the dialog.

   cd contrib/visual.examples ; ant

3. Additionally you may compile Visual Library experimental project:

   cd contrib/visual.experimental ; ant

4. Also you may compile Visual Library with NetBeans Integration sample project:

   cd contrib/visual.examples.shapes ; ant

   You can start the NetBeans and you will find Windows | Open Shape Window main menu action which opens the scene.

Building Minimal Installation for NetBeans 5.5.1

Building the minimal installation for NetBeans 5.5.1 is similar to previous steps. The difference is that the graph module is not tagged with release551 tag. Therefore it has to be checked out from main trunk.

1. Have a empty directory called nb_all, where the sources will be placed.

2. Check out just a minimal set of required modules from release551 branch including graph module:

   cvs -d :pserver:anoncvs@cvs.netbeans.org:/cvs co -r release551 core/external libs/external libs/xerces nbbuild openide/util graph

3. Initialize the NetBeans environment:

   cd nb_all/nbbuild ; ant bootstrap

4. Initialize libraries:

   cd nb_all/libs/external ; ant

5. Compile the openide/util module:

   cd openide/util ; ant

6. Compile the Visual Library:
   

   cd graph/lib ; ant

7. Optionally compile the Visual Library examples:

   cd graph/examples ; ant

   Note: Examples will automatically start, so close the dialog.

Now you have everything compiled. You are just not able to compile/run the graph/integration module.

Building Java Documentation

1. Optionally you may build the openide-util module javadoc:

   cd main/openide.util ; ant javadoc

2. Build the Visual Library javadoc:

   cd main/api.visual ; ant javadoc

Javadocs are build into:

1. main/nbbuild/build/javadoc/org-openide-util/ - contains the openide/util module javadoc.
2. main/nbbuild/build/javadoc/org-netbeans-api-visual/ - contains the Visual Library javadoc.

Distribution Packages

When you compile the library, you have following packages available which you can use outside of NetBeans CVS.

Packages:

1. main/nbbuild/netbeans/platform7/lib/org-openide-util.jar - contains openide/util module.
2. main/nbbuild/netbeans/platform7/modules/org-netbeans-api-visual.jar - contains the Visual Library.
3. main/nbbuild/netbeans/extra/modules/org-netbeans-modules-visual-examples.jar - contains the Visual Library examples.
4. main/nbbuild/netbeans/extra/modules/org-netbeans-modules-visual-experimental.jar - contains the Visual Library Experimental project.
5. main/nbbuild/netbeans/extra/modules/org-netbeans-modules-visual-examples-shapes.jar - contains the Visual Library with NetBeans Integration sample project.

You may copy out the first 2 packages to get a standalone copy of Visual Library. Just put them on your classpath.