freemind.modes

Class ControllerAdapter

public abstract class ControllerAdapter extends Object implements ModeController

Derive from this class to implement the Controller for your mode. Overload the methods you need for your data model, or use the defaults. There are some default Actions you may want to use for easy editing of your model. Take MindMapController as a sample.

Nested Class Summary
protected class	ControllerAdapter.CopyAction
protected class	ControllerAdapter.CopySingleAction
protected class	ControllerAdapter.CutAction
protected class	ControllerAdapter.EditAction
protected class	ControllerAdapter.EditCopyAction
protected class	ControllerAdapter.EditLongAction
protected class	ControllerAdapter.FileOpener
protected class	ControllerAdapter.FindAction
protected class	ControllerAdapter.FindNextAction
protected class	ControllerAdapter.FollowLinkAction
protected class	ControllerAdapter.GotoLinkNodeAction
protected class	ControllerAdapter.NewChildAction
protected class	ControllerAdapter.NewChildWithoutFocusAction
protected class	ControllerAdapter.NewMapAction
protected class	ControllerAdapter.NewPreviousSiblingAction
protected class	ControllerAdapter.NewSiblingAction
protected class	ControllerAdapter.NodeDownAction
protected class	ControllerAdapter.NodeUpAction
protected class	ControllerAdapter.OpenAction
protected class	ControllerAdapter.PasteAction
protected class	ControllerAdapter.RemoveAction
protected class	ControllerAdapter.SaveAction
protected class	ControllerAdapter.SaveAsAction
protected class	ControllerAdapter.SetImageByFileChooserAction
protected class	ControllerAdapter.SetLinkByFileChooserAction
protected class	ControllerAdapter.SetLinkByTextFieldAction
protected class	ControllerAdapter.ToggleChildrenFoldedAction
protected class	ControllerAdapter.ToggleFoldedAction

Field Summary
Action	copy
Action	copySingle
Action	cut
int	NEW_CHILD
int	NEW_CHILD_WITHOUT_FOCUS
int	NEW_SIBLING_BEFORE
int	NEW_SIBLING_BEHIND
Action	paste
protected ControllerAdapter.ControllerPopupMenuListener	popupListenerSingleton Take care!

Constructor Summary
	ControllerAdapter()
	ControllerAdapter(Mode mode)

Method Summary
protected JMenuItem	add(JMenu menu, Action action, String keystroke)
protected void	add(JMenu menu, Action action)
void	addNew(NodeView target, int newNodeMode, KeyEvent e)
void	anotherNodeSelected(MindMapNode n)
protected boolean	binOptionIsTrue(String option)
boolean	close() Return false if user has canceled.
void	doubleClick(MouseEvent e)
void	edit(KeyEvent e, boolean addNew, boolean editLong)
boolean	extendSelection(MouseEvent e)
Controller	getController()
protected FileFilter	getFileFilter() You may want to implement this...
FreeMindMain	getFrame()
protected String	getLinkByFileChooser(FileFilter fileFilter)
MapAdapter	getMap()
protected MapModule	getMapModule()
protected Mode	getMode()
JPopupMenu	getPopupForModel(Object obj) Default implementation: no context menu.
URL	getResource(String name)
protected LinkedList	getSelecteds() fc, 24.1.2004: having two methods getSelecteds with different return values (linkedlists of models resp. views) is asking for trouble.
protected String	getText(String textId) Get text identification of the map
MapView	getView()
void	handleLoadingException(Exception ex)
boolean	isBlocked()
void	load(File file) You may decide to overload this or take the default and implement the functionality in your MapModel (implements MindMap)
void	loadURL(String relative)
void	loadURL()
void	mapOpened(boolean open) Call this method if you have opened a map for this mode with true, and if you have closed a map of this mode with false.
void	mouseWheelMoved(MouseWheelEvent e)
void	newMap()
protected void	newMap(MindMap map)
MapAdapter	newModel() You _must_ implement this if you use one of the following actions: OpenAction, NewMapAction.
protected abstract MindMapNode	newNode()
void	nodeChanged(MindMapNode n)
void	open()
void	plainClick(MouseEvent e)
boolean	save()
boolean	save(File file) Return false is the action was cancelled, e.g. when it has to lead to saving as.
boolean	saveAs() Save as; return false is the action was cancelled
protected void	setAllActions(boolean enabled) Overwrite this to set all of your actions which are dependent on whether there is a map or not.
protected void	setImageByFileChooser()
protected void	setLinkByFileChooser()
protected void	setLinkByTextField()
protected void	setMode(Mode mode)
void	showPopupMenu(MouseEvent e)
protected void	toggleChildrenFolded() If any children are folded, unfold all folded children.
void	toggleFolded()
protected void	updateMapModuleName()

Field Detail

copy

public Action copy

copySingle

public Action copySingle

cut

public Action cut

NEW_CHILD

public final int NEW_CHILD

NEW_CHILD_WITHOUT_FOCUS

public final int NEW_CHILD_WITHOUT_FOCUS

NEW_SIBLING_BEFORE

public final int NEW_SIBLING_BEFORE

NEW_SIBLING_BEHIND

public final int NEW_SIBLING_BEHIND

paste

public Action paste

popupListenerSingleton

protected final ControllerAdapter.ControllerPopupMenuListener popupListenerSingleton

Take care! This listener is also used for modelpopups (as for graphical links).

Constructor Detail

ControllerAdapter

public ControllerAdapter()

ControllerAdapter

public ControllerAdapter(Mode mode)

Method Detail

add

protected JMenuItem add(JMenu menu, Action action, String keystroke)

Returns: returns the new JMenuItem.

add

protected void add(JMenu menu, Action action)

addNew

public void addNew(NodeView target, int newNodeMode, KeyEvent e)

anotherNodeSelected

public void anotherNodeSelected(MindMapNode n)

binOptionIsTrue

protected boolean binOptionIsTrue(String option)

close

public boolean close()

Return false if user has canceled.

doubleClick

public void doubleClick(MouseEvent e)

edit

public void edit(KeyEvent e, boolean addNew, boolean editLong)

extendSelection

public boolean extendSelection(MouseEvent e)

getController

public Controller getController()

getFileFilter

protected FileFilter getFileFilter()

You may want to implement this... It returns the FileFilter that is used by the open() and save() JFileChoosers.

getFrame

public FreeMindMain getFrame()

getLinkByFileChooser

protected String getLinkByFileChooser(FileFilter fileFilter)

getMap

public MapAdapter getMap()

getMapModule

protected MapModule getMapModule()

getMode

protected Mode getMode()

getPopupForModel

public JPopupMenu getPopupForModel(Object obj)

Default implementation: no context menu.

getResource

public URL getResource(String name)

getSelecteds

protected LinkedList getSelecteds()

fc, 24.1.2004: having two methods getSelecteds with different return values (linkedlists of models resp. views) is asking for trouble. @see MapView

getText

protected String getText(String textId)

Get text identification of the map

getView

public MapView getView()

handleLoadingException

public void handleLoadingException(Exception ex)

isBlocked

public boolean isBlocked()

load

public void load(File file)

You may decide to overload this or take the default and implement the functionality in your MapModel (implements MindMap)

loadURL

public void loadURL(String relative)

loadURL

public void loadURL()

mapOpened

public void mapOpened(boolean open)

Call this method if you have opened a map for this mode with true, and if you have closed a map of this mode with false. It updates the Actions that are dependent on whether there is a map or not. --> What to do if either newMap or load or close are overwritten by a concrete implementation? uups.