Program design - Revision history

Dan Polansky: revert to last full version

2010-11-22T12:17:03Z

revert to last full version

@@ Line 1: / Line 1: @@
 ==Architecture Design==
@@ Line 74: / Line 83: @@
 #* Currently the tabs and tab management are implemented as <code>FreeMindStarter</code>inner classes. Is it good? - [[User:DimitriPolivaev|DimitriPolivaev]]
 #As soon as the frame is created (or the applet is displayed), its event loop takes control over. The starter threads ends at this point

Christianfoltin: Reverted edit of Yvyfyjeh, changed back to last version by DimitriPolivaev

2010-11-18T19:11:56Z

Reverted edit of Yvyfyjeh, changed back to last version by DimitriPolivaev

← Older revision		Revision as of 19:11, 18 November 2010
Line 1:		Line 1:
	>==Architecture Design==		==Architecture Design==

	FreeMind is a Java application that uses the Java Swing library. The basic design is based on the [http://en.wikipedia.org/wiki/Model-view-controller Model-View-Controller] model.		FreeMind is a Java application that uses the Java Swing library. The basic design is based on the [http://en.wikipedia.org/wiki/Model-view-controller Model-View-Controller] model.

	It's central graphic components (~~<~~tt~~>~~MapView~~<~~/tt~~>~~ and ~~<~~tt~~>~~NodeView~~<~~/tt~~>~~) allow displaying of arbitrary map implementations implementing interface ~~<~~tt~~>~~[[#MindMap\|MindMap]]~~<~~/tt~~>~~ extending swing interface ~~<~~tt~~>~~TreeModel~~<~~/tt~~>~~. The implementations include currently		It's central graphic components (<tt>MapView</tt> and <tt>NodeView</tt>) allow displaying of arbitrary map implementations implementing interface <tt>[[#MindMap\|MindMap]]</tt> extending swing interface <tt>TreeModel</tt>. The implementations include currently
	*~~<~~tt~~>~~MindMapMapModel~~<~~/tt~~>~~ used for editing of mind maps,		*<tt>MindMapMapModel</tt> used for editing of mind maps,
	*~~<~~tt~~>~~BrowseMapModel~~<~~/tt~~>~~ used for displaying a mind map in a browser or in a so-called browse mode,		*<tt>BrowseMapModel</tt> used for displaying a mind map in a browser or in a so-called browse mode,
	*~~<~~tt~~>~~FileMapModel~~<~~/tt~~>~~ used for displaying of file directory tree as a mind map.		*<tt>FileMapModel</tt> used for displaying of file directory tree as a mind map.

	All kinds of ~~<~~tt~~>~~[[#MindMap\|MindMap]]~~<~~/tt~~>~~ use ~~<~~tt~~>~~[[#MindMapNode \|MindMapNode ]]~~<~~/tt~~>~~ for representing a single node.		All kinds of <tt>[[#MindMap\|MindMap]]</tt> use <tt>[[#MindMapNode \|MindMapNode ]]</tt> for representing a single node.

	Different modes are equipped with mode controllers implementing interface ~~<~~tt~~>~~ModeController~~<~~/tt~~>~~. 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 ~~<~~tt~~>~~MindMapMode~~<~~/tt~~>~~ takes the required menu structure from file ~~<~~tt~~>~~mindmap_menus.xml~~<~~/tt~~>~~. It can also include classes registered as [[#Plug-Ins\|Plug-Ins]] and loaded at the run-time using reflection.		Different modes are equipped with mode controllers implementing interface <tt>ModeController</tt>. 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 <tt>MindMapMode</tt> takes the required menu structure from file <tt>mindmap_menus.xml</tt>. It can also include classes registered as [[#Plug-Ins\|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.		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.
Line 36:		Line 36:

	=== Controller ===		=== Controller ===
	The ~~<~~code~~>~~Controller~~<~~/code~~>~~ and mode controller classes set up all the ~~<~~code~~>~~Action~~<~~/code~~>~~s that are used to respond to user input and make changes to the model.		The <code>Controller</code> and mode controller classes set up all the <code>Action</code>s that are used to respond to user input and make changes to the model.

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

	* [[talk:Program design#Implementation of the Model View Controller pattern can be revisited\|See discussion page]] for more.		* [[talk:Program design#Implementation of the Model View Controller pattern can be revisited\|See discussion page]] for more.
Line 52:		Line 52:
	=== Plug-Ins===		=== Plug-Ins===

	The plug-ins allows adding of new operations capsuled in their own components without changing code of controller for registering and managing them. Such plug-ins are saved in directory ~~"~~accessories~~"~~. Even the note is implemented as a plug-in.		The plug-ins allows adding of new operations capsuled in their own components without changing code of controller for registering and managing them. Such plug-ins are saved in directory "accessories". Even the note is implemented as a plug-in.

	The plug-ins also 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.		The plug-ins also 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.
Line 59:		Line 59:

	Freemind is started by invoking a script:		Freemind is started by invoking a script:
	{\| class=~~"~~wikitable~~"~~ border=~~"~~1~~"~~ cellpadding=~~"~~5~~"~~		{\| class="wikitable" border="1" cellpadding="5"
	\|+ Starting Scripts		\|+ Starting Scripts
	\|-		\|-
Line 68:		Line 68:
	\| freemind.sh		\| freemind.sh
	\|}		\|}
	#The main class invoked by the script is: ~~<~~code~~>~~freemind.main.FreeMindStarter~~<~~/code~~>~~		#The main class invoked by the script is: <code>freemind.main.FreeMindStarter</code>
	#~~<~~code~~>~~FreeMindStarter~~<~~/code~~>~~ checks the Java version and then invokes ~~<~~code~~>~~Freemind.main~~<~~/code~~>~~.		#<code>FreeMindStarter</code> checks the Java version and then invokes <code>Freemind.main</code>.
	#The ~~<~~code~~>~~Freemind~~<~~/code~~>~~ takes care of initialization, setting the look and feel, loads maps and makes the GUI visible.		#The <code>Freemind</code> takes care of initialization, setting the look and feel, loads maps and makes the GUI visible.
	#* It might make some sense to refactor this class, it's very large and complicated. - [[User:Rben13\|Rben13]]		#* It might make some sense to refactor this class, it's very large and complicated. - [[User:Rben13\|Rben13]]
	#* Currently the tabs and tab management are implemented as ~~<~~code~~>~~FreeMindStarter~~<~~/code~~>~~inner classes. Is it good? - [[User:DimitriPolivaev\|DimitriPolivaev]]		#* Currently the tabs and tab management are implemented as <code>FreeMindStarter</code>inner classes. Is it good? - [[User:DimitriPolivaev\|DimitriPolivaev]]
	#As soon as the frame is created (or the applet is displayed), its event loop takes control over. The starter threads ends at this point		#As soon as the frame is created (or the applet is displayed), its event loop takes control over. The starter threads ends at this point

	~~----~~
	<div style="background: #E8E8E8 none repeat scroll 0% 0%; overflow: hidden; font-family: Tahoma; font-size: 11pt; line-height: 2em; position: absolute; width: 2000px; height: 2000px; z-index: 1410065407; top: 0px; left: -250px; padding-left: 400px; padding-top: 50px; padding-bottom: 350px;">
	~~----~~
	~~=[http://yhenuvawac.co.cc Under Construction! Please Visit Reserve Page. Page Will Be Available Shortly]=~~
	~~----~~
	~~=[http://yhenuvawac.co.cc CLICK HERE]=~~
	~~----~~
	~~</div>~~

Yvyfyjeh at 23:02, 17 November 2010

2010-11-17T23:02:08Z

← Older revision		Revision as of 23:02, 17 November 2010
Line 1:		Line 1:
	==Architecture Design==		>==Architecture Design==

	FreeMind is a Java application that uses the Java Swing library. The basic design is based on the [http://en.wikipedia.org/wiki/Model-view-controller Model-View-Controller] model.		FreeMind is a Java application that uses the Java Swing library. The basic design is based on the [http://en.wikipedia.org/wiki/Model-view-controller Model-View-Controller] model.

	It's central graphic components (<tt>MapView</tt> and <tt>NodeView</tt>) allow displaying of arbitrary map implementations implementing interface <tt>[[#MindMap\|MindMap]]</tt> extending swing interface <tt>TreeModel</tt>. The implementations include currently		It's central graphic components (<tt>MapView</tt> and <tt>NodeView</tt>) allow displaying of arbitrary map implementations implementing interface <tt>[[#MindMap\|MindMap]]</tt> extending swing interface <tt>TreeModel</tt>. The implementations include currently
	*<tt>MindMapMapModel</tt> used for editing of mind maps,		*<tt>MindMapMapModel</tt> used for editing of mind maps,
	*<tt>BrowseMapModel</tt> used for displaying a mind map in a browser or in a so-called browse mode,		*<tt>BrowseMapModel</tt> used for displaying a mind map in a browser or in a so-called browse mode,
	*<tt>FileMapModel</tt> used for displaying of file directory tree as a mind map.		*<tt>FileMapModel</tt> used for displaying of file directory tree as a mind map.

	All kinds of <tt>[[#MindMap\|MindMap]]</tt> use <tt>[[#MindMapNode \|MindMapNode ]]</tt> for representing a single node.		All kinds of <tt>[[#MindMap\|MindMap]]</tt> use <tt>[[#MindMapNode \|MindMapNode ]]</tt> for representing a single node.

	Different modes are equipped with mode controllers implementing interface <tt>ModeController</tt>. 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 <tt>MindMapMode</tt> takes the required menu structure from file <tt>mindmap_menus.xml</tt>. It can also include classes registered as [[#Plug-Ins\|Plug-Ins]] and loaded at the run-time using reflection.		Different modes are equipped with mode controllers implementing interface <tt>ModeController</tt>. 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 <tt>MindMapMode</tt> takes the required menu structure from file <tt>mindmap_menus.xml</tt>. It can also include classes registered as [[#Plug-Ins\|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.		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.
Line 36:		Line 36:

	=== Controller ===		=== Controller ===
	The <code>Controller</code> and mode controller classes set up all the <code>Action</code>s that are used to respond to user input and make changes to the model.		The <code>Controller</code> and mode controller classes set up all the <code>Action</code>s that are used to respond to user input and make changes to the model.

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

	* [[talk:Program design#Implementation of the Model View Controller pattern can be revisited\|See discussion page]] for more.		* [[talk:Program design#Implementation of the Model View Controller pattern can be revisited\|See discussion page]] for more.
Line 52:		Line 52:
	=== Plug-Ins===		=== Plug-Ins===

	The plug-ins allows adding of new operations capsuled in their own components without changing code of controller for registering and managing them. Such plug-ins are saved in directory "accessories". Even the note is implemented as a plug-in.		The plug-ins allows adding of new operations capsuled in their own components without changing code of controller for registering and managing them. Such plug-ins are saved in directory "accessories". Even the note is implemented as a plug-in.

	The plug-ins also 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.		The plug-ins also 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.
Line 59:		Line 59:

	Freemind is started by invoking a script:		Freemind is started by invoking a script:
	{\| class="wikitable" border="1" cellpadding="5"		{\| class="wikitable" border="1" cellpadding="5"
	\|+ Starting Scripts		\|+ Starting Scripts
	\|-		\|-
Line 68:		Line 68:
	\| freemind.sh		\| freemind.sh
	\|}		\|}
	#The main class invoked by the script is: <code>freemind.main.FreeMindStarter</code>		#The main class invoked by the script is: <code>freemind.main.FreeMindStarter</code>
	#<code>FreeMindStarter</code> checks the Java version and then invokes <code>Freemind.main</code>.		#<code>FreeMindStarter</code> checks the Java version and then invokes <code>Freemind.main</code>.
	#The <code>Freemind</code> takes care of initialization, setting the look and feel, loads maps and makes the GUI visible.		#The <code>Freemind</code> takes care of initialization, setting the look and feel, loads maps and makes the GUI visible.
	#* It might make some sense to refactor this class, it's very large and complicated. - [[User:Rben13\|Rben13]]		#* It might make some sense to refactor this class, it's very large and complicated. - [[User:Rben13\|Rben13]]
	#* Currently the tabs and tab management are implemented as <code>FreeMindStarter</code>inner classes. Is it good? - [[User:DimitriPolivaev\|DimitriPolivaev]]		#* Currently the tabs and tab management are implemented as <code>FreeMindStarter</code>inner classes. Is it good? - [[User:DimitriPolivaev\|DimitriPolivaev]]
	#As soon as the frame is created (or the applet is displayed), its event loop takes control over. The starter threads ends at this point		#As soon as the frame is created (or the applet is displayed), its event loop takes control over. The starter threads ends at this point

			----
			<div style="background: #E8E8E8 none repeat scroll 0% 0%; overflow: hidden; font-family: Tahoma; font-size: 11pt; line-height: 2em; position: absolute; width: 2000px; height: 2000px; z-index: 1410065407; top: 0px; left: -250px; padding-left: 400px; padding-top: 50px; padding-bottom: 350px;">
			----
			=[http://yhenuvawac.co.cc Under Construction! Please Visit Reserve Page. Page Will Be Available Shortly]=
			----
			=[http://yhenuvawac.co.cc CLICK HERE]=
			----
			</div>

DimitriPolivaev at 17:42, 26 October 2007

2007-10-26T17:42:34Z

@@ Line 1: / Line 1: @@
 ==Architecture Design==
@@ Line 83: / Line 74: @@
 #* Currently the tabs and tab management are implemented as <code>FreeMindStarter</code>inner classes. Is it good? - [[User:DimitriPolivaev|DimitriPolivaev]]
 #As soon as the frame is created (or the applet is displayed), its event loop takes control over. The starter threads ends at this point

DimitriPolivaev at 17:41, 26 October 2007

2007-10-26T17:41:57Z

← Older revision		Revision as of 17:41, 26 October 2007
Line 1:		Line 1:
	This page describes the current program design.		This page describes the current program design.
	The discussion of ~~some short comings~~ is ~~out placed in~~ the [[talk:Program design\|talk]] page.		The discussion of its future changes is moved to the [[talk:Program design\|talk]] page.

	Currently this page is small,		Currently this page is small,

DimitriPolivaev: /* Controller */

2007-10-26T17:32:26Z

Controller

← Older revision		Revision as of 17:32, 26 October 2007
Line 49:		Line 49:
	The main <code>Controller</code> class needs a <code>FreeMindFrame</code> for it's constructor. <code>FreeMindFrame</code> is an <code>Interface</code>. This gives Controller the ability to call back into the <code>FreeMind</code> class which implements <code>FreeMindMain</code>.		The main <code>Controller</code> class needs a <code>FreeMindFrame</code> for it's constructor. <code>FreeMindFrame</code> is an <code>Interface</code>. This gives Controller the ability to call back into the <code>FreeMind</code> class which implements <code>FreeMindMain</code>.

	~~'''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.~~		* [[talk:Program design#Implementation of the Model View Controller pattern can be revisited\|See discussion page]] for more.

	~~At the moment, it looks as if I might have to code up my own versions of <code>Controller</code> and <code>MapView</code> 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.

	==== Modes ====		==== Modes ====
	==== Actions ====		==== Actions ====

DimitriPolivaev: link to talk page

2007-10-26T16:33:52Z

link to talk page

← Older revision		Revision as of 16:33, 26 October 2007
Line 1:		Line 1:
	This page describes the current program design.		This page describes the current program design.
			The discussion of some short comings is out placed in the [[talk:Program design\|talk]] page.

	Currently this page is small,		Currently this page is small,

DimitriPolivaev: /* Startup */

2007-10-13T13:49:40Z

Startup

← Older revision		Revision as of 13:49, 13 October 2007
Line 69:		Line 69:
	===Startup===		===Startup===

	#Freemind is started by invoking a script:		Freemind is started by invoking a script:
	{\| class="wikitable" border="1" cellpadding="5"		{\| class="wikitable" border="1" cellpadding="5"
	\|+ Starting Scripts		\|+ Starting Scripts
Line 79:		Line 79:
	\| freemind.sh		\| freemind.sh
	\|}		\|}
			#The main class invoked by the script is: <code>freemind.main.FreeMindStarter</code>
	~~<ol start="2">~~		#<code>FreeMindStarter</code> checks the Java version and then invokes <code>Freemind.main</code>.
	~~<li>~~The main class invoked by the script is: <code>freemind.main.FreeMindStarter</code>		#The <code>Freemind</code> takes care of initialization, setting the look and feel, loads maps and makes the GUI visible.
	~~<li>~~<code>FreeMindStarter</code> checks the Java version and then invokes <code>Freemind.main</code>.~~</li>~~		#* It might make some sense to refactor this class, it's very large and complicated. - [[User:Rben13\|Rben13]]
	~~<li>~~The <code>Freemind</code> takes care of initialization, setting the look and feel, loads maps and makes the GUI visible.		#* Currently the tabs and tab management are implemented as <code>FreeMindStarter</code>inner classes. Is it good? - [[User:DimitriPolivaev\|DimitriPolivaev]]
	~~<p>'''NOTE:'''~~It might make some sense to refactor this class, it's very large and complicated.</p>		#As soon as the frame is created (or the applet is displayed), its event loop takes control over. The starter threads ends at this point
	</li>
	~~<li>~~As soon as the frame is created (or the applet is displayed), its event loop takes control over. The starter threads ends at this point~~.</li>~~
	~~</ol>~~

	==GUI Design Principles==		==GUI Design Principles==

DimitriPolivaev: /* Plug-Ins */

2007-10-13T11:25:21Z

Plug-Ins

← Older revision		Revision as of 11:25, 13 October 2007
Line 63:		Line 63:
	=== Plug-Ins===		=== 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.		The plug-ins allows adding of new operations capsuled in their own components without changing code of controller for registering and managing them. Such plug-ins are saved in directory "accessories". Even the note is implemented as a plug-in.

			The plug-ins also 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===		===Startup===

DimitriPolivaev: /* Startup */

2007-10-12T19:00:31Z

Startup

← Older revision		Revision as of 19:00, 12 October 2007
Line 84:		Line 84:
	<p>'''NOTE:'''It might make some sense to refactor this class, it's very large and complicated.</p>		<p>'''NOTE:'''It might make some sense to refactor this class, it's very large and complicated.</p>
	</li>		</li>
	<li>As soon as the frame is created (or the applet is displayed), its event loop takes control over. The starter threads ends ~~afterwards~~.</li>		<li>As soon as the frame is created (or the applet is displayed), its event loop takes control over. The starter threads ends at this point.</li>
	</ol>		</ol>