guided tours implementation
[debian/openrocket] / src / net / sf / openrocket / gui / main / BasicFrame.java
index b6b74380506ea80044145020935da199905dc4fb..417b67e64110876932e2ea63a86dc2b01f492015 100644 (file)
@@ -6,8 +6,6 @@ import java.awt.Toolkit;
 import java.awt.Window;
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
-import java.awt.event.ComponentAdapter;
-import java.awt.event.ComponentEvent;
 import java.awt.event.KeyEvent;
 import java.awt.event.MouseAdapter;
 import java.awt.event.MouseEvent;
@@ -30,6 +28,7 @@ import java.util.List;
 import java.util.concurrent.ExecutionException;
 
 import javax.swing.Action;
+import javax.swing.BorderFactory;
 import javax.swing.InputMap;
 import javax.swing.JButton;
 import javax.swing.JComponent;
@@ -40,7 +39,9 @@ import javax.swing.JMenuBar;
 import javax.swing.JMenuItem;
 import javax.swing.JOptionPane;
 import javax.swing.JPanel;
+import javax.swing.JPopupMenu;
 import javax.swing.JScrollPane;
+import javax.swing.JSpinner;
 import javax.swing.JSplitPane;
 import javax.swing.JTabbedPane;
 import javax.swing.JTextField;
@@ -48,10 +49,10 @@ import javax.swing.KeyStroke;
 import javax.swing.ListSelectionModel;
 import javax.swing.ScrollPaneConstants;
 import javax.swing.SwingUtilities;
+import javax.swing.border.BevelBorder;
 import javax.swing.border.TitledBorder;
 import javax.swing.event.TreeSelectionEvent;
 import javax.swing.event.TreeSelectionListener;
-import javax.swing.filechooser.FileFilter;
 import javax.swing.tree.DefaultTreeSelectionModel;
 import javax.swing.tree.TreePath;
 import javax.swing.tree.TreeSelectionModel;
@@ -80,9 +81,15 @@ import net.sf.openrocket.gui.dialogs.SwingWorkerDialog;
 import net.sf.openrocket.gui.dialogs.WarningDialog;
 import net.sf.openrocket.gui.dialogs.optimization.GeneralOptimizationDialog;
 import net.sf.openrocket.gui.dialogs.preferences.PreferencesDialog;
+import net.sf.openrocket.gui.help.tours.GuidedTourSelectionDialog;
 import net.sf.openrocket.gui.main.componenttree.ComponentTree;
-import net.sf.openrocket.gui.optimization.OptimizationTestDialog;
 import net.sf.openrocket.gui.scalefigure.RocketPanel;
+import net.sf.openrocket.gui.util.FileHelper;
+import net.sf.openrocket.gui.util.GUIUtil;
+import net.sf.openrocket.gui.util.Icons;
+import net.sf.openrocket.gui.util.OpenFileWorker;
+import net.sf.openrocket.gui.util.SaveFileWorker;
+import net.sf.openrocket.gui.util.SwingPreferences;
 import net.sf.openrocket.l10n.Translator;
 import net.sf.openrocket.logging.LogHelper;
 import net.sf.openrocket.rocketcomponent.ComponentChangeEvent;
@@ -92,14 +99,9 @@ import net.sf.openrocket.rocketcomponent.RocketComponent;
 import net.sf.openrocket.rocketcomponent.Stage;
 import net.sf.openrocket.startup.Application;
 import net.sf.openrocket.util.BugException;
-import net.sf.openrocket.util.GUIUtil;
-import net.sf.openrocket.util.Icons;
 import net.sf.openrocket.util.MemoryManagement;
 import net.sf.openrocket.util.MemoryManagement.MemoryData;
-import net.sf.openrocket.util.OpenFileWorker;
-import net.sf.openrocket.util.Prefs;
 import net.sf.openrocket.util.Reflection;
