freemind.modes
Interface MindMap

All Superinterfaces:
javax.swing.tree.TreeModel
All Known Implementing Classes:
BrowseMapModel, FileMapModel, MapAdapter, MindMapMapModel, SchemeMapModel

public interface MindMap
extends javax.swing.tree.TreeModel


Method Summary
 void destroy()
          Destroy everything you have created upon opening.
 java.lang.String getAsHTML(java.util.List mindMapNodes)
           
 java.lang.String getAsPlainText(java.util.List mindMapNodes)
           
 java.lang.String getAsRTF(java.util.List mindMapNodes)
           
 java.io.File getFile()
          Returns the file name of the map edited or null if not possible.
 Filter getFilter()
           
 void getFilteredXml(java.io.Writer fileout)
          writes the content of the map to a writer.
 MindMapLinkRegistry getLinkRegistry()
           
 ModeController getModeController()
           
 javax.swing.tree.TreeNode[] getPathToRoot(javax.swing.tree.TreeNode node)
           
 MapRegistry getRegistry()
           
 java.lang.String getRestoreable()
          Returns a string that may be given to the modes restore() to get this map again.
 MindMapNode getRootNode()
           
 java.net.URL getURL()
          Return URL of the map (whether as local file or a web location)
 void getXml(java.io.Writer fileout)
          writes the content of the map to a writer.
 boolean isReadOnly()
           
 boolean isSaved()
           
 void nodeChanged(javax.swing.tree.TreeNode node)
           
 void nodeRefresh(javax.swing.tree.TreeNode node)
           
 void nodeStructureChanged(javax.swing.tree.TreeNode node)
           
 void setFilter(Filter inactiveFilter)
           
 void setSaved(boolean isSaved)
          Use this method to make the map dirty/clean.
 
Methods inherited from interface javax.swing.tree.TreeModel
addTreeModelListener, getChild, getChildCount, getIndexOfChild, getRoot, isLeaf, removeTreeModelListener, valueForPathChanged
 

Method Detail

getRootNode

MindMapNode getRootNode()

getModeController

ModeController getModeController()
Returns:
The mode controller, the model belongs to.

nodeChanged

void nodeChanged(javax.swing.tree.TreeNode node)

nodeRefresh

void nodeRefresh(javax.swing.tree.TreeNode node)

getAsPlainText

java.lang.String getAsPlainText(java.util.List mindMapNodes)

getAsRTF

java.lang.String getAsRTF(java.util.List mindMapNodes)

getAsHTML

java.lang.String getAsHTML(java.util.List mindMapNodes)

getFile

java.io.File getFile()
Returns the file name of the map edited or null if not possible.


getURL

java.net.URL getURL()
                    throws java.net.MalformedURLException
Return URL of the map (whether as local file or a web location)

Throws:
java.net.MalformedURLException

getXml

void getXml(java.io.Writer fileout)
            throws java.io.IOException
writes the content of the map to a writer.

Throws:
java.io.IOException

getFilteredXml

void getFilteredXml(java.io.Writer fileout)
                    throws java.io.IOException
writes the content of the map to a writer.

Throws:
java.io.IOException

getRestoreable

java.lang.String getRestoreable()
Returns a string that may be given to the modes restore() to get this map again. The Mode must take care that two different maps don't give the same restoreable key.


getPathToRoot

javax.swing.tree.TreeNode[] getPathToRoot(javax.swing.tree.TreeNode node)

getLinkRegistry

MindMapLinkRegistry getLinkRegistry()
Returns:
returns the link registry associated with this mode, or null, if no registry is present.

destroy

void destroy()
Destroy everything you have created upon opening.


isReadOnly

boolean isReadOnly()

isSaved

boolean isSaved()
Returns:
true if map is clean (saved), false if it is dirty.

getRegistry

MapRegistry getRegistry()

getFilter

Filter getFilter()

setFilter

void setFilter(Filter inactiveFilter)

nodeStructureChanged

void nodeStructureChanged(javax.swing.tree.TreeNode node)

setSaved

void setSaved(boolean isSaved)
Use this method to make the map dirty/clean.

Parameters:
isSaved -