/*FreeMind - A Program for creating and viewing Mindmaps
*Copyright (C) 2000-2001 Joerg Mueller <joergmueller@bigfoot.com>
*See COPYING for Details
*
*This program is free software; you can redistribute it and/or
*modify it under the terms of the GNU General Public License
*as published by the Free Software Foundation; either version 2
*of the License, or (at your option) any later version.
*
*This program is distributed in the hope that it will be useful,
*but WITHOUT ANY WARRANTY; without even the implied warranty of
*MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
*GNU General Public License for more details.
*
*You should have received a copy of the GNU General Public License
*along with this program; if not, write to the Free Software
*Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
/*$Id: FreeMindMain.java,v 1.12.14.5.2.12 2008/07/17 19:16:33 christianfoltin Exp $*/
package freemind.main;
import java.awt.Container;
import java.io.File;
import java.net.URL;
import java.util.List;
import java.util.Properties;
import java.util.ResourceBundle;
import java.util.StringTokenizer;
import java.util.Vector;
import javax.swing.JComponent;
import javax.swing.JFrame;
import javax.swing.JLayeredPane;
import javax.swing.JScrollPane;
import javax.swing.JSplitPane;
import freemind.controller.Controller;
import freemind.controller.MenuBar;
import freemind.view.mindmapview.MapView;
public interface FreeMindMain {
public interface StartupDoneListener {
void startupDone();
}
public JFrame getJFrame();
public boolean isApplet();
public MapView getView();
public void setView(MapView view);
public Controller getController();
public void setWaitingCursor(boolean waiting);
public File getPatternsFile();
public MenuBar getFreeMindMenuBar();
/** Returns the ResourceBundle with the current language */
public ResourceBundle getResources();
public String getResourceString(String key);
public String getResourceString(String key, String defaultResource);
public Container getContentPane();
public void out(String msg);
public void err(String msg);
/**
* Open url in WWW browser. This method hides some differences between
* operating systems.
*/
public void openDocument(URL location) throws Exception;
/** remove this! */
public void repaint();
public URL getResource(String name);
public int getIntProperty(String key, int defaultValue);
/** @return returns the list of all properties. */
public Properties getProperties();
/**
* 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.
*
* @param key
* The property key as specified in freemind.properties
* @return the value of the property or null, if not found.
*/
public String getProperty(String key);
public void setProperty(String key, String value);
public void saveProperties(boolean pIsShutdown);
/**
* Returns the path to the directory the freemind auto properties are in, or
* null, if not present.
*/
public String getFreemindDirectory();
public JLayeredPane getLayeredPane();
public void setTitle(String title);
// to keep last win size (PN)
public int getWinHeight();
public int getWinWidth();
public int getWinState();
public int getWinX();
public int getWinY();
public static final int VERSION_TYPE_ALPHA = 0;
public static final int VERSION_TYPE_BETA = 1;
public static final int VERSION_TYPE_RC = 2;
public static final int VERSION_TYPE_RELEASE = 3;
public static final String ENABLE_NODE_MOVEMENT = "enable_node_movement";
public static class VersionInformation {
public int mMaj = 0;
public int mMid = 9;
public int mMin = 0;
public int mType = VERSION_TYPE_BETA;
public int mNum = 17;
public VersionInformation(int pMaj, int pMid, int pMin, int pType,
int pNum) {
super();
mMaj = pMaj;
mMid = pMid;
mMin = pMin;
mType = pType;
mNum = pNum;
}
/**
* Sets the version number from a string.
*
* @param pString
* : The version number coding. Example "0.9.0 Beta 1"
* Keywords are "Alpha", "Beta", "RC". Separation by " " or
* by ".".
*/
public VersionInformation(String pString) {
StringTokenizer t = new StringTokenizer(pString, ". ", false);
String[] info = new String[t.countTokens()];
int i = 0;
while (t.hasMoreTokens()) {
info[i++] = t.nextToken();
}
if (info.length != 3 && info.length != 5)
throw new IllegalArgumentException(
"Wrong number of tokens for version information: "
+ pString);
mMaj = Integer.parseInt(info[0]);
mMid = Integer.parseInt(info[1]);
mMin = Integer.parseInt(info[2]);
if (info.length == 3) {
// release.
mType = VERSION_TYPE_RELEASE;
mNum = 0;
return;
}
// here,we have info.length == 5!
Vector types = new Vector();
types.add("Alpha");
types.add("Beta");
types.add("RC");
int typeIndex = types.indexOf(info[3]);
if (typeIndex < 0) {
throw new IllegalArgumentException(
"Wrong version type for version information: "
+ info[4]);
}
mType = typeIndex;
mNum = Integer.parseInt(info[4]);
}
public String toString() {
StringBuffer buf = new StringBuffer();
buf.append(mMaj);
buf.append('.');
buf.append(mMid);
buf.append('.');
buf.append(mMin);
switch (mType) {
case VERSION_TYPE_ALPHA:
buf.append(' ');
buf.append("Alpha");
break;
case VERSION_TYPE_BETA:
buf.append(' ');
buf.append("Beta");
break;
case VERSION_TYPE_RC:
buf.append(' ');
buf.append("RC");
break;
case VERSION_TYPE_RELEASE:
break;
default:
throw new IllegalArgumentException("Unknown version type "
+ mType);
}
if (mType != VERSION_TYPE_RELEASE) {
buf.append(' ');
buf.append(mNum);
}
return buf.toString();
}
}
/** version info: */
public VersionInformation getFreemindVersion();
/** To obtain a logging element, ask here. */
public java.util.logging.Logger getLogger(String forClass);
/**
* Inserts a (south) component into the split pane. If the screen isn't
* split yet, a split pane should be created on the fly.
*
* @param pMindMapComponent
* south panel to be inserted
* @return the split pane in order to move the dividers.
*/
public JSplitPane insertComponentIntoSplitPane(JComponent pMindMapComponent);
/**
* Indicates that the south panel should be made invisible.
*/
public void removeSplitPane();
/**
* @return a ClassLoader derived from the standard, with freeminds base dir
* included.
*/
public ClassLoader getFreeMindClassLoader();
/**
* @return default ".", but on different os this differs.
*/
String getFreemindBaseDir();
/**
* 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.
*/
public String getAdjustableProperty(String label);
public void setDefaultProperty(String key, String value);
public abstract JComponent getContentComponent();
public abstract JScrollPane getScrollPane();
public abstract void registerStartupDoneListener(
StartupDoneListener pStartupDoneListener);
/**
* @return a list of all loggers. Used for example for the log file viewer.
*/
public List getLoggerList();
}