e3fa810d95dd64b6fa312675c91cc07b04bfe96c
[scilab.git] / scilab / modules / gui / src / java / org / scilab / modules / gui / bridge / window / SwingScilabWindow.java
1 /*
2  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3  * Copyright (C) 2007 - INRIA - Vincent Couvert
4  * Copyright (C) 2007 - INRIA - Bruno JOFRET
5  * Copyright (C) 2007 - INRIA - Marouane BEN JELLOUL
6  * Copyright (C) 2009 - DIGITEO - Sylvestre LEDRU (Mac OS X port)
7  * Copyright (C) 2011 - DIGITEO - Vincent Couvert
8  *
9  * This file must be used under the terms of the CeCILL.
10  * This source file is licensed as described in the file COPYING, which
11  * you should have received as part of this distribution.  The terms
12  * are also available at
13  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
14  *
15  */
16
17 package org.scilab.modules.gui.bridge.window;
18
19 import org.flexdock.docking.Dockable;
20 import org.flexdock.docking.DockingManager;
21 import org.flexdock.docking.DockingPort;
22 import org.flexdock.docking.activation.ActiveDockableTracker;
23 import org.flexdock.docking.defaults.DefaultDockingPort;
24 import org.flexdock.docking.defaults.DefaultDockingStrategy;
25 import org.flexdock.docking.drag.effects.EffectsManager;
26 import org.flexdock.docking.drag.preview.GhostPreview;
27 import org.scilab.modules.action_binding.InterpreterManagement;
28 import org.scilab.modules.commons.gui.ScilabKeyStroke;
29 import org.scilab.modules.gui.bridge.menubar.SwingScilabMenuBar;
30 import org.scilab.modules.gui.bridge.tab.SwingScilabTab;
31 import org.scilab.modules.gui.bridge.textbox.SwingScilabTextBox;
32 import org.scilab.modules.gui.bridge.toolbar.SwingScilabToolBar;
33 import org.scilab.modules.gui.menubar.MenuBar;
34 import org.scilab.modules.gui.menubar.SimpleMenuBar;
35 import org.scilab.modules.gui.tab.SimpleTab;
36 import org.scilab.modules.gui.textbox.SimpleTextBox;
37 import org.scilab.modules.gui.textbox.TextBox;
38 import org.scilab.modules.gui.toolbar.SimpleToolBar;
39 import org.scilab.modules.gui.toolbar.ToolBar;
40 import org.scilab.modules.gui.utils.ClosingOperationsManager;
41 import org.scilab.modules.gui.utils.Position;
42 import org.scilab.modules.gui.utils.SciDockingListener;
43 import org.scilab.modules.gui.utils.ScilabSwingUtilities;
44 import org.scilab.modules.gui.utils.Size;
45 import org.scilab.modules.gui.window.SimpleWindow;
46
47 import javax.swing.ImageIcon;
48 import javax.swing.JComponent;
49 import javax.swing.JFrame;
50 import javax.swing.SwingUtilities;
51 import javax.swing.WindowConstants;
52 import java.awt.Dimension;
53 import java.awt.Frame;
54 import java.awt.event.ActionEvent;
55 import java.awt.event.ActionListener;
56 import java.awt.event.WindowAdapter;
57 import java.awt.event.WindowEvent;
58 import java.lang.reflect.InvocationTargetException;
59 import java.rmi.server.UID;
60 import java.util.Collections;
61 import java.util.HashMap;
62 import java.util.Iterator;
63 import java.util.Map;
64 import java.util.Set;
65 import java.util.UUID;
66
67 /**
68  * Swing implementation for Scilab windows in GUIs
69  * This implementation uses FlexDock package
70  * @author Vincent COUVERT
71  * @author Bruno JOFRET
72  * @author Marouane BEN JELLOUL
73  * @author Sylvestre LEDRU (Mac OS X port)
74
75  */
76 public class SwingScilabWindow extends JFrame implements SimpleWindow {
77
78     private static final long serialVersionUID = -5661926417765805660L;
79
80     private static final int DEFAULTWIDTH = 500;
81     private static final int DEFAULTHEIGHT = 500;
82
83     public static Map<String, SwingScilabWindow> allScilabWindows = Collections.synchronizedMap(new HashMap<String, SwingScilabWindow>());
84
85     static {
86         DefaultDockingStrategy.setDefaultResizeWeight(0.5);
87         DefaultDockingStrategy.keepConstantPercentage(true);
88     }
89
90     private DefaultDockingPort sciDockingPort;
91     private SciDockingListener sciDockingListener;
92     private SimpleMenuBar menuBar;
93     private SimpleToolBar toolBar;
94     private SimpleTextBox infoBar;
95     private String uuid;
96     private int elementId; // the id of the Window which contains this SimpleWindow
97     private String windowUID;
98     private final boolean MAC_OS_X = (System.getProperty("os.name").toLowerCase().startsWith("mac os x"));
99
100     /**
101      * Constructor
102      */
103     public SwingScilabWindow() {
104         super();
105         this.uuid = UUID.randomUUID().toString();
106
107         setDefaultCloseOperation(WindowConstants.DO_NOTHING_ON_CLOSE);
108
109         // By default ctrl+w close the window
110         ActionListener listener = new ActionListener() {
111             @Override
112             public void actionPerformed(ActionEvent e) {
113                 processWindowEvent(new WindowEvent(SwingScilabWindow.this, WindowEvent.WINDOW_CLOSING));
114             }
115         };
116         getRootPane().registerKeyboardAction(listener, ScilabKeyStroke.getKeyStroke("OSSCKEY W"), JComponent.WHEN_IN_FOCUSED_WINDOW);
117
118         // TODO : Only for testing : Must be removed
119         this.setDims(new Size(DEFAULTWIDTH, DEFAULTHEIGHT));
120         this.setTitle("Scilab");
121         setIconImage(new ImageIcon(ScilabSwingUtilities.findIcon("scilab", "256x256")).getImage());
122
123         /* defining the Layout */
124         super.setLayout(new java.awt.BorderLayout());
125
126         /* Create automatically a docking port associated to the window */
127         sciDockingPort = new DefaultDockingPort();
128
129         EffectsManager.setPreview(new GhostPreview());
130
131         /* The docking port is the center of the Layout of the Window */
132         super.add(sciDockingPort, java.awt.BorderLayout.CENTER);
133
134         /* there is no menuBar, no toolBar and no infoBar at creation */
135         this.menuBar = null;
136         this.toolBar = null;
137         this.infoBar = null;
138
139         sciDockingListener = new SciDockingListener();
140         sciDockingPort.addDockingListener(sciDockingListener);
141
142         /*
143          * Prevent the background RootPane to catch Focus.
144          * Causes trouble with Scicos use xclick & co.
145          */
146         //this.setFocusable(false);
147
148         // let the OS choose the window position if not specified by user.
149         setLocationByPlatform(true);
150
151         addWindowListener(new WindowAdapter() {
152             @Override
153             public void windowClosing(WindowEvent e) {
154                 ClosingOperationsManager.startClosingOperation(SwingScilabWindow.this);
155             }
156         });
157
158         if (MAC_OS_X) {
159             registerForMacOSXEvents();
160         }
161
162         windowUID = new UID().toString();
163
164         sciDockingListener.setAssociatedWindowId(windowUID);
165
166         allScilabWindows.put(windowUID, this);
167     }
168
169     /**
170      * This method registers some methods against the specific Mac OS X API
171      * (in order to set the "special" mac os x menus)
172      */
173     private void registerForMacOSXEvents() {
174         try {
175             // Generate and register the OSXAdapter, passing it a hash of all the methods we wish to
176             // use as delegates for various com.apple.eawt.ApplicationListener methods
177             OSXAdapter.setAboutHandler(this, getClass().getDeclaredMethod("OSXabout", (Class[])null));
178             OSXAdapter.setQuitHandler(this, getClass().getDeclaredMethod("OSXquit", (Class[])null));
179             OSXAdapter.setDockIcon(new ImageIcon(ScilabSwingUtilities.findIcon("puffin", "256x256")));
180         } catch (java.lang.NoSuchMethodException e) {
181             System.err.println("OSXAdapter could not find the method: " + e.getLocalizedMessage());
182         }
183     }
184
185     /**
186      * This method is called by the OSXAdapter class when the specific Mac
187      * OS X about menu is called. It is the only case where this method
188      * should be used
189      */
190     public void OSXabout() {
191         InterpreterManagement.requestScilabExec("about()");
192     }
193
194     public void OSXquit() {
195         InterpreterManagement.requestScilabExec("exit()");
196     }
197
198     /**
199      * @return the UUID associated with this window
200      */
201     public String getUUID() {
202         return uuid;
203     }
204
205     /**
206      * @param uuid the UUID associated with this window
207      */
208     public void setUUID(String uuid) {
209         this.uuid = uuid;
210     }
211
212     /**
213      * Creates a swing Scilab window
214      * @return the created window
215      */
216     public static SimpleWindow createWindow() {
217         return new SwingScilabWindow();
218     }
219
220     /**
221      * Draws a swing Scilab window
222      * @see org.scilab.modules.gui.uielement.UIElement#draw()
223      */
224     @Override
225     public void draw() {
226         this.setVisible(true);
227         this.doLayout();
228     }
229
230     /**
231      * Private method to raise to the front the window
232      */
233     private void raiseToFront() {
234         // force visibility
235         setVisible(true);
236
237         // deiconify the window if needed
238         setState(NORMAL);
239
240         // put it in front of others
241         toFront();
242     }
243
244     /**
245      * Deiconify the window and put it in front of other window
246      */
247     @Override
248     public void raise() {
249         // blocking call. So graphic synchronization must be desactivated here.
250         if (!SwingUtilities.isEventDispatchThread()) {
251             /* javasci bug: See bug 9544 why we are doing this check */
252             try {
253                 SwingUtilities.invokeAndWait(new Runnable() {
254                     @Override
255                     public void run() {
256                         raiseToFront();
257                     }
258                 });
259             } catch (InterruptedException e) {
260                 e.printStackTrace();
261             } catch (InvocationTargetException e) {
262                 e.printStackTrace();
263             }
264         } else {
265             raiseToFront();
266         }
267     }
268
269     /**
270      * Gets the dimensions (width and height) of a swing Scilab window
271      * @return the dimensions of the window
272      * @see org.scilab.modules.gui.uielement.UIElement#getDims()
273      */
274     @Override
275     public Size getDims() {
276         return new Size(getSize().width, getSize().height);
277     }
278
279     /**
280      * Sets the dimensions (width and height) of a swing Scilab window
281      * @param newWindowSize the dimensions to set to the window
282      * @see org.scilab.modules.gui.uielement.UIElement#setDims(org.scilab.modules.gui.utils.Size)
283      */
284     @Override
285     public void setDims(Size newWindowSize) {
286         //if (!SwingUtilities.isEventDispatchThread()) {
287         if (getDims().getWidth() != newWindowSize.getWidth() || getDims().getHeight() != newWindowSize.getHeight()) {
288             Dimension finalDim = new Dimension(newWindowSize.getWidth(), newWindowSize.getHeight());
289
290             setSize(finalDim);
291             // validate so the new values are taken into account immediately
292             validate();
293         }
294         //}
295     }
296
297     /**
298      * Gets the position (X-coordinate and Y-coordinate) of a swing Scilab window
299      * @return the position of the window
300      * @see org.scilab.modules.gui.uielement.UIElement#getPosition()
301      */
302     @Override
303     public Position getPosition() {
304         return new Position(this.getX(), this.getY());
305     }
306
307     /**
308      * Sets the position (X-coordinate and Y-coordinate) of a swing Scilab window
309      * @param newWindowPosition the position to set to the window
310      * @see org.scilab.modules.gui.uielement.UIElement#setPosition(org.scilab.modules.gui.utils.Position)
311      */
312     @Override
313     public void setPosition(Position newWindowPosition) {
314         //if (!SwingUtilities.isEventDispatchThread()) {
315         if (getPosition().getX() != newWindowPosition.getX() || getPosition().getY() != newWindowPosition.getY()) {
316             this.setLocation(newWindowPosition.getX(), newWindowPosition.getY());
317         }
318         //}
319     }
320
321     /**
322      * Gets the title of a swing Scilab window
323      * @return the title of the window
324      * @see javax.swing.JFrame#getTitle()
325      */
326     @Override
327     public String getTitle() {
328         return super.getTitle();
329     }
330
331     /**
332      * Sets the title of a swing Scilab window
333      * @param newWindowTitle the title to set to the window
334      * @see java.awt.Frame#setTitle(java.lang.String)
335      */
336     @Override
337     public void setTitle(String newWindowTitle) {
338         // set only if required
339         if (newWindowTitle != null && !newWindowTitle.equals(getTitle())) {
340             super.setTitle(newWindowTitle);
341         }
342     }
343
344     /**
345      * {@inheritedDoc}
346      */
347     @Override
348     public void setName(String name) {
349         super.setName(name);
350         setTitle(name);
351     }
352
353     /**
354      * Gets the docking port associated to the window (created by default at window creation)
355      * @return the docking port associated to the window
356      */
357     public DockingPort getDockingPort() {
358         //return (DockingPort) centerFrame.getContentPane();
359         return sciDockingPort;
360     }
361
362     /**
363      * Add a Scilab tab to a Scilab window
364      * @param newTab the Scilab tab to add to the Scilab window
365      * @see org.scilab.modules.gui.window.Window#addTab(org.scilab.modules.gui.tab.Tab)
366      */
367     @Override
368     public void addTab(SimpleTab newTab) {
369         SwingScilabTab tab = (SwingScilabTab) newTab;
370         tab.setParentWindowId(this.windowUID);
371         DockingManager.dock(tab, this.getDockingPort());
372         ActiveDockableTracker.requestDockableActivation(tab);
373     }
374
375     /**
376      * Remove a Scilab tab from a Scilab window
377      * @param tabs the Scilab tabs to remove from the Scilab window
378      * @see org.scilab.modules.gui.window.Window#removeTab(org.scilab.modules.gui.tab.Tab)
379      */
380     public void removeTabs(SwingScilabTab[] tabs) {
381         for (SwingScilabTab tab : tabs) {
382             DockingManager.unregisterDockable((Dockable) tab);
383             tab.close();
384             DockingManager.close(tab);
385         }
386         if (getDockingPort().getDockables().isEmpty()) {
387             // remove xxxBars
388             if (toolBar != null) {
389                 ((SwingScilabToolBar) toolBar).close();
390             }
391             if (menuBar != null) {
392                 ((SwingScilabMenuBar) menuBar).close();
393             }
394
395             // clean all
396             this.removeAll();
397             close();
398
399             // disable docking port
400             ActiveDockableTracker.getTracker(this).setActive(null);
401             sciDockingPort.removeDockingListener(sciDockingListener);
402             sciDockingPort = null;
403             sciDockingListener = null;
404         } else {
405             /* Make sur a Tab is active */
406             Set<SwingScilabTab> docks = sciDockingPort.getDockables();
407             Iterator<SwingScilabTab> it = docks.iterator();
408             ActiveDockableTracker.requestDockableActivation(it.next());
409         }
410     }
411
412     /**
413      * Remove a Scilab tab from a Scilab window
414      * @param tab the Scilab tab to remove from the Scilab window
415      * @see org.scilab.modules.gui.window.Window#removeTab(org.scilab.modules.gui.tab.Tab)
416      */
417     @Override
418     public void removeTab(SimpleTab tab) {
419         removeTabs(new SwingScilabTab[] {(SwingScilabTab) tab});
420     }
421
422     /**
423      * Sets a Scilab MenuBar to a Scilab window
424      * @param newMenuBar the Scilab MenuBar to add to the Scilab window
425      * @see org.scilab.modules.gui.window.Window#addMenuBar(org.scilab.modules.gui.menubar.MenuBar)
426      */
427     @Override
428     public void addMenuBar(MenuBar newMenuBar) {
429         if (newMenuBar == null) {
430             if (this.menuBar != null) {
431                 this.menuBar = null;
432                 super.setJMenuBar(null);
433             }
434             // else nothing to do both are null
435         } else {
436             if (this.menuBar != newMenuBar.getAsSimpleMenuBar()) {
437                 this.menuBar = newMenuBar.getAsSimpleMenuBar();
438                 super.setJMenuBar((SwingScilabMenuBar) newMenuBar.getAsSimpleMenuBar());
439             }
440             //  else nothing to do element alredy set
441         }
442     }
443
444     /**
445      * Sets a Scilab ToolBar to a Scilab window
446      * @param newToolBar the Scilab ToolBar to set to the Scilab window
447      * @see org.scilab.modules.gui.window.Window#addToolBar(org.scilab.modules.gui.toolbar.ToolBar)
448      */
449     @Override
450     public void addToolBar(ToolBar newToolBar) {
451         if (newToolBar == null) {
452             if (this.toolBar != null) {
453                 // Remove old InfoBar if already set
454                 super.remove((SwingScilabToolBar) this.toolBar);
455                 this.toolBar = null;
456             }
457             // else nothing to do both are null
458         } else {
459             if (this.toolBar != newToolBar.getAsSimpleToolBar()) {
460                 if (this.toolBar != null) {
461                     // Remove old InfoBar if already set
462                     super.remove((SwingScilabToolBar) this.toolBar);
463                 }
464                 this.toolBar = newToolBar.getAsSimpleToolBar();
465                 super.add((SwingScilabToolBar) this.toolBar, java.awt.BorderLayout.PAGE_START);
466             }
467             //  else nothing to do element alredy set
468         }
469     }
470
471     /**
472      * Sets a Scilab InfoBar to a Scilab window
473      * @param newInfoBar the Scilab InfoBar to set to the Scilab window
474      * @see org.scilab.modules.gui.window.Window#addInfoBar(org.scilab.modules.gui.textbox.TextBox)
475      */
476     @Override
477     public void addInfoBar(TextBox newInfoBar) {
478         if (newInfoBar == null) {
479             if (this.infoBar != null) {
480                 // Remove old InfoBar if already set
481                 super.remove((SwingScilabTextBox) this.infoBar);
482                 this.infoBar = null;
483             }
484             // else nothing to do both are null
485         } else {
486             if (this.infoBar != newInfoBar.getAsSimpleTextBox()) {
487                 if (this.infoBar != null) {
488                     // Remove old InfoBar if already set
489                     super.remove((SwingScilabTextBox) this.infoBar);
490                 }
491                 this.infoBar = newInfoBar.getAsSimpleTextBox();
492                 super.add((SwingScilabTextBox) this.infoBar, java.awt.BorderLayout.PAGE_END);
493             }
494             //  else nothing to do element alredy set
495         }
496     }
497
498     /**
499      * Get the element id for this window
500      * @return id the id of the corresponding window object
501      */
502     @Override
503     public int getElementId() {
504         return elementId;
505     }
506
507     /**
508      * Set the element id for this window
509      * @param id the id of the corresponding window object
510      */
511     @Override
512     public void setElementId(int id) {
513         this.elementId = id;
514         //sciDockingListener.setAssociatedWindowId(id);
515     }
516
517     /**
518      * Close the window
519      * @see org.scilab.modules.gui.window.SimpleWindow#close()
520      */
521     @Override
522     public void close() {
523         try {
524             dispose();
525         } catch (IllegalStateException e) {
526             enableInputMethods(false);
527         }
528         allScilabWindows.remove(windowUID);
529     }
530
531     /**
532      * @return number of objects (tabs) docked in this window
533      */
534     @Override
535     public int getNbDockedObjects() {
536         return sciDockingPort.getDockables().size();
537     }
538
539     /**
540      * Update the dimension of the window and its component.
541      * Only useful when the window is not yet visible
542      */
543     @Override
544     public void updateDimensions() {
545         pack();
546     }
547
548     /**
549      * DeIconify Window
550      */
551     @Override
552     public void windowDeiconified() {
553         super.setState(Frame.NORMAL);
554     }
555
556     /**
557      * Iconify Window
558      */
559     @Override
560     public void windowIconified() {
561         super.setState(Frame.ICONIFIED);
562     }
563
564     /**
565      * Maximized Window
566      */
567     @Override
568     public void windowMaximized() {
569         super.setExtendedState(Frame.MAXIMIZED_BOTH);
570     }
571
572     /**
573      * Window is in the "normal" state.
574      */
575     @Override
576     public void windowNormal() {
577         super.setState(Frame.NORMAL);
578     }
579
580     /**
581      * Get the window UID
582      * @return the UID
583      */
584     public String getId() {
585         return windowUID;
586     }
587 }