1 package net.sf.openrocket.gui.main;
3 import java.awt.Dimension;
5 import java.awt.Toolkit;
6 import java.awt.Window;
7 import java.awt.event.ActionEvent;
8 import java.awt.event.ActionListener;
9 import java.awt.event.ComponentAdapter;
10 import java.awt.event.ComponentEvent;
11 import java.awt.event.KeyEvent;
12 import java.awt.event.MouseAdapter;
13 import java.awt.event.MouseEvent;
14 import java.awt.event.MouseListener;
15 import java.awt.event.WindowAdapter;
16 import java.awt.event.WindowEvent;
18 import java.io.FileNotFoundException;
19 import java.io.IOException;
20 import java.io.InputStream;
21 import java.io.UnsupportedEncodingException;
23 import java.net.URISyntaxException;
25 import java.net.URLDecoder;
26 import java.util.ArrayList;
27 import java.util.Arrays;
28 import java.util.LinkedList;
29 import java.util.List;
30 import java.util.concurrent.ExecutionException;
32 import javax.swing.Action;
33 import javax.swing.InputMap;
34 import javax.swing.JButton;
35 import javax.swing.JComponent;
36 import javax.swing.JFileChooser;
37 import javax.swing.JFrame;
38 import javax.swing.JMenu;
39 import javax.swing.JMenuBar;
40 import javax.swing.JMenuItem;
41 import javax.swing.JOptionPane;
42 import javax.swing.JPanel;
43 import javax.swing.JScrollPane;
44 import javax.swing.JSplitPane;
45 import javax.swing.JTabbedPane;
46 import javax.swing.JTextField;
47 import javax.swing.KeyStroke;
48 import javax.swing.ListSelectionModel;
49 import javax.swing.ScrollPaneConstants;
50 import javax.swing.SwingUtilities;
51 import javax.swing.border.TitledBorder;
52 import javax.swing.event.TreeSelectionEvent;
53 import javax.swing.event.TreeSelectionListener;
54 import javax.swing.filechooser.FileFilter;
55 import javax.swing.tree.DefaultTreeSelectionModel;
56 import javax.swing.tree.TreePath;
57 import javax.swing.tree.TreeSelectionModel;
59 import net.miginfocom.swing.MigLayout;
60 import net.sf.openrocket.aerodynamics.WarningSet;
61 import net.sf.openrocket.document.OpenRocketDocument;
62 import net.sf.openrocket.file.GeneralRocketLoader;
63 import net.sf.openrocket.file.RocketLoadException;
64 import net.sf.openrocket.file.RocketLoader;
65 import net.sf.openrocket.file.RocketSaver;
66 import net.sf.openrocket.file.openrocket.OpenRocketSaver;
67 import net.sf.openrocket.gui.StorageOptionChooser;
68 import net.sf.openrocket.gui.configdialog.ComponentConfigDialog;
69 import net.sf.openrocket.gui.dialogs.AboutDialog;
70 import net.sf.openrocket.gui.dialogs.BugReportDialog;
71 import net.sf.openrocket.gui.dialogs.ComponentAnalysisDialog;
72 import net.sf.openrocket.gui.dialogs.DebugLogDialog;
73 import net.sf.openrocket.gui.dialogs.DetailDialog;
74 import net.sf.openrocket.gui.dialogs.ExampleDesignDialog;
75 import net.sf.openrocket.gui.dialogs.LicenseDialog;
76 import net.sf.openrocket.gui.dialogs.MotorDatabaseLoadingDialog;
77 import net.sf.openrocket.gui.dialogs.PrintDialog;
78 import net.sf.openrocket.gui.dialogs.SwingWorkerDialog;
79 import net.sf.openrocket.gui.dialogs.WarningDialog;
80 import net.sf.openrocket.gui.dialogs.preferences.PreferencesDialog;
81 import net.sf.openrocket.gui.main.componenttree.ComponentTree;
82 import net.sf.openrocket.gui.scalefigure.RocketPanel;
83 import net.sf.openrocket.l10n.Translator;
84 import net.sf.openrocket.logging.LogHelper;
85 import net.sf.openrocket.rocketcomponent.ComponentChangeEvent;
86 import net.sf.openrocket.rocketcomponent.ComponentChangeListener;
87 import net.sf.openrocket.rocketcomponent.Rocket;
88 import net.sf.openrocket.rocketcomponent.RocketComponent;
89 import net.sf.openrocket.rocketcomponent.Stage;
90 import net.sf.openrocket.startup.Application;
91 import net.sf.openrocket.util.BugException;
92 import net.sf.openrocket.util.GUIUtil;
93 import net.sf.openrocket.util.Icons;
94 import net.sf.openrocket.util.MemoryManagement;
95 import net.sf.openrocket.util.MemoryManagement.MemoryData;
96 import net.sf.openrocket.util.OpenFileWorker;
97 import net.sf.openrocket.util.Prefs;
98 import net.sf.openrocket.util.Reflection;
99 import net.sf.openrocket.util.SaveFileWorker;
100 import net.sf.openrocket.util.TestRockets;
102 public class BasicFrame extends JFrame {
103 private static final LogHelper log = Application.getLogger();
106 * The RocketLoader instance used for loading all rocket designs.
108 private static final RocketLoader ROCKET_LOADER = new GeneralRocketLoader();
110 private static final RocketSaver ROCKET_SAVER = new OpenRocketSaver();
112 private static final Translator trans = Application.getTranslator();
114 // FileFilters for different types of rocket design files
115 private static final FileFilter ALL_DESIGNS_FILTER =
116 //// All rocket designs (*.ork; *.rkt)
117 new SimpleFileFilter(trans.get("BasicFrame.SimpleFileFilter1"),
118 ".ork", ".ork.gz", ".rkt", ".rkt.gz");
120 private static final FileFilter OPENROCKET_DESIGN_FILTER =
121 //// OpenRocket designs (*.ork)
122 new SimpleFileFilter(trans.get("BasicFrame.SimpleFileFilter2"), ".ork", ".ork.gz");
124 private static final FileFilter ROCKSIM_DESIGN_FILTER =
125 //// RockSim designs (*.rkt)
126 new SimpleFileFilter(trans.get("BasicFrame.SimpleFileFilter3"), ".rkt", ".rkt.gz");
131 public static final int COMPONENT_TAB = 0;
132 public static final int SIMULATION_TAB = 1;
136 * List of currently open frames. When the list goes empty
137 * it is time to exit the application.
139 private static final ArrayList<BasicFrame> frames = new ArrayList<BasicFrame>();
146 * Whether "New" and "Open" should replace this frame.
147 * Should be set to false on the first rocket modification.
149 private boolean replaceable = false;
153 private final OpenRocketDocument document;
154 private final Rocket rocket;
156 private JTabbedPane tabbedPane;
157 private RocketPanel rocketpanel;
158 private ComponentTree tree = null;
160 private final DocumentSelectionModel selectionModel;
161 private final TreeSelectionModel componentSelectionModel;
162 private final ListSelectionModel simulationSelectionModel;
164 /** Actions available for rocket modifications */
165 private final RocketActions actions;
170 * Sole constructor. Creates a new frame based on the supplied document
171 * and adds it to the current frames list.
173 * @param document the document to show.
175 public BasicFrame(OpenRocketDocument document) {
176 log.debug("Instantiating new BasicFrame");
178 this.document = document;
179 this.rocket = document.getRocket();
180 this.rocket.getDefaultConfiguration().setAllStages();
183 // Set replaceable flag to false at first modification
184 rocket.addComponentChangeListener(new ComponentChangeListener() {
186 public void componentChanged(ComponentChangeEvent e) {
188 BasicFrame.this.rocket.removeComponentChangeListener(this);
193 // Create the component tree selection model that will be used
194 componentSelectionModel = new DefaultTreeSelectionModel();
195 componentSelectionModel.setSelectionMode(TreeSelectionModel.SINGLE_TREE_SELECTION);
197 // Obtain the simulation selection model that will be used
198 SimulationPanel simulationPanel = new SimulationPanel(document);
199 simulationSelectionModel = simulationPanel.getSimulationListSelectionModel();
201 // Combine into a DocumentSelectionModel
202 selectionModel = new DocumentSelectionModel(document);
203 selectionModel.attachComponentTreeSelectionModel(componentSelectionModel);
204 selectionModel.attachSimulationListSelectionModel(simulationSelectionModel);
207 actions = new RocketActions(document, selectionModel, this);
210 log.debug("Constructing the BasicFrame UI");
212 // The main vertical split pane
213 JSplitPane vertical = new JSplitPane(JSplitPane.VERTICAL_SPLIT, true);
214 vertical.setResizeWeight(0.5);
218 // The top tabbed pane
219 tabbedPane = new JTabbedPane();
221 tabbedPane.addTab(trans.get("BasicFrame.tab.Rocketdesign"), null, designTab());
222 //// Flight simulations
223 tabbedPane.addTab(trans.get("BasicFrame.tab.Flightsim"), null, simulationPanel);
225 vertical.setTopComponent(tabbedPane);
229 // Bottom segment, rocket figure
231 rocketpanel = new RocketPanel(document);
232 vertical.setBottomComponent(rocketpanel);
234 rocketpanel.setSelectionModel(tree.getSelectionModel());
240 rocket.addComponentChangeListener(new ComponentChangeListener() {
242 public void componentChanged(ComponentChangeEvent e) {
250 Dimension size = Prefs.getWindowSize(this.getClass());
252 size = Toolkit.getDefaultToolkit().getScreenSize();
253 size.width = size.width * 9 / 10;
254 size.height = size.height * 9 / 10;
257 this.addComponentListener(new ComponentAdapter() {
259 public void componentResized(ComponentEvent e) {
260 Prefs.setWindowSize(BasicFrame.this.getClass(), BasicFrame.this.getSize());
263 this.setLocationByPlatform(true);
265 GUIUtil.setWindowIcons(this);
268 vertical.setDividerLocation(0.4);
269 setDefaultCloseOperation(JFrame.DO_NOTHING_ON_CLOSE);
270 addWindowListener(new WindowAdapter() {
272 public void windowClosing(WindowEvent e) {
278 log.debug("BasicFrame instantiation complete");
283 * Construct the "Rocket design" tab. This contains a horizontal split pane
284 * with the left component the design tree and the right component buttons
285 * for adding components.
287 private JComponent designTab() {
288 JSplitPane horizontal = new JSplitPane(JSplitPane.HORIZONTAL_SPLIT, true);
289 horizontal.setResizeWeight(0.5);
292 // Upper-left segment, component tree
294 JPanel panel = new JPanel(new MigLayout("fill, flowy", "", "[grow]"));
296 tree = new ComponentTree(document);
297 tree.setSelectionModel(componentSelectionModel);
299 // Remove JTree key events that interfere with menu accelerators
300 InputMap im = SwingUtilities.getUIInputMap(tree, JComponent.WHEN_FOCUSED);
301 im.put(KeyStroke.getKeyStroke(KeyEvent.VK_X, ActionEvent.CTRL_MASK), null);
302 im.put(KeyStroke.getKeyStroke(KeyEvent.VK_C, ActionEvent.CTRL_MASK), null);
303 im.put(KeyStroke.getKeyStroke(KeyEvent.VK_V, ActionEvent.CTRL_MASK), null);
304 im.put(KeyStroke.getKeyStroke(KeyEvent.VK_A, ActionEvent.CTRL_MASK), null);
305 im.put(KeyStroke.getKeyStroke(KeyEvent.VK_S, ActionEvent.CTRL_MASK), null);
306 im.put(KeyStroke.getKeyStroke(KeyEvent.VK_O, ActionEvent.CTRL_MASK), null);
307 im.put(KeyStroke.getKeyStroke(KeyEvent.VK_N, ActionEvent.CTRL_MASK), null);
311 // Double-click opens config dialog
312 MouseListener ml = new MouseAdapter() {
314 public void mousePressed(MouseEvent e) {
315 int selRow = tree.getRowForLocation(e.getX(), e.getY());
316 TreePath selPath = tree.getPathForLocation(e.getX(), e.getY());
318 if ((e.getClickCount() == 2) && !ComponentConfigDialog.isDialogVisible()) {
320 RocketComponent c = (RocketComponent) selPath.getLastPathComponent();
321 ComponentConfigDialog.showDialog(BasicFrame.this,
322 BasicFrame.this.document, c);
327 tree.addMouseListener(ml);
329 // Update dialog when selection is changed
330 componentSelectionModel.addTreeSelectionListener(new TreeSelectionListener() {
332 public void valueChanged(TreeSelectionEvent e) {
333 // Scroll tree to the selected item
334 TreePath path = componentSelectionModel.getSelectionPath();
337 tree.scrollPathToVisible(path);
339 if (!ComponentConfigDialog.isDialogVisible())
341 RocketComponent c = (RocketComponent) path.getLastPathComponent();
342 ComponentConfigDialog.showDialog(BasicFrame.this,
343 BasicFrame.this.document, c);
347 // Place tree inside scroll pane
348 JScrollPane scroll = new JScrollPane(tree);
349 panel.add(scroll, "spany, grow, wrap");
353 JButton button = new JButton(actions.getMoveUpAction());
354 panel.add(button, "sizegroup buttons, aligny 65%");
356 button = new JButton(actions.getMoveDownAction());
357 panel.add(button, "sizegroup buttons, aligny 0%");
359 button = new JButton(actions.getEditAction());
360 panel.add(button, "sizegroup buttons");
362 button = new JButton(actions.getNewStageAction());
363 panel.add(button, "sizegroup buttons");
365 button = new JButton(actions.getDeleteAction());
366 button.setIcon(null);
367 button.setMnemonic(0);
368 panel.add(button, "sizegroup buttons");
370 horizontal.setLeftComponent(panel);
373 // Upper-right segment, component addition buttons
375 panel = new JPanel(new MigLayout("fill, insets 0", "[0::]"));
377 scroll = new JScrollPane(ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED,
378 ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER);
379 scroll.setViewportView(new ComponentAddButtons(document, componentSelectionModel,
380 scroll.getViewport()));
381 scroll.setBorder(null);
382 scroll.setViewportBorder(null);
384 TitledBorder border = new TitledBorder(trans.get("BasicFrame.title.Addnewcomp"));
385 border.setTitleFont(border.getTitleFont().deriveFont(Font.BOLD));
386 scroll.setBorder(border);
388 panel.add(scroll, "grow");
390 horizontal.setRightComponent(panel);
398 * Creates the menu for the window.
400 private void createMenu() {
401 JMenuBar menubar = new JMenuBar();
406 menu = new JMenu(trans.get("main.menu.file"));
407 menu.setMnemonic(KeyEvent.VK_F);
408 //// File-handling related tasks
409 menu.getAccessibleContext().setAccessibleDescription("File-handling related tasks");
413 item = new JMenuItem(trans.get("main.menu.file.new"), KeyEvent.VK_N);
414 item.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_N, ActionEvent.CTRL_MASK));
415 item.setMnemonic(KeyEvent.VK_N);
416 //// Create a new rocket design
417 item.getAccessibleContext().setAccessibleDescription("Create a new rocket design");
418 item.setIcon(Icons.FILE_NEW);
419 item.addActionListener(new ActionListener() {
421 public void actionPerformed(ActionEvent e) {
422 log.user("New... selected");
425 log.info("Closing previous window");
433 item = new JMenuItem(trans.get("main.menu.file.open"), KeyEvent.VK_O);
434 item.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_O, ActionEvent.CTRL_MASK));
435 //// Open a rocket design
436 item.getAccessibleContext().setAccessibleDescription(trans.get("BasicFrame.item.Openrocketdesign"));
437 item.setIcon(Icons.FILE_OPEN);
438 item.addActionListener(new ActionListener() {
440 public void actionPerformed(ActionEvent e) {
441 log.user("Open... selected");
448 item = new JMenuItem(trans.get("main.menu.file.openExample"));
449 //// Open an example rocket design
450 item.getAccessibleContext().setAccessibleDescription(trans.get("BasicFrame.item.Openexamplerocketdesign"));
451 item.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_O,
452 ActionEvent.CTRL_MASK | ActionEvent.SHIFT_MASK));
453 item.setIcon(Icons.FILE_OPEN_EXAMPLE);
454 item.addActionListener(new ActionListener() {
456 public void actionPerformed(ActionEvent e) {
457 log.user("Open example... selected");
458 URL[] urls = ExampleDesignDialog.selectExampleDesigns(BasicFrame.this);
461 log.user("Opening example " + u);
462 open(u, BasicFrame.this);
472 item = new JMenuItem(trans.get("main.menu.file.save"), KeyEvent.VK_S);
473 item.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_S, ActionEvent.CTRL_MASK));
474 //// Save the current rocket design
475 item.getAccessibleContext().setAccessibleDescription(trans.get("BasicFrame.item.SavecurRocketdesign"));
476 item.setIcon(Icons.FILE_SAVE);
477 item.addActionListener(new ActionListener() {
479 public void actionPerformed(ActionEvent e) {
480 log.user("Save selected");
487 item = new JMenuItem(trans.get("main.menu.file.saveAs"), KeyEvent.VK_A);
488 item.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_S,
489 ActionEvent.CTRL_MASK | ActionEvent.SHIFT_MASK));
490 //// Save the current rocket design to a new file
491 item.getAccessibleContext().setAccessibleDescription(trans.get("BasicFrame.item.SavecurRocketdesnewfile"));
492 item.setIcon(Icons.FILE_SAVE_AS);
493 item.addActionListener(new ActionListener() {
495 public void actionPerformed(ActionEvent e) {
496 log.user("Save as... selected");
503 item = new JMenuItem(trans.get("main.menu.file.print"), KeyEvent.VK_P);
504 item.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_P, ActionEvent.CTRL_MASK));
505 //// Print parts list and fin template
506 item.getAccessibleContext().setAccessibleDescription(trans.get("BasicFrame.item.Printpart"));
507 item.setIcon(Icons.FILE_PRINT);
508 item.addActionListener(new ActionListener() {
510 public void actionPerformed(ActionEvent e) {
511 log.user("Print action selected");
521 item = new JMenuItem(trans.get("main.menu.file.close"), KeyEvent.VK_C);
522 item.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_W, ActionEvent.CTRL_MASK));
523 //// Close the current rocket design
524 item.getAccessibleContext().setAccessibleDescription(trans.get("BasicFrame.item.Closedesign"));
525 item.setIcon(Icons.FILE_CLOSE);
526 item.addActionListener(new ActionListener() {
528 public void actionPerformed(ActionEvent e) {
529 log.user("Close selected");
538 item = new JMenuItem(trans.get("main.menu.file.quit"), KeyEvent.VK_Q);
539 item.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_Q, ActionEvent.CTRL_MASK));
540 //// Quit the program
541 item.getAccessibleContext().setAccessibleDescription(trans.get("BasicFrame.item.Quitprogram"));
542 item.setIcon(Icons.FILE_QUIT);
543 item.addActionListener(new ActionListener() {
545 public void actionPerformed(ActionEvent e) {
546 log.user("Quit selected");
555 menu = new JMenu(trans.get("main.menu.edit"));
556 menu.setMnemonic(KeyEvent.VK_E);
558 menu.getAccessibleContext().setAccessibleDescription(trans.get("BasicFrame.menu.Rocketedt"));
562 Action action = document.getUndoAction();
563 item = new JMenuItem(action);
564 item.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_Z, ActionEvent.CTRL_MASK));
565 item.setMnemonic(KeyEvent.VK_U);
566 //// Undo the previous operation
567 item.getAccessibleContext().setAccessibleDescription("Undo the previous operation");
571 action = document.getRedoAction();
572 item = new JMenuItem(action);
573 item.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_Y, ActionEvent.CTRL_MASK));
574 item.setMnemonic(KeyEvent.VK_R);
575 //// Redo the previously undone operation
576 item.getAccessibleContext().setAccessibleDescription("Redo the previously undone " +
583 item = new JMenuItem(actions.getCutAction());
586 item = new JMenuItem(actions.getCopyAction());
589 item = new JMenuItem(actions.getPasteAction());
592 item = new JMenuItem(actions.getDeleteAction());
598 item = new JMenuItem(trans.get("main.menu.edit.preferences"));
599 item.setIcon(Icons.PREFERENCES);
600 //// Setup the application preferences
601 item.getAccessibleContext().setAccessibleDescription("Setup the application " +
603 item.addActionListener(new ActionListener() {
605 public void actionPerformed(ActionEvent e) {
606 log.user("Preferences selected");
607 PreferencesDialog.showPreferences();
616 menu = new JMenu(trans.get("main.menu.analyze"));
617 menu.setMnemonic(KeyEvent.VK_A);
618 //// Analyzing the rocket
619 menu.getAccessibleContext().setAccessibleDescription("Analyzing the rocket");
622 //// Component analysis
623 item = new JMenuItem(trans.get("main.menu.analyze.componentAnalysis"), KeyEvent.VK_C);
624 //// Analyze the rocket components separately
625 item.getAccessibleContext().setAccessibleDescription("Analyze the rocket components " +
627 item.addActionListener(new ActionListener() {
629 public void actionPerformed(ActionEvent e) {
630 log.user("Component analysis selected");
631 ComponentAnalysisDialog.showDialog(rocketpanel);
638 // (shown if openrocket.debug.menu is defined)
639 if (System.getProperty("openrocket.debug.menu") != null) {
640 menubar.add(makeDebugMenu());
647 menu = new JMenu(trans.get("main.menu.help"));
648 menu.setMnemonic(KeyEvent.VK_H);
649 //// Information about OpenRocket
650 menu.getAccessibleContext().setAccessibleDescription("Information about OpenRocket");
655 item = new JMenuItem(trans.get("main.menu.help.license"), KeyEvent.VK_L);
656 //// OpenRocket license information
657 item.getAccessibleContext().setAccessibleDescription("OpenRocket license information");
658 item.addActionListener(new ActionListener() {
660 public void actionPerformed(ActionEvent e) {
661 log.user("License selected");
662 new LicenseDialog(BasicFrame.this).setVisible(true);
670 item = new JMenuItem(trans.get("main.menu.help.bugReport"), KeyEvent.VK_B);
671 //// Information about reporting bugs in OpenRocket
672 item.getAccessibleContext().setAccessibleDescription("Information about reporting " +
673 "bugs in OpenRocket");
674 item.addActionListener(new ActionListener() {
676 public void actionPerformed(ActionEvent e) {
677 log.user("Bug report selected");
678 BugReportDialog.showBugReportDialog(BasicFrame.this);
684 item = new JMenuItem(trans.get("main.menu.help.debugLog"));
685 //// View the OpenRocket debug log
686 item.getAccessibleContext().setAccessibleDescription("View the OpenRocket debug log");
687 item.addActionListener(new ActionListener() {
689 public void actionPerformed(ActionEvent e) {
690 log.user("Debug log selected");
691 new DebugLogDialog(BasicFrame.this).setVisible(true);
699 item = new JMenuItem(trans.get("main.menu.help.about"), KeyEvent.VK_A);
700 //// About OpenRocket
701 item.getAccessibleContext().setAccessibleDescription("About OpenRocket");
702 item.addActionListener(new ActionListener() {
704 public void actionPerformed(ActionEvent e) {
705 log.user("About selected");
706 new AboutDialog(BasicFrame.this).setVisible(true);
712 this.setJMenuBar(menubar);
716 private JMenu makeDebugMenu() {
721 menu = new JMenu("Debug");
722 //// OpenRocket debugging tasks
723 menu.getAccessibleContext().setAccessibleDescription("OpenRocket debugging tasks");
725 //// What is this menu?
726 item = new JMenuItem("What is this menu?");
727 item.addActionListener(new ActionListener() {
729 public void actionPerformed(ActionEvent e) {
730 log.user("What is this menu? selected");
731 JOptionPane.showMessageDialog(BasicFrame.this,
733 "The 'Debug' menu includes actions for testing and debugging " +
735 "The menu is made visible by defining the system property " +
736 "'openrocket.debug.menu' when starting OpenRocket.",
737 "It should not be visible by default." },
738 "Debug menu", JOptionPane.INFORMATION_MESSAGE);
745 //// Create test rocket
746 item = new JMenuItem("Create test rocket");
747 item.addActionListener(new ActionListener() {
749 public void actionPerformed(ActionEvent e) {
750 log.user("Create test rocket selected");
751 JTextField field = new JTextField();
752 int sel = JOptionPane.showOptionDialog(BasicFrame.this, new Object[] {
753 "Input text key to generate random rocket:",
755 }, "Generate random test rocket", JOptionPane.DEFAULT_OPTION,
756 JOptionPane.QUESTION_MESSAGE, null, new Object[] {
762 r = new TestRockets(null).makeTestRocket();
763 } else if (sel == 1) {
764 r = new TestRockets(field.getText()).makeTestRocket();
769 OpenRocketDocument doc = new OpenRocketDocument(r);
771 BasicFrame frame = new BasicFrame(doc);
772 frame.setVisible(true);
779 item = new JMenuItem("Create 'Iso-Haisu'");
780 item.addActionListener(new ActionListener() {
782 public void actionPerformed(ActionEvent e) {
783 log.user("Create Iso-Haisu selected");
784 Rocket r = TestRockets.makeIsoHaisu();
785 OpenRocketDocument doc = new OpenRocketDocument(r);
787 BasicFrame frame = new BasicFrame(doc);
788 frame.setVisible(true);
794 item = new JMenuItem("Create 'Big Blue'");
795 item.addActionListener(new ActionListener() {
797 public void actionPerformed(ActionEvent e) {
798 log.user("Create Big Blue selected");
799 Rocket r = TestRockets.makeBigBlue();
800 OpenRocketDocument doc = new OpenRocketDocument(r);
802 BasicFrame frame = new BasicFrame(doc);
803 frame.setVisible(true);
811 item = new JMenuItem("Memory statistics");
812 item.addActionListener(new ActionListener() {
814 public void actionPerformed(ActionEvent e) {
815 log.user("Memory statistics selected");
817 // Get discarded but remaining objects (this also runs System.gc multiple times)
818 List<MemoryData> objects = MemoryManagement.getRemainingCollectableObjects();
819 StringBuilder sb = new StringBuilder();
820 sb.append("Objects that should have been garbage-collected but have not been:\n");
822 for (MemoryData data : objects) {
823 Object o = data.getReference().get();
826 sb.append("Age ").append(System.currentTimeMillis() - data.getRegistrationTime())
827 .append(" ms: ").append(o).append('\n');
829 // Explicitly null the strong reference to avoid possibility of invisible references
832 sb.append("Total: " + count);
834 // Get basic memory stats
836 long max = Runtime.getRuntime().maxMemory();
837 long free = Runtime.getRuntime().freeMemory();
838 long used = max - free;
839 String[] stats = new String[4];
840 stats[0] = "Memory usage:";
841 stats[1] = String.format(" Max memory: %.1f MB", max / 1024.0 / 1024.0);
842 stats[2] = String.format(" Used memory: %.1f MB (%.0f%%)", used / 1024.0 / 1024.0, 100.0 * used / max);
843 stats[3] = String.format(" Free memory: %.1f MB (%.0f%%)", free / 1024.0 / 1024.0, 100.0 * free / max);
846 DetailDialog.showDetailedMessageDialog(BasicFrame.this, stats, sb.toString(),
847 "Memory statistics", JOptionPane.INFORMATION_MESSAGE);
853 item = new JMenuItem("Exhaust memory");
854 item.addActionListener(new ActionListener() {
856 public void actionPerformed(ActionEvent e) {
857 log.user("Exhaust memory selected");
858 LinkedList<byte[]> data = new LinkedList<byte[]>();
860 final int bytesPerArray = 10240;
863 byte[] array = new byte[bytesPerArray];
864 for (int i = 0; i < bytesPerArray; i++) {
870 } catch (OutOfMemoryError error) {
872 long size = bytesPerArray * (long) count;
873 String s = String.format("OutOfMemory occurred after %d iterations (approx. %.1f MB consumed)",
874 count, size / 1024.0 / 1024.0);
876 JOptionPane.showMessageDialog(BasicFrame.this, s);
886 item = new JMenuItem("Exception here");
887 item.addActionListener(new ActionListener() {
889 public void actionPerformed(ActionEvent e) {
890 log.user("Exception here selected");
891 throw new RuntimeException("Testing exception from menu action listener");
896 item = new JMenuItem("Exception from EDT");
897 item.addActionListener(new ActionListener() {
899 public void actionPerformed(ActionEvent e) {
900 log.user("Exception from EDT selected");
901 SwingUtilities.invokeLater(new Runnable() {
904 throw new RuntimeException("Testing exception from " +
905 "later invoked EDT thread");
912 item = new JMenuItem("Exception from other thread");
913 item.addActionListener(new ActionListener() {
915 public void actionPerformed(ActionEvent e) {
916 log.user("Exception from other thread selected");
920 throw new RuntimeException("Testing exception from newly created thread");
927 item = new JMenuItem("OutOfMemoryError here");
928 item.addActionListener(new ActionListener() {
930 public void actionPerformed(ActionEvent e) {
931 log.user("OutOfMemoryError here selected");
932 throw new OutOfMemoryError("Testing OutOfMemoryError from menu action listener");
944 * Select the tab on the main pane.
946 * @param tab one of {@link #COMPONENT_TAB} or {@link #SIMULATION_TAB}.
948 public void selectTab(int tab) {
949 tabbedPane.setSelectedIndex(tab);
954 private void openAction() {
955 JFileChooser chooser = new JFileChooser();
957 chooser.addChoosableFileFilter(ALL_DESIGNS_FILTER);
958 chooser.addChoosableFileFilter(OPENROCKET_DESIGN_FILTER);
959 chooser.addChoosableFileFilter(ROCKSIM_DESIGN_FILTER);
960 chooser.setFileFilter(ALL_DESIGNS_FILTER);
962 chooser.setFileSelectionMode(JFileChooser.FILES_ONLY);
963 chooser.setMultiSelectionEnabled(true);
964 chooser.setCurrentDirectory(Prefs.getDefaultDirectory());
965 int option = chooser.showOpenDialog(this);
966 if (option != JFileChooser.APPROVE_OPTION) {
967 log.user("Decided not to open files, option=" + option);
971 Prefs.setDefaultDirectory(chooser.getCurrentDirectory());
973 File[] files = chooser.getSelectedFiles();
974 log.user("Opening files " + Arrays.toString(files));
976 for (File file : files) {
977 log.info("Opening file: " + file);
978 if (open(file, this)) {
980 // Close previous window if replacing
981 if (replaceable && document.isSaved()) {
982 log.info("Closing window because it is replaceable");
992 * Open a file based on a URL.
993 * @param url the file to open.
994 * @param parent the parent window for dialogs.
995 * @return <code>true</code> if opened successfully.
997 private static boolean open(URL url, BasicFrame parent) {
998 String filename = null;
1000 // First figure out the file name from the URL
1002 // Try using URI.getPath();
1004 URI uri = url.toURI();
1005 filename = uri.getPath();
1006 } catch (URISyntaxException ignore) {
1009 // Try URL-decoding the URL
1010 if (filename == null) {
1012 filename = URLDecoder.decode(url.toString(), "UTF-8");
1013 } catch (UnsupportedEncodingException ignore) {
1018 if (filename == null) {
1022 // Remove path from filename
1023 if (filename.lastIndexOf('/') >= 0) {
1024 filename = filename.substring(filename.lastIndexOf('/') + 1);
1029 log.info("Opening file from url=" + url + " filename=" + filename);
1031 InputStream is = url.openStream();
1032 if (open(is, filename, parent)) {
1033 // Close previous window if replacing
1034 if (parent.replaceable && parent.document.isSaved()) {
1035 parent.closeAction();
1036 parent.replaceable = false;
1039 } catch (IOException e) {
1040 log.warn("Error opening file" + e);
1041 JOptionPane.showMessageDialog(parent,
1042 "An error occurred while opening the file " + filename,
1043 "Error loading file", JOptionPane.ERROR_MESSAGE);
1051 * Open the specified file from an InputStream in a new design frame. If an error
1052 * occurs, an error dialog is shown and <code>false</code> is returned.
1054 * @param stream the stream to load from.
1055 * @param filename the file name to display in dialogs (not set to the document).
1056 * @param parent the parent component for which a progress dialog is opened.
1057 * @return whether the file was successfully loaded and opened.
1059 private static boolean open(InputStream stream, String filename, Window parent) {
1060 OpenFileWorker worker = new OpenFileWorker(stream, ROCKET_LOADER);
1061 return open(worker, filename, null, parent);
1066 * Open the specified file in a new design frame. If an error occurs, an error
1067 * dialog is shown and <code>false</code> is returned.
1069 * @param file the file to open.
1070 * @param parent the parent component for which a progress dialog is opened.
1071 * @return whether the file was successfully loaded and opened.
1073 public static boolean open(File file, Window parent) {
1074 OpenFileWorker worker = new OpenFileWorker(file, ROCKET_LOADER);
1075 return open(worker, file.getName(), file, parent);
1080 * Open the specified file using the provided worker.
1082 * @param worker the OpenFileWorker that loads the file.
1083 * @param filename the file name to display in dialogs.
1084 * @param file the File to set the document to (may be null).
1088 private static boolean open(OpenFileWorker worker, String filename, File file, Window parent) {
1090 MotorDatabaseLoadingDialog.check(parent);
1092 // Open the file in a Swing worker thread
1093 log.info("Starting OpenFileWorker");
1094 if (!SwingWorkerDialog.runWorker(parent, "Opening file", "Reading " + filename + "...", worker)) {
1095 // User cancelled the operation
1096 log.info("User cancelled the OpenFileWorker");
1101 // Handle the document
1102 OpenRocketDocument doc = null;
1107 } catch (ExecutionException e) {
1109 Throwable cause = e.getCause();
1111 if (cause instanceof FileNotFoundException) {
1113 log.warn("File not found", cause);
1114 JOptionPane.showMessageDialog(parent,
1115 "File not found: " + filename,
1116 "Error opening file", JOptionPane.ERROR_MESSAGE);
1119 } else if (cause instanceof RocketLoadException) {
1121 log.warn("Error loading the file", cause);
1122 JOptionPane.showMessageDialog(parent,
1123 "Unable to open file '" + filename + "': "
1124 + cause.getMessage(),
1125 "Error opening file", JOptionPane.ERROR_MESSAGE);
1130 throw new BugException("Unknown error when opening file", e);
1134 } catch (InterruptedException e) {
1135 throw new BugException("EDT was interrupted", e);
1139 throw new BugException("Document loader returned null");
1144 WarningSet warnings = worker.getRocketLoader().getWarnings();
1145 if (!warnings.isEmpty()) {
1146 log.info("Warnings while reading file: " + warnings);
1147 WarningDialog.showWarnings(parent,
1149 //// The following problems were encountered while opening
1150 trans.get("BasicFrame.WarningDialog.txt1") + " " + filename + ".",
1151 //// Some design features may not have been loaded correctly.
1152 trans.get("BasicFrame.WarningDialog.txt2")
1154 //// Warnings while opening file
1155 trans.get("BasicFrame.WarningDialog.title"), warnings);
1159 // Set document state
1164 log.debug("Opening new frame with the document");
1165 BasicFrame frame = new BasicFrame(doc);
1166 frame.setVisible(true);
1175 private boolean saveAction() {
1176 File file = document.getFile();
1178 log.info("Document does not contain file, opening save as dialog instead");
1179 return saveAsAction();
1181 log.info("Saving document to " + file);
1183 // Saving RockSim designs is not supported
1184 if (ROCKSIM_DESIGN_FILTER.accept(file)) {
1185 file = new File(file.getAbsolutePath().replaceAll(".[rR][kK][tT](.[gG][zZ])?$",
1188 log.info("Attempting to save in RockSim format, renaming to " + file);
1189 int option = JOptionPane.showConfirmDialog(this, new Object[] {
1190 "Saving designs in RockSim format is not supported.",
1191 "Save in OpenRocket format instead (" + file.getName() + ")?"
1192 }, "Save " + file.getName(), JOptionPane.YES_NO_OPTION,
1193 JOptionPane.QUESTION_MESSAGE, null);
1194 if (option != JOptionPane.YES_OPTION) {
1195 log.user("User chose not to save");
1199 document.setFile(file);
1201 return saveAs(file);
1205 private boolean saveAsAction() {
1208 // TODO: HIGH: what if *.rkt chosen?
1209 StorageOptionChooser storageChooser =
1210 new StorageOptionChooser(document, document.getDefaultStorageOptions());
1211 JFileChooser chooser = new JFileChooser();
1212 chooser.setFileFilter(OPENROCKET_DESIGN_FILTER);
1213 chooser.setCurrentDirectory(Prefs.getDefaultDirectory());
1214 chooser.setAccessory(storageChooser);
1215 if (document.getFile() != null)
1216 chooser.setSelectedFile(document.getFile());
1218 int option = chooser.showSaveDialog(BasicFrame.this);
1219 if (option != JFileChooser.APPROVE_OPTION) {
1220 log.user("User decided not to save, option=" + option);
1224 file = chooser.getSelectedFile();
1226 log.user("User did not select a file");
1230 Prefs.setDefaultDirectory(chooser.getCurrentDirectory());
1231 storageChooser.storeOptions(document.getDefaultStorageOptions());
1233 if (file.getName().indexOf('.') < 0) {
1234 log.debug("File name does not contain extension, adding .ork");
1235 String name = file.getAbsolutePath();
1236 name = name + ".ork";
1237 file = new File(name);
1240 if (file.exists()) {
1241 log.info("File " + file + " exists, confirming overwrite from user");
1242 int result = JOptionPane.showConfirmDialog(this,
1243 "File '" + file.getName() + "' exists. Do you want to overwrite it?",
1244 "File exists", JOptionPane.YES_NO_OPTION, JOptionPane.QUESTION_MESSAGE);
1245 if (result != JOptionPane.YES_OPTION) {
1246 log.user("User decided not to overwrite the file");
1251 return saveAs(file);
1254 private boolean saveAs(File file) {
1255 log.info("Saving document as " + file);
1256 boolean saved = false;
1258 if (!StorageOptionChooser.verifyStorageOptions(document, this)) {
1259 // User cancelled the dialog
1260 log.user("User cancelled saving in storage options dialog");
1265 SaveFileWorker worker = new SaveFileWorker(document, file, ROCKET_SAVER);
1267 if (!SwingWorkerDialog.runWorker(this, "Saving file",
1268 "Writing " + file.getName() + "...", worker)) {
1270 // User cancelled the save
1271 log.user("User cancelled the save, deleting the file");
1278 document.setFile(file);
1279 document.setSaved(true);
1282 } catch (ExecutionException e) {
1284 Throwable cause = e.getCause();
1286 if (cause instanceof IOException) {
1287 log.warn("An I/O error occurred while saving " + file, cause);
1288 JOptionPane.showMessageDialog(this, new String[] {
1289 "An I/O error occurred while saving:",
1290 e.getMessage() }, "Saving failed", JOptionPane.ERROR_MESSAGE);
1293 Reflection.handleWrappedException(e);
1296 } catch (InterruptedException e) {
1297 throw new BugException("EDT was interrupted", e);
1304 private boolean closeAction() {
1305 if (!document.isSaved()) {
1306 log.info("Confirming whether to save the design");
1307 ComponentConfigDialog.hideDialog();
1308 int result = JOptionPane.showConfirmDialog(this,
1309 trans.get("BasicFrame.dlg.lbl1") + rocket.getName() +
1310 trans.get("BasicFrame.dlg.lbl2") + " " +
1311 trans.get("BasicFrame.dlg.lbl3"),
1312 trans.get("BasicFrame.dlg.title"), JOptionPane.YES_NO_CANCEL_OPTION,
1313 JOptionPane.QUESTION_MESSAGE);
1314 if (result == JOptionPane.YES_OPTION) {
1316 log.user("User requested file save");
1317 if (!saveAction()) {
1318 log.info("File save was interrupted, not closing");
1321 } else if (result == JOptionPane.NO_OPTION) {
1322 // Don't save: No-op
1323 log.user("User requested to discard design");
1326 log.user("User cancelled closing, result=" + result);
1331 // Rocket has been saved or discarded
1332 log.debug("Disposing window");
1335 ComponentConfigDialog.hideDialog();
1336 ComponentAnalysisDialog.hideDialog();
1338 frames.remove(this);
1339 if (frames.isEmpty()) {
1340 log.info("Last frame closed, exiting");
1351 public void printAction() {
1352 if (!Prefs.getBoolean("printing.experimental.communicated", false)) {
1353 log.info("Showing printing is experimental warning to the user");
1354 JOptionPane.showMessageDialog(this, "Printing is an currently an experimental feature " +
1355 "and might not fully work on all platforms",
1356 "Experimental feature", JOptionPane.WARNING_MESSAGE);
1357 Prefs.putBoolean("printing.experimental.communicated", true);
1359 new PrintDialog(this, document).setVisible(true);
1363 * Open a new design window with a basic rocket+stage.
1365 public static void newAction() {
1366 log.info("New action initiated");
1368 Rocket rocket = new Rocket();
1369 Stage stage = new Stage();
1371 stage.setName(trans.get("BasicFrame.StageName.Sustainer"));
1372 rocket.addChild(stage);
1373 OpenRocketDocument doc = new OpenRocketDocument(rocket);
1376 BasicFrame frame = new BasicFrame(doc);
1377 frame.replaceable = true;
1378 frame.setVisible(true);
1379 ComponentConfigDialog.showDialog(frame, doc, rocket);
1383 * Quit the application. Confirms saving unsaved designs. The action of File->Quit.
1385 public static void quitAction() {
1386 log.info("Quit action initiated");
1387 for (int i = frames.size() - 1; i >= 0; i--) {
1388 log.debug("Closing frame " + frames.get(i));
1389 if (!frames.get(i).closeAction()) {
1391 log.info("Quit was cancelled");
1395 // Should not be reached, but just in case
1396 log.error("Should already have exited application");
1402 * Set the title of the frame, taking into account the name of the rocket, file it
1403 * has been saved to (if any) and saved status.
1405 private void setTitle() {
1406 File file = document.getFile();
1407 boolean saved = document.isSaved();
1410 title = rocket.getName();
1412 title = title + " (" + file.getName() + ")";
1415 title = "*" + title;
1423 * Find a currently open BasicFrame containing the specified rocket. This method
1424 * can be used to map a Rocket to a BasicFrame from GUI methods.
1426 * @param rocket the Rocket.
1427 * @return the corresponding BasicFrame, or <code>null</code> if none found.
1429 public static BasicFrame findFrame(Rocket rocket) {
1430 for (BasicFrame f : frames) {
1431 if (f.rocket == rocket) {
1432 log.debug("Found frame " + f + " for rocket " + rocket);
1436 log.debug("Could not find frame for rocket " + rocket);
1441 * Find a currently open document by the rocket object. This method can be used
1442 * to map a Rocket to OpenRocketDocument from GUI methods.
1444 * @param rocket the Rocket.
1445 * @return the corresponding OpenRocketDocument, or <code>null</code> if not found.
1447 public static OpenRocketDocument findDocument(Rocket rocket) {
1448 BasicFrame frame = findFrame(rocket);
1449 if (frame != null) {
1450 return frame.document;