Program design

This page describes the current program design.

Currently this page is small, 
Ask questions so that the team members can extend 
the points you are interested in. DimitriPolivaev

Note: Someone should review this page every couple of versions and bring it up-to-date. This version of the page is based on the 0.9.0 code base.

Architecture Design

FreeMind is a Java application that uses the Java Swing library. The basic design is based on the Model-View-Controller model.

It's central graphic components (MapView and NodeView) allow displaying of arbitrary map implementations implementing interface MindMap extending swing interface TreeModel. The implementations include currently

• MindMapMapModel used for editing of mind maps,
• BrowseMapModel used for displaying a mind map in a browser or in a so-called browse mode,
• FileMapModel used for displaying of file directory tree as a mind map.

All kinds of MindMap use MindMapNode for representing a single node.

Different modes are equipped with mode controllers implementing interface ModeController. The mode controllers are responsible for registering of Actions, Menu Items, Hot Keys and Mouse Listeners which are available for the user. The mode controller of the edit mode MindMapMode takes the required menu structure from file mindmap_menus.xml. It can also include classes registered as Plug-Ins and loaded at the run-time using reflection.

It makes possible to create a relatively compact freemindbrowser.jar that can be used in the applet viewer with a subset of the classes that makeup the whole FreeMind program.

Controller

The controller and mode controller classes set up all the Actions that are used to respond to user input and make changes to the model.

The main Controller class needs a FreeMindFrame for it's constructor. FreeMindFrame is an Interface. This gives Controller the ability to call back into the FreeMind class which implements FreeMindMain.

NOTE: Because of the way this reference is handled, the coupling between the model, the view, and the controller appears to be very high. I haven't finished going through it all, but it appears, to me, that there might be some benefit in reducing the size and complexity of these classes in order to reduce the coupling. High coupling (Calls back and forth between modules) can be a source of frequent bugs.

At the moment, it looks as if I might have to code up my own versions of Controller and MapView in order to create the preview pane for the redesigned Format Dialog. I might just still be confused. What I want to do, is to create a preview pane, essentially a JPanel, which can show how the formatting changes will look. Right now, it appears that with the current way things are done, all changes are made directly to the properties of the model. For my purposes, it would be better to be able to get a copy of the properties, let the user play with them, and then copy them back when, and if, the user hits the Okay button. (** Commentary **) - I use this tag to mark stuff I want to delete out later.

Plug-Ins

The plug-ins provide additional functions that aren't needed by everyone. For instance, the SVG plug-in gives you the capability of exporting your Mind Maps to SVG format. These modules are left out of the minimum download configurations in order to save space.

Startup

1. Freemind is started by invoking a script:

Starting Scripts

Windows	freemind.bat
Linux	freemind.sh

2. The main class invoked by the script is: freemind.main.FreeMindStarter
3. FreeMindStarter checks the Java version and then invokes Freemind.main.
4. The Freemind takes care of initialization, setting the look and feel, loads maps and makes the GUI visible.

   NOTE:It might make some sense to refactor this class, it's very large and complicated.

5. As soon as one map is opened or new map is created, its freemind.modes.ModeController takes control over.

GUI Design Principles

The purpose of FreeMind is to provide an easy-to-use Mind Mapping application. It is important to make the users experience with the program as easy, natural, and intuitive as possible. The interface should be uncluttered and easy to navigate.

Need more on this from people who know more about the program.

Distribution

Required Library Files

• lib\freemind.jar
• lib\commons-lang-2.0.jar
• lib\forms-1.0.5.jar
• lib\jibx\jibx-run.jar
• lib\jibx\xpp3.jar
• lib\bindings.jar