2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
7 * Jalview is free software: you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation, either version 3
10 * of the License, or (at your option) any later version.
12 * Jalview is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty
14 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 * PURPOSE. See the GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
19 * The Jalview Authors are detailed in the 'AUTHORS' file.
23 import java.awt.AWTEvent;
24 import java.awt.ActiveEvent;
25 import java.awt.Component;
26 import java.awt.Container;
27 import java.awt.Dialog.ModalityType;
28 import java.awt.EventQueue;
29 import java.awt.HeadlessException;
30 import java.awt.MenuComponent;
31 import java.awt.Toolkit;
32 import java.awt.Window;
33 import java.awt.event.ActionEvent;
34 import java.awt.event.ActionListener;
35 import java.awt.event.KeyEvent;
36 import java.awt.event.MouseAdapter;
37 import java.awt.event.MouseMotionAdapter;
38 import java.beans.PropertyChangeEvent;
39 import java.beans.PropertyChangeListener;
40 import java.beans.PropertyVetoException;
41 import java.util.ArrayList;
42 import java.util.Arrays;
43 import java.util.HashMap;
44 import java.util.List;
46 import java.util.concurrent.ExecutorService;
47 import java.util.concurrent.Executors;
49 import javax.swing.Icon;
50 import javax.swing.JButton;
51 import javax.swing.JDialog;
52 import javax.swing.JFrame;
53 import javax.swing.JInternalFrame;
54 import javax.swing.JLayeredPane;
55 import javax.swing.JMenu;
56 import javax.swing.JMenuBar;
57 import javax.swing.JOptionPane;
58 import javax.swing.JPanel;
59 import javax.swing.JRootPane;
60 import javax.swing.SwingUtilities;
61 import javax.swing.UIManager;
62 import javax.swing.event.InternalFrameEvent;
63 import javax.swing.event.InternalFrameListener;
65 import jalview.bin.Console;
66 import jalview.util.ChannelProperties;
67 import jalview.util.MessageManager;
68 import jalview.util.Platform;
69 import jalview.util.dialogrunner.DialogRunnerI;
71 public class JvOptionPane extends JOptionPane
72 implements DialogRunnerI, PropertyChangeListener
74 private static final long serialVersionUID = -3019167117756785229L;
76 private static Object mockResponse = JvOptionPane.CANCEL_OPTION;
78 private static boolean interactiveMode = true;
80 public static final Runnable NULLCALLABLE = () -> {
83 private Component parentComponent;
85 private ExecutorService executor = Executors.newCachedThreadPool();
87 private JDialog dialog = null;
89 private Map<Object, Runnable> callbacks = new HashMap<>();
91 private int timeout = -1;
93 public void setTimeout(int i)
99 * JalviewJS reports user choice in the dialog as the selected option (text);
100 * this list allows conversion to index (int)
102 List<Object> ourOptions;
104 public JvOptionPane(final Component parent)
106 this.parentComponent = Platform.isJS() ? this : parent;
110 public static int showConfirmDialog(Component parentComponent,
111 Object message) throws HeadlessException
113 // only called by test
114 return isInteractiveMode()
115 ? JOptionPane.showConfirmDialog(parentComponent, message)
116 : (int) getMockResponse();
120 * Message, title, optionType
122 * @param parentComponent
127 * @throws HeadlessException
129 public static int showConfirmDialog(Component parentComponent,
130 Object message, String title, int optionType)
131 throws HeadlessException
133 if (!isInteractiveMode())
135 return (int) getMockResponse();
139 case JvOptionPane.YES_NO_CANCEL_OPTION:
140 // FeatureRenderer amendFeatures ?? TODO ??
145 case JvOptionPane.YES_NO_OPTION:
146 // PromptUserConfig usage stats
147 // for now treated as "OK CANCEL"
149 case JvOptionPane.OK_CANCEL_OPTION:
150 // will fall back to simple HTML
151 return JOptionPane.showConfirmDialog(parentComponent, message, title,
157 * Adds a message type. Fallback is to just add it in the beginning.
159 * @param parentComponent
165 * @throws HeadlessException
167 public static int showConfirmDialog(Component parentComponent,
168 Object message, String title, int optionType, int messageType)
169 throws HeadlessException
171 // JalviewServicesChanged
172 // PromptUserConfig raiseDialog
173 return isInteractiveMode()
174 ? JOptionPane.showConfirmDialog(parentComponent, message, title,
175 optionType, messageType)
176 : (int) getMockResponse();
182 * @param parentComponent
189 * @throws HeadlessException
191 public static int showConfirmDialog(Component parentComponent,
192 Object message, String title, int optionType, int messageType,
193 Icon icon) throws HeadlessException
195 // JvOptionPaneTest only
196 return isInteractiveMode()
197 ? JOptionPane.showConfirmDialog(parentComponent, message, title,
198 optionType, messageType, icon)
199 : (int) getMockResponse();
203 * Internal version "OK"
205 * @param parentComponent
209 public static int showInternalConfirmDialog(Component parentComponent,
212 // JvOptionPaneTest only;
213 return isInteractiveMode()
214 ? JOptionPane.showInternalConfirmDialog(parentComponent,
216 : (int) getMockResponse();
220 * Internal version -- changed to standard version for now
222 * @param parentComponent
228 public static int showInternalConfirmDialog(Component parentComponent,
229 String message, String title, int optionType)
231 if (!isInteractiveMode())
233 return (int) getMockResponse();
237 case JvOptionPane.YES_NO_CANCEL_OPTION:
238 // ColourMenuHelper.addMenuItmers.offerRemoval TODO
239 case JvOptionPane.YES_NO_OPTION:
240 // UserDefinedColoursSave -- relevant? TODO
243 case JvOptionPane.OK_CANCEL_OPTION:
245 // EditNameDialog --- uses panel for messsage TODO
247 // Desktop.inputURLMenuItem
249 return JOptionPane.showConfirmDialog(parentComponent, message, title,
256 * @param parentComponent
263 public static int showInternalConfirmDialog(Component parentComponent,
264 Object message, String title, int optionType, int messageType)
266 if (!isInteractiveMode())
268 return (int) getMockResponse();
272 case JvOptionPane.YES_NO_CANCEL_OPTION:
273 case JvOptionPane.YES_NO_OPTION:
274 // UserQuestionanaireCheck
278 case JvOptionPane.OK_CANCEL_OPTION:
279 // will fall back to simple HTML
280 return JOptionPane.showConfirmDialog(parentComponent, message, title,
281 optionType, messageType);
286 * adds icon; no longer internal
288 * @param parentComponent
296 public static int showInternalConfirmDialog(Component parentComponent,
297 Object message, String title, int optionType, int messageType,
300 if (!isInteractiveMode())
302 return (int) getMockResponse();
306 case JvOptionPane.YES_NO_CANCEL_OPTION:
307 case JvOptionPane.YES_NO_OPTION:
310 case JvOptionPane.OK_CANCEL_OPTION:
311 // Preferences editLink/newLink
312 return JOptionPane.showConfirmDialog(parentComponent, message, title,
313 optionType, messageType, icon);
319 * custom options full-featured
321 * @param parentComponent
328 * @param initialValue
330 * @throws HeadlessException
332 public static int showOptionDialog(Component parentComponent,
333 String message, String title, int optionType, int messageType,
334 Icon icon, Object[] options, Object initialValue)
335 throws HeadlessException
337 if (!isInteractiveMode())
339 return (int) getMockResponse();
345 // 1) AlignViewport for openLinkedAlignment
347 // Show a dialog with the option to open and link (cDNA <-> protein) as a
349 // alignment, either as a standalone alignment or in a split frame. Returns
350 // true if the new alignment was opened, false if not, because the user
351 // declined the offer.
353 // 2) UserDefinedColors warning about saving over a name already defined
355 return JOptionPane.showOptionDialog(parentComponent, message, title,
356 optionType, messageType, icon, options, initialValue);
363 * @throws HeadlessException
365 public static void showMessageDialog(Component parentComponent,
366 String message) throws HeadlessException
368 if (!isInteractiveMode())
370 outputMessage(message);
376 JOptionPane.showMessageDialog(parentComponent, message);
380 * OK with message, title, and type
382 * @param parentComponent
386 * @throws HeadlessException
388 public static void showMessageDialog(Component parentComponent,
389 String message, String title, int messageType)
390 throws HeadlessException
392 // 30 implementations -- all just fine.
394 if (!isInteractiveMode())
396 outputMessage(message);
400 JOptionPane.showMessageDialog(parentComponent,
401 getPrefix(messageType) + message, title, messageType);
405 * adds title and icon
407 * @param parentComponent
412 * @throws HeadlessException
414 public static void showMessageDialog(Component parentComponent,
415 String message, String title, int messageType, Icon icon)
416 throws HeadlessException
421 if (!isInteractiveMode())
423 outputMessage(message);
427 JOptionPane.showMessageDialog(parentComponent, message, title,
435 public static void showInternalMessageDialog(Component parentComponent,
439 // WsPreferences only
441 if (!isInteractiveMode())
443 outputMessage(message);
447 JOptionPane.showMessageDialog(parentComponent, message);
451 * Adds title and messageType
453 * @param parentComponent
458 public static void showInternalMessageDialog(Component parentComponent,
459 String message, String title, int messageType)
464 if (!isInteractiveMode())
466 outputMessage(message);
470 JOptionPane.showMessageDialog(parentComponent,
471 getPrefix(messageType) + message, title, messageType);
476 * @param parentComponent
482 public static void showInternalMessageDialog(Component parentComponent,
483 Object message, String title, int messageType, Icon icon)
488 if (!isInteractiveMode())
490 outputMessage(message);
494 JOptionPane.showMessageDialog(parentComponent, message, title,
502 * @throws HeadlessException
504 public static String showInputDialog(Object message)
505 throws HeadlessException
509 if (!isInteractiveMode())
511 return getMockResponse().toString();
514 return JOptionPane.showInputDialog(message);
518 * adds inital selection value
521 * @param initialSelectionValue
524 public static String showInputDialog(String message,
525 String initialSelectionValue)
527 if (!isInteractiveMode())
529 return getMockResponse().toString();
532 // AnnotationPanel character option
534 return JOptionPane.showInputDialog(message, initialSelectionValue);
538 * adds inital selection value
541 * @param initialSelectionValue
544 public static String showInputDialog(Object message,
545 Object initialSelectionValue)
547 if (!isInteractiveMode())
549 return getMockResponse().toString();
552 // AnnotationPanel character option
554 return JOptionPane.showInputDialog(message, initialSelectionValue);
560 * @param parentComponent
563 * @throws HeadlessException
565 public static String showInputDialog(Component parentComponent,
566 String message) throws HeadlessException
570 return isInteractiveMode()
571 ? JOptionPane.showInputDialog(parentComponent, message)
572 : getMockResponse().toString();
576 * input with initial selection
578 * @param parentComponent
580 * @param initialSelectionValue
583 public static String showInputDialog(Component parentComponent,
584 String message, String initialSelectionValue)
589 return isInteractiveMode()
590 ? JOptionPane.showInputDialog(parentComponent, message,
591 initialSelectionValue)
592 : getMockResponse().toString();
596 * input with initial selection
598 * @param parentComponent
600 * @param initialSelectionValue
603 public static String showInputDialog(Component parentComponent,
604 Object message, Object initialSelectionValue)
609 return isInteractiveMode()
610 ? JOptionPane.showInputDialog(parentComponent, message,
611 initialSelectionValue)
612 : getMockResponse().toString();
617 * @param parentComponent
622 * @throws HeadlessException
624 public static String showInputDialog(Component parentComponent,
625 String message, String title, int messageType)
626 throws HeadlessException
631 return isInteractiveMode()
632 ? JOptionPane.showInputDialog(parentComponent, message, title,
634 : getMockResponse().toString();
638 * Customized input option
640 * @param parentComponent
645 * @param selectionValues
646 * @param initialSelectionValue
648 * @throws HeadlessException
650 public static Object showInputDialog(Component parentComponent,
651 Object message, String title, int messageType, Icon icon,
652 Object[] selectionValues, Object initialSelectionValue)
653 throws HeadlessException
658 return isInteractiveMode()
659 ? JOptionPane.showInputDialog(parentComponent, message, title,
660 messageType, icon, selectionValues,
661 initialSelectionValue)
662 : getMockResponse().toString();
668 * @param parentComponent
672 public static String showInternalInputDialog(Component parentComponent,
677 return isInteractiveMode()
678 ? JOptionPane.showInternalInputDialog(parentComponent, message)
679 : getMockResponse().toString();
683 * internal with title and messageType
685 * @param parentComponent
691 public static String showInternalInputDialog(Component parentComponent,
692 String message, String title, int messageType)
695 // AlignFrame tabbedPane_mousePressed
697 return isInteractiveMode()
698 ? JOptionPane.showInternalInputDialog(parentComponent,
699 getPrefix(messageType) + message, title, messageType)
700 : getMockResponse().toString();
704 * customized internal
706 * @param parentComponent
711 * @param selectionValues
712 * @param initialSelectionValue
715 public static Object showInternalInputDialog(Component parentComponent,
716 String message, String title, int messageType, Icon icon,
717 Object[] selectionValues, Object initialSelectionValue)
721 return isInteractiveMode()
722 ? JOptionPane.showInternalInputDialog(parentComponent, message,
723 title, messageType, icon, selectionValues,
724 initialSelectionValue)
725 : getMockResponse().toString();
728 ///////////// end of options ///////////////
730 private static void outputMessage(Object message)
733 .outPrintln(">>> JOption Message : " + message.toString());
736 public static Object getMockResponse()
741 public static void setMockResponse(Object mockOption)
743 JvOptionPane.mockResponse = mockOption;
746 public static void resetMock()
748 setMockResponse(JvOptionPane.CANCEL_OPTION);
749 setInteractiveMode(true);
752 public static boolean isInteractiveMode()
754 return interactiveMode;
757 public static void setInteractiveMode(boolean interactive)
759 JvOptionPane.interactiveMode = interactive;
762 private static String getPrefix(int messageType)
771 case JvOptionPane.WARNING_MESSAGE:
772 prefix = "WARNING! ";
774 case JvOptionPane.ERROR_MESSAGE:
785 * create a new option dialog that can be used to register responses - along
786 * lines of showOptionDialog
791 * @param defaultOption
792 * @param plainMessage
798 public static JvOptionPane newOptionDialog()
800 return new JvOptionPane(null);
803 public static JvOptionPane newOptionDialog(Component parentComponent)
805 return new JvOptionPane(parentComponent);
808 public void showDialog(String message, String title, int optionType,
809 int messageType, Icon icon, Object[] options, Object initialValue)
811 showDialog(message, title, optionType, messageType, icon, options,
815 public void showDialog(Object message, String title, int optionType,
816 int messageType, Icon icon, Object[] options, Object initialValue,
819 showDialog(message, title, optionType, messageType, icon, options,
820 initialValue, modal, null);
823 public void showDialog(Object message, String title, int optionType,
824 int messageType, Icon icon, Object[] options, Object initialValue,
825 boolean modal, JButton[] buttons)
827 if (!isInteractiveMode())
829 handleResponse(getMockResponse());
836 // 1) AlignViewport for openLinkedAlignment
838 // Show a dialog with the option to open and link (cDNA <-> protein) as a
840 // alignment, either as a standalone alignment or in a split frame. Returns
841 // true if the new alignment was opened, false if not, because the user
842 // declined the offer.
844 // 2) UserDefinedColors warning about saving over a name already defined
847 ourOptions = Arrays.asList(options);
851 boolean useButtons = false;
852 Object initialValueButton = null;
853 NOTNULL: if (buttons != null)
855 if (buttons.length != options.length)
857 jalview.bin.Console.error(
858 "Supplied buttons array not the same length as supplied options array.");
862 // run through buttons for initialValue first so we can set (and start)
863 // a final timeoutThreadF to include (and interrupt) in the button
865 Thread timeoutThread = null;
866 for (int i = 0; i < options.length; i++)
868 Object o = options[i];
869 JButton jb = buttons[i];
870 if (o.equals(initialValue))
872 if (timeout > 0 && jb != null && jb instanceof JButton)
874 // after timeout ms click the default button
875 timeoutThread = new Thread(() -> {
878 Thread.sleep(timeout);
879 } catch (InterruptedException e)
882 "Dialog timeout interrupted. Probably a button pressed.");
887 initialValueButton = jb;
891 final Thread timeoutThreadF = timeoutThread;
892 if (timeoutThreadF != null)
894 timeoutThreadF.start();
897 int[] buttonActions = { JOptionPane.YES_OPTION,
898 JOptionPane.NO_OPTION, JOptionPane.CANCEL_OPTION };
899 for (int i = 0; i < options.length; i++)
901 Object o = options[i];
902 jalview.bin.Console.debug(
903 "Setting button " + i + " to '" + o.toString() + "'");
904 JButton jb = buttons[i];
906 int buttonAction = buttonActions[i];
907 Runnable action = callbacks.get(buttonAction);
908 jb.setText((String) o);
909 jb.addActionListener(new ActionListener()
912 public void actionPerformed(ActionEvent e)
914 if (timeoutThreadF != null)
916 timeoutThreadF.interrupt();
919 Object obj = e.getSource();
920 if (obj == null || !(obj instanceof Component))
922 jalview.bin.Console.debug(
923 "Could not find Component source of event object "
927 Object joptionpaneObject = SwingUtilities.getAncestorOfClass(
928 JOptionPane.class, (Component) obj);
929 if (joptionpaneObject == null
930 || !(joptionpaneObject instanceof JOptionPane))
932 jalview.bin.Console.debug(
933 "Could not find JOptionPane ancestor of event object "
937 JOptionPane joptionpane = (JOptionPane) joptionpaneObject;
938 joptionpane.setValue(buttonAction);
940 new Thread(action).start();
941 joptionpane.transferFocusBackward();
942 joptionpane.setVisible(false);
943 // put focus and raise parent window if possible, unless cancel or
945 boolean raiseParent = (parentComponent != null);
946 if (buttonAction == JOptionPane.CANCEL_OPTION)
948 if (optionType == JOptionPane.YES_NO_OPTION
949 && buttonAction == JOptionPane.NO_OPTION)
953 parentComponent.requestFocus();
954 if (parentComponent instanceof JInternalFrame)
956 JInternalFrame jif = (JInternalFrame) parentComponent;
961 else if (parentComponent instanceof Window)
963 Window w = (Window) parentComponent;
968 joptionpane.setVisible(false);
975 // use a JOptionPane as usual
976 int response = JOptionPane.showOptionDialog(parentComponent, message,
977 title, optionType, messageType, icon,
978 useButtons ? buttons : options,
979 useButtons ? initialValueButton : initialValue);
982 * In Java, the response is returned to this thread and handled here; (for
983 * Javascript, see propertyChange)
985 if (!Platform.isJS())
992 handleResponse(response);
998 * This is java similar to the swingjs handling, with the callbacks attached to
999 * the button press of the dialog. This means we can use a non-modal JDialog for
1000 * the confirmation without blocking the GUI.
1002 JOptionPane joptionpane = new JOptionPane();
1003 // Make button options
1004 int[] buttonActions = { JvOptionPane.YES_OPTION,
1005 JvOptionPane.NO_OPTION, JvOptionPane.CANCEL_OPTION };
1007 // we need the strings to make the buttons with actionEventListener
1008 if (options == null)
1010 ArrayList<String> options_default = new ArrayList<>();
1012 .add(UIManager.getString("OptionPane.yesButtonText"));
1013 if (optionType == JvOptionPane.YES_NO_OPTION
1014 || optionType == JvOptionPane.YES_NO_CANCEL_OPTION)
1017 .add(UIManager.getString("OptionPane.noButtonText"));
1019 if (optionType == JvOptionPane.YES_NO_CANCEL_OPTION)
1022 .add(UIManager.getString("OptionPane.cancelButtonText"));
1024 options = options_default.toArray();
1027 ArrayList<JButton> options_btns = new ArrayList<>();
1028 Object initialValue_btn = null;
1029 if (!Platform.isJS()) // JalviewJS already uses callback, don't need to
1032 for (int i = 0; i < options.length && i < 3; i++)
1034 Object o = options[i];
1035 int buttonAction = buttonActions[i];
1036 Runnable action = callbacks.get(buttonAction);
1037 JButton jb = new JButton();
1038 jb.setText((String) o);
1039 jb.addActionListener(new ActionListener()
1043 public void actionPerformed(ActionEvent e)
1045 joptionpane.setValue(buttonAction);
1047 new Thread(action).start();
1048 // joptionpane.transferFocusBackward();
1049 joptionpane.transferFocusBackward();
1050 joptionpane.setVisible(false);
1051 // put focus and raise parent window if possible, unless cancel
1053 boolean raiseParent = (parentComponent != null);
1054 if (buttonAction == JvOptionPane.CANCEL_OPTION)
1055 raiseParent = false;
1056 if (optionType == JvOptionPane.YES_NO_OPTION
1057 && buttonAction == JvOptionPane.NO_OPTION)
1058 raiseParent = false;
1061 parentComponent.requestFocus();
1062 if (parentComponent instanceof JInternalFrame)
1064 JInternalFrame jif = (JInternalFrame) parentComponent;
1069 else if (parentComponent instanceof Window)
1071 Window w = (Window) parentComponent;
1076 joptionpane.setVisible(false);
1079 options_btns.add(jb);
1080 if (o.equals(initialValue))
1081 initialValue_btn = jb;
1084 joptionpane.setMessage(message);
1085 joptionpane.setMessageType(messageType);
1086 joptionpane.setOptionType(optionType);
1087 joptionpane.setIcon(icon);
1088 joptionpane.setOptions(
1089 Platform.isJS() ? options : options_btns.toArray());
1090 joptionpane.setInitialValue(
1091 Platform.isJS() ? initialValue : initialValue_btn);
1093 JDialog dialog = joptionpane.createDialog(parentComponent, title);
1094 dialog.setIconImages(ChannelProperties.getIconList());
1095 dialog.setModalityType(modal ? ModalityType.APPLICATION_MODAL
1096 : ModalityType.MODELESS);
1097 dialog.setDefaultCloseOperation(JDialog.DISPOSE_ON_CLOSE);
1098 dialog.setVisible(true);
1103 public void showInternalDialog(Object mainPanel, String title,
1104 int yesNoCancelOption, int questionMessage, Icon icon,
1105 Object[] options, String initresponse)
1107 if (!isInteractiveMode())
1109 handleResponse(getMockResponse());
1112 // need to set these separately so we can set the title bar icon later
1113 this.setOptionType(yesNoCancelOption);
1114 this.setMessageType(questionMessage);
1116 this.setInitialValue(initresponse);
1117 this.setOptions(options);
1118 this.setMessage(mainPanel);
1120 ourOptions = Arrays.asList(options);
1121 if (parentComponent != this
1122 && !(parentComponent == null && Desktop.instance == null))
1124 // note the parent goes back to a JRootPane so is probably
1125 // Desktop.getDesktop()
1126 JInternalFrame jif = this.createInternalFrame(
1127 parentComponent != null ? parentComponent : Desktop.instance,
1129 // connect to the alignFrame using a map in Desktop
1130 if (parentComponent instanceof AlignFrame)
1132 Desktop.addModal((AlignFrame) parentComponent, jif);
1134 jif.setFrameIcon(null);
1135 jif.addInternalFrameListener(new InternalFrameListener()
1138 public void internalFrameActivated(InternalFrameEvent arg0)
1143 public void internalFrameClosed(InternalFrameEvent arg0)
1145 JvOptionPane.this.internalDialogHandleResponse();
1149 public void internalFrameClosing(InternalFrameEvent arg0)
1154 public void internalFrameDeactivated(InternalFrameEvent arg0)
1159 public void internalFrameDeiconified(InternalFrameEvent arg0)
1164 public void internalFrameIconified(InternalFrameEvent arg0)
1169 public void internalFrameOpened(InternalFrameEvent arg0)
1173 jif.setVisible(true);
1179 JDialog dialog = this.createDialog(parentComponent, title);
1180 dialog.setIconImages(ChannelProperties.getIconList());
1181 dialog.setVisible(true); // blocking
1182 this.internalDialogHandleResponse();
1187 private void internalDialogHandleResponse()
1189 Object value = this.getValue();
1191 || (value instanceof Integer && (Integer) value == -1))
1195 String responseString = value.toString();
1196 int response = ourOptions.indexOf(responseString);
1198 if (!Platform.isJS())
1205 handleResponse(response);
1210 * @Override public JvOptionPane setResponseHandler(Object response, Runnable
1211 * action) { callbacks.put(response, new Callable<Void>() {
1213 * @Override public Void call() { action.run(); return null; } }); return this;
1217 public JvOptionPane setResponseHandler(Object response, Runnable action)
1221 action = NULLCALLABLE;
1223 callbacks.put(response, action);
1227 public void setDialog(JDialog d)
1232 public JDialog getDialog()
1238 * showDialogOnTop will create a dialog that (attempts to) come to top of OS
1241 public static int showDialogOnTop(String label, String actionString,
1242 int JOPTIONPANE_OPTION, int JOPTIONPANE_MESSAGETYPE)
1244 return showDialogOnTop(null, label, actionString, JOPTIONPANE_OPTION,
1245 JOPTIONPANE_MESSAGETYPE);
1248 public static int showDialogOnTop(Component dialogParentComponent,
1249 String label, String actionString, int JOPTIONPANE_OPTION,
1250 int JOPTIONPANE_MESSAGETYPE)
1252 if (!isInteractiveMode())
1254 return (int) getMockResponse();
1256 // Ensure Jalview window is brought to front (primarily for Quit
1257 // confirmation window to be visible)
1259 // This method of raising the Jalview window is broken in java
1260 // jalviewDesktop.setVisible(true);
1261 // jalviewDesktop.toFront();
1263 // A better hack which works is to create a new JFrame parent with
1264 // setAlwaysOnTop(true)
1265 JFrame dialogParent = new JFrame();
1266 if (dialogParentComponent == null)
1268 dialogParent.setIconImages(ChannelProperties.getIconList());
1269 dialogParent.setAlwaysOnTop(true);
1272 int answer = JOptionPane.showConfirmDialog(
1273 dialogParentComponent == null ? dialogParent
1274 : dialogParentComponent,
1275 label, actionString, JOPTIONPANE_OPTION,
1276 JOPTIONPANE_MESSAGETYPE);
1278 if (dialogParentComponent == null)
1280 dialogParent.setAlwaysOnTop(false);
1281 dialogParent.dispose();
1287 public void showDialogOnTopAsync(String label, String actionString,
1288 int JOPTIONPANE_OPTION, int JOPTIONPANE_MESSAGETYPE, Icon icon,
1289 Object[] options, Object initialValue, boolean modal)
1291 JFrame frame = new JFrame();
1292 frame.setIconImages(ChannelProperties.getIconList());
1293 showDialogOnTopAsync(frame, label, actionString, JOPTIONPANE_OPTION,
1294 JOPTIONPANE_MESSAGETYPE, icon, options, initialValue, modal);
1297 public void showDialogOnTopAsync(JFrame dialogParent, Object label,
1298 String actionString, int JOPTIONPANE_OPTION,
1299 int JOPTIONPANE_MESSAGETYPE, Icon icon, Object[] options,
1300 Object initialValue, boolean modal)
1302 showDialogOnTopAsync(dialogParent, label, actionString,
1303 JOPTIONPANE_OPTION, JOPTIONPANE_MESSAGETYPE, icon, options,
1304 initialValue, modal, null);
1307 public void showDialogOnTopAsync(JFrame dialogParent, Object label,
1308 String actionString, int JOPTIONPANE_OPTION,
1309 int JOPTIONPANE_MESSAGETYPE, Icon icon, Object[] options,
1310 Object initialValue, boolean modal, JButton[] buttons)
1312 showDialogOnTopAsync(dialogParent, label, actionString,
1313 JOPTIONPANE_OPTION, JOPTIONPANE_MESSAGETYPE, icon, options,
1314 initialValue, modal, buttons, true);
1317 public void showDialogOnTopAsync(JFrame dialogParent, Object label,
1318 String actionString, int JOPTIONPANE_OPTION,
1319 int JOPTIONPANE_MESSAGETYPE, Icon icon, Object[] options,
1320 Object initialValue, boolean modal, JButton[] buttons,
1323 if (!isInteractiveMode())
1325 handleResponse(getMockResponse());
1328 // Ensure Jalview window is brought to front (primarily for Quit
1329 // confirmation window to be visible)
1331 // This method of raising the Jalview window is broken in java
1332 // jalviewDesktop.setVisible(true);
1333 // jalviewDesktop.toFront();
1335 // A better hack which works is to create a new JFrame parent with
1336 // setAlwaysOnTop(true)
1337 boolean parentOnTop = dialogParent.isAlwaysOnTop();
1338 dialogParent.setAlwaysOnTop(true);
1339 parentComponent = dialogParent;
1341 showDialog(label, actionString, JOPTIONPANE_OPTION,
1342 JOPTIONPANE_MESSAGETYPE, icon, options, initialValue, modal,
1345 dialogParent.setAlwaysOnTop(parentOnTop);
1349 dialogParent.setAlwaysOnTop(false);
1350 dialogParent.dispose();
1355 * JalviewJS signals option selection by a property change event for the
1356 * option e.g. "OK". This methods responds to that by running the response
1357 * action that corresponds to that option.
1362 public void propertyChange(PropertyChangeEvent evt)
1364 Object newValue = evt.getNewValue();
1365 int ourOption = ourOptions.indexOf(newValue);
1368 handleResponse(ourOption);
1373 handleResponse(newValue);
1378 public void handleResponse(Object response)
1381 * this test is for NaN in Chrome
1383 if (response != null && !response.equals(response))
1387 Runnable action = callbacks.get(response);
1392 new Thread(action).start();
1394 } catch (Exception e)
1396 e.printStackTrace();
1398 if (parentComponent != null)
1399 parentComponent.requestFocus();
1404 * Create a non-modal confirm dialog
1406 public JDialog createDialog(Component parentComponent, Object message,
1407 String title, int optionType, int messageType, Icon icon,
1408 Object[] options, Object initialValue, boolean modal)
1410 return createDialog(parentComponent, message, title, optionType,
1411 messageType, icon, options, initialValue, modal, null);
1414 public JDialog createDialog(Component parentComponent, Object message,
1415 String title, int optionType, int messageType, Icon icon,
1416 Object[] options, Object initialValue, boolean modal,
1419 if (!isInteractiveMode())
1421 handleResponse(getMockResponse());
1424 JButton[] optionsButtons = null;
1425 Object initialValueButton = null;
1426 JOptionPane joptionpane = new JOptionPane();
1427 // Make button options
1428 int[] buttonActions = { JOptionPane.YES_OPTION, JOptionPane.NO_OPTION,
1429 JOptionPane.CANCEL_OPTION };
1431 // we need the strings to make the buttons with actionEventListener
1432 if (options == null)
1434 ArrayList<String> options_default = new ArrayList<>();
1435 options_default.add(UIManager.getString("OptionPane.yesButtonText"));
1436 if (optionType == JOptionPane.YES_NO_OPTION
1437 || optionType == JOptionPane.YES_NO_CANCEL_OPTION)
1439 options_default.add(UIManager.getString("OptionPane.noButtonText"));
1441 if (optionType == JOptionPane.YES_NO_CANCEL_OPTION)
1444 .add(UIManager.getString("OptionPane.cancelButtonText"));
1446 options = options_default.toArray();
1448 if (!Platform.isJS()) // JalviewJS already uses callback, don't need to
1451 if (((optionType == JOptionPane.YES_OPTION
1452 || optionType == JOptionPane.NO_OPTION
1453 || optionType == JOptionPane.CANCEL_OPTION
1454 || optionType == JOptionPane.OK_OPTION
1455 || optionType == JOptionPane.DEFAULT_OPTION)
1456 && options.length < 1)
1457 || ((optionType == JOptionPane.YES_NO_OPTION
1458 || optionType == JOptionPane.OK_CANCEL_OPTION)
1459 && options.length < 2)
1460 || (optionType == JOptionPane.YES_NO_CANCEL_OPTION
1461 && options.length < 3))
1464 .debug("JvOptionPane: not enough options for dialog type");
1466 optionsButtons = new JButton[options.length];
1467 for (int i = 0; i < options.length && i < 3; i++)
1469 Object o = options[i];
1470 int buttonAction = buttonActions[i];
1471 Runnable action = callbacks.get(buttonAction);
1473 if (buttons != null && buttons.length > i && buttons[i] != null)
1481 jb.setText((String) o);
1482 jb.addActionListener(new ActionListener()
1485 public void actionPerformed(ActionEvent e)
1487 joptionpane.setValue(buttonAction);
1489 new Thread(action).start();
1490 // joptionpane.transferFocusBackward();
1491 joptionpane.transferFocusBackward();
1492 joptionpane.setVisible(false);
1493 // put focus and raise parent window if possible, unless cancel
1495 boolean raiseParent = (parentComponent != null);
1496 if (buttonAction == JOptionPane.CANCEL_OPTION)
1497 raiseParent = false;
1498 if (optionType == JOptionPane.YES_NO_OPTION
1499 && buttonAction == JOptionPane.NO_OPTION)
1500 raiseParent = false;
1503 parentComponent.requestFocus();
1504 if (parentComponent instanceof JInternalFrame)
1506 JInternalFrame jif = (JInternalFrame) parentComponent;
1511 else if (parentComponent instanceof Window)
1513 Window w = (Window) parentComponent;
1518 joptionpane.setVisible(false);
1521 optionsButtons[i] = jb;
1522 if (o.equals(initialValue))
1523 initialValueButton = jb;
1526 joptionpane.setMessage(message);
1527 joptionpane.setMessageType(messageType);
1528 joptionpane.setOptionType(optionType);
1529 joptionpane.setIcon(icon);
1530 joptionpane.setOptions(Platform.isJS() ? options : optionsButtons);
1531 joptionpane.setInitialValue(
1532 Platform.isJS() ? initialValue : initialValueButton);
1534 JDialog dialog = joptionpane.createDialog(parentComponent, title);
1535 dialog.setIconImages(ChannelProperties.getIconList());
1536 dialog.setModalityType(
1537 modal ? ModalityType.APPLICATION_MODAL : ModalityType.MODELESS);
1538 dialog.setDefaultCloseOperation(JDialog.DISPOSE_ON_CLOSE);
1544 * Utility to programmatically click a button on a JOptionPane (as a JFrame)
1546 * returns true if button was found
1548 public static boolean clickButton(JFrame frame, int buttonType)
1555 * This helper method makes the JInternalFrame wait until it is notified by an
1556 * InternalFrameClosing event. This method also adds the given JOptionPane to
1557 * the JInternalFrame and sizes it according to the JInternalFrame's preferred
1561 * The JInternalFrame to make modal.
1563 private static void startModal(JInternalFrame f)
1565 // We need to add an additional glasspane-like component directly
1566 // below the frame, which intercepts all mouse events that are not
1567 // directed at the frame itself.
1568 JPanel modalInterceptor = new JPanel();
1569 modalInterceptor.setOpaque(false);
1570 JLayeredPane lp = JLayeredPane.getLayeredPaneAbove(f);
1571 lp.setLayer(modalInterceptor, JLayeredPane.MODAL_LAYER.intValue());
1572 modalInterceptor.setBounds(0, 0, lp.getWidth(), lp.getHeight());
1573 modalInterceptor.addMouseListener(new MouseAdapter()
1576 modalInterceptor.addMouseMotionListener(new MouseMotionAdapter()
1579 lp.add(modalInterceptor);
1582 // disable the main menu bar if in Linux
1583 JMenuBar menubar = null;
1584 if (Platform.isLinux())
1586 JRootPane rootpane = Desktop.getDesktop().getRootPane();
1587 menubar = rootpane.getJMenuBar();
1590 // We need to explicitly dispatch events when we are blocking the event
1592 EventQueue queue = Toolkit.getDefaultToolkit().getSystemEventQueue();
1595 if (menubar != null)
1597 // don't allow clicks on main menu on linux due to a hanging bug.
1599 setMenusEnabled(menubar, false);
1602 while (!f.isClosed())
1604 if (EventQueue.isDispatchThread())
1606 // The getNextEventMethod() issues wait() when no
1607 // event is available, so we don't need do explicitly wait().
1608 AWTEvent ev = queue.getNextEvent();
1609 // This mimics EventQueue.dispatchEvent(). We can't use
1610 // EventQueue.dispatchEvent() directly, because it is
1611 // protected, unfortunately.
1612 if (ev instanceof ActiveEvent)
1614 ((ActiveEvent) ev).dispatch();
1616 else if (ev instanceof KeyEvent && ((KeyEvent) ev).isControlDown()
1619 // temporarily enable menus to send Ctrl+? KeyEvents
1620 setMenusEnabled(menubar, true);
1621 ((Component) ev.getSource()).dispatchEvent(ev);
1622 setMenusEnabled(menubar, false);
1624 else if (ev.getSource() instanceof MenuComponent)
1626 ((MenuComponent) ev.getSource()).dispatchEvent(ev);
1628 else if (ev.getSource() instanceof Component)
1630 ((Component) ev.getSource()).dispatchEvent(ev);
1632 // Other events are ignored as per spec in
1633 // EventQueue.dispatchEvent
1637 // Give other threads a chance to become active.
1641 } catch (InterruptedException ex)
1643 // If we get interrupted, then leave the modal state.
1646 // re-enable the main menu bar
1647 if (menubar != null)
1649 setMenusEnabled(menubar, true);
1652 // Clean up the modal interceptor.
1653 lp.remove(modalInterceptor);
1655 // unpaint the frame
1656 f.setVisible(false);
1662 } catch (PropertyVetoException e)
1664 f.doDefaultCloseAction();
1667 // Remove the internal frame from its parent, so it is no longer
1668 // lurking around and clogging memory.
1669 Container parent = f.getParent();
1677 public static JvOptionPane frameDialog(Object message, String title,
1678 int messageType, String[] buttonsTextS, String defaultButtonS,
1679 List<Runnable> handlers, boolean modal)
1681 JFrame parent = new JFrame();
1682 JvOptionPane jvop = JvOptionPane.newOptionDialog();
1683 final String[] buttonsText;
1684 final String defaultButton;
1685 if (buttonsTextS == null)
1687 String ok = MessageManager.getString("action.ok");
1688 buttonsText = new String[] { ok };
1693 buttonsText = buttonsTextS;
1694 defaultButton = defaultButtonS;
1696 JButton[] buttons = new JButton[buttonsText.length];
1697 for (int i = 0; i < buttonsText.length; i++)
1699 buttons[i] = new JButton();
1700 buttons[i].setText(buttonsText[i]);
1701 Console.debug("DISABLING BUTTON " + buttons[i].getText());
1702 buttons[i].setEnabled(false);
1703 buttons[i].setVisible(false);
1706 int dialogType = -1;
1707 if (buttonsText.length == 1)
1709 dialogType = JOptionPane.OK_OPTION;
1711 else if (buttonsText.length == 2)
1713 dialogType = JOptionPane.YES_NO_OPTION;
1717 dialogType = JOptionPane.YES_NO_CANCEL_OPTION;
1719 jvop.setResponseHandler(JOptionPane.YES_OPTION,
1720 (handlers != null && handlers.size() > 0) ? handlers.get(0)
1722 if (dialogType == JOptionPane.YES_NO_OPTION
1723 || dialogType == JOptionPane.YES_NO_CANCEL_OPTION)
1725 jvop.setResponseHandler(JOptionPane.NO_OPTION,
1726 (handlers != null && handlers.size() > 1) ? handlers.get(1)
1729 if (dialogType == JOptionPane.YES_NO_CANCEL_OPTION)
1731 jvop.setResponseHandler(JOptionPane.CANCEL_OPTION,
1732 (handlers != null && handlers.size() > 2) ? handlers.get(2)
1736 final int dt = dialogType;
1738 jvop.showDialog(message, title, dt, messageType, null, buttonsText,
1739 defaultButton, modal, buttons);
1745 private static void setMenusEnabled(JMenuBar menubar, boolean b)
1747 for (int i = 0; i < menubar.getMenuCount(); i++)
1749 JMenu menu = menubar.getMenu(i);