-import net.sf.openrocket.util.SaveFileWorker;
 import net.sf.openrocket.util.TestRockets;
 
 public class BasicFrame extends JFrame {
@@ -114,23 +116,6 @@ public class BasicFrame extends JFrame {
        
        private static final Translator trans = Application.getTranslator();
        
-       // FileFilters for different types of rocket design files
-       private static final FileFilter ALL_DESIGNS_FILTER =
-                       //// All rocket designs (*.ork; *.rkt)
-                       new SimpleFileFilter(trans.get("BasicFrame.SimpleFileFilter1"),
-                                       ".ork", ".ork.gz", ".rkt", ".rkt.gz");
-       
-       private static final FileFilter OPENROCKET_DESIGN_FILTER =
-                       //// OpenRocket designs (*.ork)
-                       new SimpleFileFilter(trans.get("BasicFrame.SimpleFileFilter2"), ".ork", ".ork.gz");
-       
-       private static final FileFilter ROCKSIM_DESIGN_FILTER =
-                       //// RockSim designs (*.rkt)
-                       new SimpleFileFilter(trans.get("BasicFrame.SimpleFileFilter3"), ".rkt", ".rkt.gz");
-       
-
-
-
        public static final int COMPONENT_TAB = 0;
        public static final int SIMULATION_TAB = 1;
        
@@ -142,9 +127,6 @@ public class BasicFrame extends JFrame {
        private static final ArrayList<BasicFrame> frames = new ArrayList<BasicFrame>();
        
 
-
-
-
        /**
         * Whether "New" and "Open" should replace this frame.
         * Should be set to false on the first rocket modification.
@@ -250,19 +232,16 @@ public class BasicFrame extends JFrame {
                setTitle();
                this.pack();
                
-               Dimension size = Prefs.getWindowSize(this.getClass());
-               if (size == null) {
-                       size = Toolkit.getDefaultToolkit().getScreenSize();
-                       size.width = size.width * 9 / 10;
-                       size.height = size.height * 9 / 10;
-               }
+
+               // Set initial window size
+               Dimension size = Toolkit.getDefaultToolkit().getScreenSize();
+               size.width = size.width * 9 / 10;
+               size.height = size.height * 9 / 10;
                this.setSize(size);
-               this.addComponentListener(new ComponentAdapter() {
-                       @Override
-                       public void componentResized(ComponentEvent e) {
-                               Prefs.setWindowSize(BasicFrame.this.getClass(), BasicFrame.this.getSize());
-                       }
-               });
+               
+               // Remember changed size
+               GUIUtil.rememberWindowSize(this);
+               
                this.setLocationByPlatform(true);
                
                GUIUtil.setWindowIcons(this);
@@ -276,8 +255,8 @@ public class BasicFrame extends JFrame {
                                closeAction();
                        }
                });
-               frames.add(this);
                
+               frames.add(this);
                log.debug("BasicFrame instantiation complete");
        }
        
@@ -384,8 +363,8 @@ public class BasicFrame extends JFrame {
                scroll.setBorder(null);
                scroll.setViewportBorder(null);
                
-               TitledBorder border = new TitledBorder(trans.get("BasicFrame.title.Addnewcomp"));
-               border.setTitleFont(border.getTitleFont().deriveFont(Font.BOLD));
+               TitledBorder border = BorderFactory.createTitledBorder(trans.get("BasicFrame.title.Addnewcomp"));
+               GUIUtil.changeFontStyle(border, Font.BOLD);
                scroll.setBorder(border);
                
                panel.add(scroll, "grow");
@@ -612,9 +591,7 @@ public class BasicFrame extends JFrame {
 
 
                item = new JMenuItem(trans.get("main.menu.edit.resize"));
-               // FIXME: Icon
-               //item.setIcon(Icons.PREFERENCES);
-               //// Setup the application preferences
+               item.setIcon(Icons.EDIT_SCALE);
                item.getAccessibleContext().setAccessibleDescription(trans.get("main.menu.edit.resize.desc"));
                item.addActionListener(new ActionListener() {
                        @Override
@@ -638,7 +615,7 @@ public class BasicFrame extends JFrame {
                        @Override
                        public void actionPerformed(ActionEvent e) {
                                log.user("Preferences selected");
-                               PreferencesDialog.showPreferences();
+                               PreferencesDialog.showPreferences(BasicFrame.this);
                        }
                });
                menu.add(item);
@@ -667,6 +644,19 @@ public class BasicFrame extends JFrame {
                menu.add(item);
                
 
+               item = new JMenuItem(trans.get("main.menu.analyze.optimization"), KeyEvent.VK_O);
+               item.getAccessibleContext().setAccessibleDescription(trans.get("main.menu.analyze.optimization.desc"));
+               item.addActionListener(new ActionListener() {
+                       @Override
+                       public void actionPerformed(ActionEvent e) {
+                               log.user("Rocket optimization selected");
+                               new GeneralOptimizationDialog(document, BasicFrame.this).setVisible(true);
+                       }
+               });
+               menu.add(item);
+               
+
+
                ////  Debug
                // (shown if openrocket.debug.menu is defined)
                if (System.getProperty("openrocket.debug.menu") != null) {
@@ -679,14 +669,31 @@ public class BasicFrame extends JFrame {
                
                menu = new JMenu(trans.get("main.menu.help"));
                menu.setMnemonic(KeyEvent.VK_H);
-               //// Information about OpenRocket
                menu.getAccessibleContext().setAccessibleDescription(trans.get("main.menu.help.desc"));
                menubar.add(menu);
                
 
+               // Guided tours
+               
+               item = new JMenuItem(trans.get("main.menu.help.tours"), KeyEvent.VK_L);
+               // TODO: Icon
+               item.getAccessibleContext().setAccessibleDescription(trans.get("main.menu.help.tours.desc"));
+               item.addActionListener(new ActionListener() {
+                       @Override
+                       public void actionPerformed(ActionEvent e) {
+                               log.user("Guided tours selected");
+                               // FIXME:  Singleton
+                               new GuidedTourSelectionDialog(BasicFrame.this).setVisible(true);
+                       }
+               });
+               menu.add(item);
+               
+               menu.addSeparator();
+               
+
                //// License
                item = new JMenuItem(trans.get("main.menu.help.license"), KeyEvent.VK_L);
-               //// OpenRocket license information
+               item.setIcon(Icons.HELP_LICENSE);
                item.getAccessibleContext().setAccessibleDescription(trans.get("main.menu.help.license.desc"));
                item.addActionListener(new ActionListener() {
                        @Override
@@ -701,7 +708,7 @@ public class BasicFrame extends JFrame {
                
                //// Bug report
                item = new JMenuItem(trans.get("main.menu.help.bugReport"), KeyEvent.VK_B);
-               //// Information about reporting bugs in OpenRocket
+               item.setIcon(Icons.HELP_BUG_REPORT);
                item.getAccessibleContext().setAccessibleDescription(trans.get("main.menu.help.bugReport.desc"));
                item.addActionListener(new ActionListener() {
                        @Override
@@ -714,7 +721,7 @@ public class BasicFrame extends JFrame {
                
                //// Debug log
                item = new JMenuItem(trans.get("main.menu.help.debugLog"));
-               //// View the OpenRocket debug log
+               item.setIcon(Icons.HELP_DEBUG_LOG);
                item.getAccessibleContext().setAccessibleDescription(trans.get("main.menu.help.debugLog.desc"));
                item.addActionListener(new ActionListener() {
                        @Override
@@ -729,7 +736,7 @@ public class BasicFrame extends JFrame {
                
                //// About
                item = new JMenuItem(trans.get("main.menu.help.about"), KeyEvent.VK_A);
-               //// About OpenRocket
+               item.setIcon(Icons.HELP_ABOUT);
                item.getAccessibleContext().setAccessibleDescription(trans.get("main.menu.help.about.desc"));
                item.addActionListener(new ActionListener() {
                        @Override
@@ -970,25 +977,28 @@ public class BasicFrame extends JFrame {
                menu.add(item);
                
 
-               item = new JMenuItem("General optimization test");
-               item.addActionListener(new ActionListener() {
-                       @Override
-                       public void actionPerformed(ActionEvent e) {
-                               new GeneralOptimizationDialog(document, BasicFrame.this).setVisible(true);
-                       }
-               });
-               menu.add(item);
+               menu.addSeparator();
                
 
-               item = new JMenuItem("Optimization test");
+               item = new JMenuItem("Test popup");
                item.addActionListener(new ActionListener() {
                        @Override
                        public void actionPerformed(ActionEvent e) {
-                               new OptimizationTestDialog(BasicFrame.this, document).setVisible(true);
+                               log.user("Test popup selected");
+                               JPanel panel = new JPanel();
+                               panel.add(new JTextField(40));
+                               panel.add(new JSpinner());
+                               JPopupMenu popup = new JPopupMenu();
+                               popup.setBorder(BorderFactory.createBevelBorder(BevelBorder.RAISED));
+                               popup.add(panel);
+                               popup.show(BasicFrame.this, -50, 100);
                        }
                });
                menu.add(item);
                
+
+
+
                return menu;
        }
        
@@ -1007,21 +1017,21 @@ public class BasicFrame extends JFrame {
        private void openAction() {
                JFileChooser chooser = new JFileChooser();
                
-               chooser.addChoosableFileFilter(ALL_DESIGNS_FILTER);
-               chooser.addChoosableFileFilter(OPENROCKET_DESIGN_FILTER);
-               chooser.addChoosableFileFilter(ROCKSIM_DESIGN_FILTER);
-               chooser.setFileFilter(ALL_DESIGNS_FILTER);
+               chooser.addChoosableFileFilter(FileHelper.ALL_DESIGNS_FILTER);
+               chooser.addChoosableFileFilter(FileHelper.OPENROCKET_DESIGN_FILTER);
+               chooser.addChoosableFileFilter(FileHelper.ROCKSIM_DESIGN_FILTER);
+               chooser.setFileFilter(FileHelper.ALL_DESIGNS_FILTER);
                
                chooser.setFileSelectionMode(JFileChooser.FILES_ONLY);
                chooser.setMultiSelectionEnabled(true);
-               chooser.setCurrentDirectory(Prefs.getDefaultDirectory());
+               chooser.setCurrentDirectory(((SwingPreferences) Application.getPreferences()).getDefaultDirectory());
                int option = chooser.showOpenDialog(this);
                if (option != JFileChooser.APPROVE_OPTION) {
                        log.user("Decided not to open files, option=" + option);
                        return;
                }
                
-               Prefs.setDefaultDirectory(chooser.getCurrentDirectory());
+               ((SwingPreferences) Application.getPreferences()).setDefaultDirectory(chooser.getCurrentDirectory());
                
                File[] files = chooser.getSelectedFiles();
                log.user("Opening files " + Arrays.toString(files));
@@ -1032,6 +1042,10 @@ public class BasicFrame extends JFrame {
                                
                                // Close previous window if replacing
                                if (replaceable && document.isSaved()) {
+                                       // We are replacing the frame, make new window have current location
+                                       BasicFrame newFrame = frames.get(frames.size() - 1);
+                                       newFrame.setLocation(this.getLocation());
+                                       
                                        log.info("Closing window because it is replaceable");
                                        closeAction();
                                        replaceable = false;
@@ -1213,6 +1227,7 @@ public class BasicFrame extends JFrame {
                doc.setFile(file);
                doc.setSaved(true);
                
+
                // Open the frame
                log.debug("Opening new frame with the document");
                BasicFrame frame = new BasicFrame(doc);
@@ -1234,7 +1249,7 @@ public class BasicFrame extends JFrame {
                log.info("Saving document to " + file);
                
                // Saving RockSim designs is not supported
-               if (ROCKSIM_DESIGN_FILTER.accept(file)) {
+               if (FileHelper.ROCKSIM_DESIGN_FILTER.accept(file)) {
                        file = new File(file.getAbsolutePath().replaceAll(".[rR][kK][tT](.[gG][zZ])?$",
                                        ".ork"));
                        
@@ -1262,8 +1277,8 @@ public class BasicFrame extends JFrame {
                StorageOptionChooser storageChooser =
                                new StorageOptionChooser(document, document.getDefaultStorageOptions());
                JFileChooser chooser = new JFileChooser();
-               chooser.setFileFilter(OPENROCKET_DESIGN_FILTER);
-               chooser.setCurrentDirectory(Prefs.getDefaultDirectory());
+               chooser.setFileFilter(FileHelper.OPENROCKET_DESIGN_FILTER);
+               chooser.setCurrentDirectory(((SwingPreferences) Application.getPreferences()).getDefaultDirectory());
                chooser.setAccessory(storageChooser);
                if (document.getFile() != null)
                        chooser.setSelectedFile(document.getFile());
@@ -1280,25 +1295,12 @@ public class BasicFrame extends JFrame {
                        return false;
                }
                
-               Prefs.setDefaultDirectory(chooser.getCurrentDirectory());
+               ((SwingPreferences) Application.getPreferences()).setDefaultDirectory(chooser.getCurrentDirectory());
                storageChooser.storeOptions(document.getDefaultStorageOptions());
                
-               if (file.getName().indexOf('.') < 0) {
-                       log.debug("File name does not contain extension, adding .ork");
-                       String name = file.getAbsolutePath();
-                       name = name + ".ork";
-                       file = new File(name);
-               }
-               
-               if (file.exists()) {
-                       log.info("File " + file + " exists, confirming overwrite from user");
-                       int result = JOptionPane.showConfirmDialog(this,
-                                       "File '" + file.getName() + "' exists.  Do you want to overwrite it?",
-                                       "File exists", JOptionPane.YES_NO_OPTION, JOptionPane.QUESTION_MESSAGE);
-                       if (result != JOptionPane.YES_OPTION) {
-                               log.user("User decided not to overwrite the file");
-                               return false;
-                       }
+               file = FileHelper.ensureExtension(file, "ork");
+               if (!FileHelper.confirmWrite(file, this)) {
+                       return false;
                }
                
                return saveAs(file);
@@ -1402,13 +1404,6 @@ public class BasicFrame extends JFrame {
         * 
         */
        public void printAction() {
-               if (!Prefs.getBoolean("printing.experimental.communicated", false)) {
-                       log.info("Showing printing is experimental warning to the user");
-                       JOptionPane.showMessageDialog(this, "Printing is an currently an experimental feature " +
-                                       "and might not fully work on all platforms",
-                                       "Experimental feature", JOptionPane.WARNING_MESSAGE);
-                       Prefs.putBoolean("printing.experimental.communicated", true);
-               }
                new PrintDialog(this, document).setVisible(true);
        }