freemind.main
Interface FreeMindMain

All Known Implementing Classes:
FreeMind, FreeMindApplet

public interface FreeMindMain


Nested Class Summary
static class FreeMindMain.VersionInformation
           
 
Field Summary
static int VERSION_TYPE_ALPHA
           
static int VERSION_TYPE_BETA
           
static int VERSION_TYPE_RC
           
static int VERSION_TYPE_RELEASE
           
 
Method Summary
 void err(java.lang.String msg)
           
 java.lang.String getAdjustableProperty(java.lang.String label)
          Makes it possible to have a property different for different localizations.
 java.awt.Container getContentPane()
           
 Controller getController()
           
 java.lang.String getFreemindBaseDir()
           
 java.lang.ClassLoader getFreeMindClassLoader()
           
 java.lang.String getFreemindDirectory()
          Returns the path to the directory the freemind auto properties are in, or null, if not present.
 MenuBar getFreeMindMenuBar()
           
 FreeMindMain.VersionInformation getFreemindVersion()
          version info:
 int getIntProperty(java.lang.String key, int defaultValue)
           
 javax.swing.JFrame getJFrame()
           
 javax.swing.JLayeredPane getLayeredPane()
           
 java.util.logging.Logger getLogger(java.lang.String forClass)
          To obtain a logging element, ask here.
 java.io.File getPatternsFile()
           
 java.util.Properties getProperties()
           
 java.lang.String getProperty(java.lang.String key)
          Properties are stored in freemind.properties (internally) and ~/.freemind/auto.properties for user changed values.
 java.net.URL getResource(java.lang.String name)
           
 java.util.ResourceBundle getResources()
          Returns the ResourceBundle with the current language
 java.lang.String getResourceString(java.lang.String key)
           
 java.lang.String getResourceString(java.lang.String key, java.lang.String defaultResource)
           
 MapView getView()
           
 java.awt.Container getViewport()
           
 int getWinHeight()
           
 int getWinState()
           
 int getWinWidth()
           
 int getWinX()
           
 int getWinY()
           
 javax.swing.JSplitPane insertComponentIntoSplitPane(javax.swing.JComponent pMindMapComponent)
          Inserts a (south) component into the split pane.
 boolean isApplet()
           
 void openDocument(java.net.URL location)
          Open url in WWW browser.
 void out(java.lang.String msg)
           
 void removeSplitPane()
          Indicates that the south panel should be made invisible.
 void repaint()
          remove this!
 void saveProperties()
           
 void setDefaultProperty(java.lang.String key, java.lang.String value)
           
 void setProperty(java.lang.String key, java.lang.String value)
           
 void setTitle(java.lang.String title)
           
 void setView(MapView view)
           
 void setWaitingCursor(boolean waiting)
           
 

Field Detail

VERSION_TYPE_ALPHA

static final int VERSION_TYPE_ALPHA
See Also:
Constant Field Values

VERSION_TYPE_BETA

static final int VERSION_TYPE_BETA
See Also:
Constant Field Values

VERSION_TYPE_RC

static final int VERSION_TYPE_RC
See Also:
Constant Field Values

VERSION_TYPE_RELEASE

static final int VERSION_TYPE_RELEASE
See Also:
Constant Field Values
Method Detail

getJFrame

javax.swing.JFrame getJFrame()

isApplet

boolean isApplet()

getView

MapView getView()

setView

void setView(MapView view)

getController

Controller getController()

setWaitingCursor

void setWaitingCursor(boolean waiting)

getPatternsFile

java.io.File getPatternsFile()

getFreeMindMenuBar

MenuBar getFreeMindMenuBar()

getResources

java.util.ResourceBundle getResources()
Returns the ResourceBundle with the current language


getResourceString

java.lang.String getResourceString(java.lang.String key)

getResourceString

java.lang.String getResourceString(java.lang.String key,
                                   java.lang.String defaultResource)

getContentPane

java.awt.Container getContentPane()

out

void out(java.lang.String msg)

err

void err(java.lang.String msg)

openDocument

void openDocument(java.net.URL location)
                  throws java.lang.Exception
Open url in WWW browser. This method hides some differences between operating systems.

Throws:
java.lang.Exception

repaint

void repaint()
remove this!


getResource

java.net.URL getResource(java.lang.String name)

getIntProperty

int getIntProperty(java.lang.String key,
                   int defaultValue)

getProperties

java.util.Properties getProperties()
Returns:
returns the list of all properties.

getProperty

java.lang.String getProperty(java.lang.String key)
Properties are stored in freemind.properties (internally) and ~/.freemind/auto.properties for user changed values. This method returns the user value (if changed) or the original.

Parameters:
key - The property key as specified in freemind.properties
Returns:
the value of the property or null, if not found.

setProperty

void setProperty(java.lang.String key,
                 java.lang.String value)

saveProperties

void saveProperties()

getFreemindDirectory

java.lang.String getFreemindDirectory()
Returns the path to the directory the freemind auto properties are in, or null, if not present.


getLayeredPane

javax.swing.JLayeredPane getLayeredPane()

getViewport

java.awt.Container getViewport()

setTitle

void setTitle(java.lang.String title)

getWinHeight

int getWinHeight()

getWinWidth

int getWinWidth()

getWinState

int getWinState()

getWinX

int getWinX()

getWinY

int getWinY()

getFreemindVersion

FreeMindMain.VersionInformation getFreemindVersion()
version info:


getLogger

java.util.logging.Logger getLogger(java.lang.String forClass)
To obtain a logging element, ask here.


insertComponentIntoSplitPane

javax.swing.JSplitPane insertComponentIntoSplitPane(javax.swing.JComponent pMindMapComponent)
Inserts a (south) component into the split pane. If the screen isn't split yet, a split pane should be created on the fly.

Parameters:
pMindMapComponent - south panel to be inserted
Returns:
the split pane in order to move the dividers.

removeSplitPane

void removeSplitPane()
Indicates that the south panel should be made invisible.


getFreeMindClassLoader

java.lang.ClassLoader getFreeMindClassLoader()
Returns:
a ClassLoader derived from the standard, with freeminds base dir included.

getFreemindBaseDir

java.lang.String getFreemindBaseDir()
Returns:
default ".", but on different os this differs.

getAdjustableProperty

java.lang.String getAdjustableProperty(java.lang.String label)
Makes it possible to have a property different for different localizations. Common example is to put keystrokes to different keys as some are better reachable than others depending on the locale.


setDefaultProperty

void setDefaultProperty(java.lang.String key,
                        java.lang.String value)