freemind.modes
Interface MindMap

All Superinterfaces:
javax.swing.tree.TreeModel
All Known Implementing Classes:
MapAdapter

public interface MindMap
extends javax.swing.tree.TreeModel


Method Summary
 java.awt.datatransfer.Transferable copy()
           
 java.awt.datatransfer.Transferable copy(java.util.List selectedNodes, java.lang.String inPlainText)
           
 java.awt.datatransfer.Transferable copy(MindMapNode node)
           
 java.awt.datatransfer.Transferable copySingle()
           
 java.awt.datatransfer.Transferable cut(MindMapNode node)
           
 void destroy()
          Destroy everything you have created upon opening.
 java.lang.String getAsPlainText(java.util.List mindMapNodes)
           
 java.lang.String getAsRTF(java.util.List mindMapNodes)
           
 java.awt.Color getBackgroundColor()
           
 java.io.File getFile()
          Returns the file name of the map edited or null if not possible.
 MindMapLinkRegistry getLinkRegistry()
           
 java.lang.Object[] getPathToRoot(javax.swing.tree.TreeNode node)
           
 java.lang.String getRestoreable()
          Returns a string that may be given to the modes restore() to get this map again.
 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.
 void insertNodeInto(MindMapNode newChild, MindMapNode parent, int index)
           
 boolean isReadOnly()
           
 void nodeChanged(javax.swing.tree.TreeNode node)
           
 void setBackgroundColor(java.awt.Color color)
           
 
Methods inherited from interface javax.swing.tree.TreeModel
addTreeModelListener, getChild, getChildCount, getIndexOfChild, getRoot, isLeaf, removeTreeModelListener, valueForPathChanged
 

Method Detail

nodeChanged

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

cut

public java.awt.datatransfer.Transferable cut(MindMapNode node)

copy

public java.awt.datatransfer.Transferable copy(MindMapNode node)

copy

public java.awt.datatransfer.Transferable copy()

copySingle

public java.awt.datatransfer.Transferable copySingle()

copy

public java.awt.datatransfer.Transferable copy(java.util.List selectedNodes,
                                               java.lang.String inPlainText)
Parameters:
selectedNodes -
inPlainText - typically this is null. AN alternative is node.toString(); if there is only one node.
Returns:

getAsPlainText

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

getAsRTF

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

insertNodeInto

public void insertNodeInto(MindMapNode newChild,
                           MindMapNode parent,
                           int index)

getFile

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


getURL

public 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

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

Parameters:
fileout -
Throws:
java.io.IOException

getRestoreable

public 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

public java.lang.Object[] getPathToRoot(javax.swing.tree.TreeNode node)

getBackgroundColor

public java.awt.Color getBackgroundColor()

setBackgroundColor

public void setBackgroundColor(java.awt.Color color)

getLinkRegistry

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

destroy

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


isReadOnly

public boolean isReadOnly()