X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FUserDefinedColours.java;h=6e3a68be104ad7bed96110cb40e435c82a587d07;hb=2b08c849bd54a0799ddf251f602a421d4696005e;hp=0187aa3a3790b4c9b6e0ec435d409e7d714934d9;hpb=33984e02c5687dc011d13da4b17cb0815970e0f5;p=jalview.git diff --git a/src/jalview/gui/UserDefinedColours.java b/src/jalview/gui/UserDefinedColours.java index 0187aa3..6e3a68b 100755 --- a/src/jalview/gui/UserDefinedColours.java +++ b/src/jalview/gui/UserDefinedColours.java @@ -24,8 +24,6 @@ import jalview.bin.Cache; import jalview.io.JalviewFileChooser; import jalview.io.JalviewFileView; import jalview.jbgui.GUserDefinedColours; -import jalview.schemabinding.version2.Colour; -import jalview.schemabinding.version2.JalviewUserColours; import jalview.schemes.ColourSchemeI; import jalview.schemes.ColourSchemeLoader; import jalview.schemes.ColourSchemes; @@ -34,6 +32,10 @@ import jalview.schemes.UserColourScheme; import jalview.util.ColorUtils; import jalview.util.Format; import jalview.util.MessageManager; +import jalview.util.Platform; +import jalview.xml.binding.jalview.JalviewUserColours; +import jalview.xml.binding.jalview.JalviewUserColours.Colour; +import jalview.xml.binding.jalview.ObjectFactory; import java.awt.Color; import java.awt.Font; @@ -51,6 +53,8 @@ import javax.swing.JButton; import javax.swing.JInternalFrame; import javax.swing.event.ChangeEvent; import javax.swing.event.ChangeListener; +import javax.xml.bind.JAXBContext; +import javax.xml.bind.Marshaller; /** * This panel allows the user to assign colours to Amino Acid residue codes, and @@ -59,13 +63,11 @@ import javax.swing.event.ChangeListener; * @author Andrew Waterhouse * @author Mungo Carstairs */ -public class UserDefinedColours extends GUserDefinedColours implements - ChangeListener +public class UserDefinedColours extends GUserDefinedColours + implements ChangeListener { - private static final Font VERDANA_BOLD_10 = new Font("Verdana", - Font.BOLD, 10); - - public static final String USER_DEFINED_COLOURS = "USER_DEFINED_COLOURS"; + private static final Font VERDANA_BOLD_10 = new Font("Verdana", Font.BOLD, + 10); private static final String LAST_DIRECTORY = "LAST_DIRECTORY"; @@ -77,8 +79,18 @@ public class UserDefinedColours extends GUserDefinedColours implements AlignmentPanel ap; + /* + * the colour scheme when the dialog was opened, or + * the scheme last saved to file + */ ColourSchemeI oldColourScheme; + /* + * flag is true if the colour scheme has been changed since the + * dialog was opened, or the changes last saved to file + */ + boolean changedButNotSaved; + JInternalFrame frame; List upperCaseButtons; @@ -103,7 +115,8 @@ public class UserDefinedColours extends GUserDefinedColours implements if (oldColourScheme instanceof UserColourScheme) { schemeName.setText(oldColourScheme.getSchemeName()); - if (((UserColourScheme) oldColourScheme).getLowerCaseColours() != null) + if (((UserColourScheme) oldColourScheme) + .getLowerCaseColours() != null) { caseSensitive.setSelected(true); lcaseColour.setEnabled(true); @@ -125,7 +138,7 @@ public class UserDefinedColours extends GUserDefinedColours implements UserDefinedColours() { super(); - selectedButtons = new ArrayList(); + selectedButtons = new ArrayList<>(); } void showFrame() @@ -152,7 +165,7 @@ public class UserDefinedColours extends GUserDefinedColours implements if (upperCaseButtons == null) { - upperCaseButtons = new ArrayList(); + upperCaseButtons = new ArrayList<>(); } for (int i = 0; i < 20; i++) @@ -183,7 +196,7 @@ public class UserDefinedColours extends GUserDefinedColours implements if (lowerCaseButtons == null) { - lowerCaseButtons = new ArrayList(); + lowerCaseButtons = new ArrayList<>(); } for (int i = 0; i < 20; i++) @@ -239,7 +252,8 @@ public class UserDefinedColours extends GUserDefinedColours implements { button = lowerCaseButtons.get(i); button.setBackground(newColour); - button.setForeground(ColorUtils.brighterThan(button.getBackground())); + button.setForeground( + ColorUtils.brighterThan(button.getBackground())); } } for (int i = 0; i < selectedButtons.size(); i++) @@ -248,6 +262,8 @@ public class UserDefinedColours extends GUserDefinedColours implements button.setBackground(newColour); button.setForeground(ColorUtils.brighterThan(newColour)); } + + changedButNotSaved = true; } /** @@ -309,8 +325,8 @@ public class UserDefinedColours extends GUserDefinedColours implements JButton button = (JButton) buttonPanel.getComponent(b); if (!selectedButtons.contains(button)) { - button.setForeground(ColorUtils.brighterThan(button - .getBackground())); + button.setForeground( + ColorUtils.brighterThan(button.getBackground())); selectedButtons.add(button); } } @@ -323,7 +339,8 @@ public class UserDefinedColours extends GUserDefinedColours implements button.setForeground(ColorUtils.darkerThan(button.getBackground())); } selectedButtons.clear(); - pressed.setForeground(ColorUtils.brighterThan(pressed.getBackground())); + pressed.setForeground( + ColorUtils.brighterThan(pressed.getBackground())); selectedButtons.add(pressed); } @@ -331,13 +348,14 @@ public class UserDefinedColours extends GUserDefinedColours implements { if (selectedButtons.contains(pressed)) { - pressed.setForeground(ColorUtils.darkerThan(pressed.getBackground())); + pressed.setForeground( + ColorUtils.darkerThan(pressed.getBackground())); selectedButtons.remove(pressed); } else { - pressed.setForeground(ColorUtils.brighterThan(pressed - .getBackground())); + pressed.setForeground( + ColorUtils.brighterThan(pressed.getBackground())); selectedButtons.add(pressed); } } @@ -428,15 +446,25 @@ public class UserDefinedColours extends GUserDefinedColours implements { if (isNoSelectionMade()) { - JvOptionPane.showMessageDialog(Desktop.desktop, MessageManager - .getString("label.no_colour_selection_in_scheme"), + JvOptionPane.showMessageDialog(Desktop.getDesktopPane(), + MessageManager + .getString("label.no_colour_selection_in_scheme"), MessageManager.getString("label.no_colour_selection_warn"), JvOptionPane.WARNING_MESSAGE); } else { + /* + * OK is treated as 'apply colours and close' + */ applyButton_actionPerformed(); + /* + * If editing a named colour scheme, warn if changes + * have not been saved + */ + warnIfUnsavedChanges(); + try { frame.setClosed(true); @@ -447,6 +475,62 @@ public class UserDefinedColours extends GUserDefinedColours implements } /** + * If we have made changes to an existing user defined colour scheme but not + * saved them, show a dialog with the option to save. If the user chooses to + * save, do so, else clear the colour scheme name to indicate a new colour + * scheme. + */ + protected void warnIfUnsavedChanges() + { + // BH 2018 no warning in JavaScript TODO + + if (!Platform.isJS() && changedButNotSaved) + /** + * Java only + * + * @j2sIgnore + */ + { + String name = schemeName.getText().trim(); + if (oldColourScheme != null && !"".equals(name) + && name.equals(oldColourScheme.getSchemeName())) + { + String message = MessageManager + .formatMessage("label.scheme_changed", name); + String title = MessageManager.getString("label.save_changes"); + String[] options = new String[] { title, + MessageManager.getString("label.dont_save_changes"), }; + final String question = JvSwingUtils.wrapTooltip(true, message); + int response = JvOptionPane.showOptionDialog(Desktop.getDesktopPane(), + question, title, JvOptionPane.DEFAULT_OPTION, + JvOptionPane.PLAIN_MESSAGE, null, options, options[0]); + + if (response == 0) + { + /* + * prompt to save changes to file; if done, + * resets 'changed' flag to false + */ + savebutton_actionPerformed(); + } + + /* + * if user chooses not to save (either in this dialog or in the + * save as dialogs), treat this as a new user defined colour scheme + */ + if (changedButNotSaved) + { + /* + * clear scheme name and re-apply as an anonymous scheme + */ + schemeName.setText(""); + applyButton_actionPerformed(); + } + } + } + } + + /** * Returns true if the user has not made any colour selection (including if * 'case-sensitive' selected and no lower-case colour chosen). * @@ -471,8 +555,9 @@ public class UserDefinedColours extends GUserDefinedColours implements { if (isNoSelectionMade()) { - JvOptionPane.showMessageDialog(Desktop.desktop, MessageManager - .getString("label.no_colour_selection_in_scheme"), + JvOptionPane.showMessageDialog(Desktop.getDesktopPane(), + MessageManager + .getString("label.no_colour_selection_in_scheme"), MessageManager.getString("label.no_colour_selection_warn"), JvOptionPane.WARNING_MESSAGE); @@ -553,60 +638,61 @@ public class UserDefinedColours extends GUserDefinedColours implements @Override protected void loadbutton_actionPerformed() { - upperCaseButtons = new ArrayList(); - lowerCaseButtons = new ArrayList(); - + upperCaseButtons = new ArrayList<>(); + lowerCaseButtons = new ArrayList<>(); JalviewFileChooser chooser = new JalviewFileChooser("jc", "Jalview User Colours"); chooser.setFileView(new JalviewFileView()); - chooser.setDialogTitle(MessageManager - .getString("label.load_colour_scheme")); + chooser.setDialogTitle( + MessageManager.getString("label.load_colour_scheme")); chooser.setToolTipText(MessageManager.getString("action.load")); - - int value = chooser.showOpenDialog(this); - - if (value != JalviewFileChooser.APPROVE_OPTION) - { - return; - } - File choice = chooser.getSelectedFile(); - Cache.setProperty(LAST_DIRECTORY, choice.getParent()); - - UserColourScheme ucs = ColourSchemeLoader.loadColourScheme(choice - .getAbsolutePath()); - Color[] colors = ucs.getColours(); - schemeName.setText(ucs.getSchemeName()); - - if (ucs.getLowerCaseColours() != null) - { - caseSensitive.setSelected(true); - lcaseColour.setEnabled(true); - resetButtonPanel(true); - for (int i = 0; i < lowerCaseButtons.size(); i++) - { - JButton button = lowerCaseButtons.get(i); - button.setBackground(ucs.getLowerCaseColours()[i]); - } - } - else - { - caseSensitive.setSelected(false); - lcaseColour.setEnabled(false); - resetButtonPanel(false); - } - - for (int i = 0; i < upperCaseButtons.size(); i++) - { - JButton button = upperCaseButtons.get(i); - button.setBackground(colors[i]); - } - - addNewColourScheme(choice.getPath()); + chooser.setResponseHandler(0, new Runnable() + { + @Override + public void run() + { + File choice = chooser.getSelectedFile(); + Cache.setProperty(LAST_DIRECTORY, choice.getParent()); + + UserColourScheme ucs = ColourSchemeLoader + .loadColourScheme(choice.getAbsolutePath()); + Color[] colors = ucs.getColours(); + schemeName.setText(ucs.getSchemeName()); + + if (ucs.getLowerCaseColours() != null) + { + caseSensitive.setSelected(true); + lcaseColour.setEnabled(true); + resetButtonPanel(true); + for (int i = 0; i < lowerCaseButtons.size(); i++) + { + JButton button = lowerCaseButtons.get(i); + button.setBackground(ucs.getLowerCaseColours()[i]); + } + } + else + { + caseSensitive.setSelected(false); + lcaseColour.setEnabled(false); + resetButtonPanel(false); + } + + for (int i = 0; i < upperCaseButtons.size(); i++) + { + JButton button = upperCaseButtons.get(i); + button.setBackground(colors[i]); + } + + addNewColourScheme(choice.getPath()); + } + }); + + chooser.showOpenDialog(this); } /** * Loads the user-defined colour scheme from the first file listed in property - * "USER_DEFINED_COLOURS". If this fails, returns an all-white colour scheme. + * Preferences.USER_DEFINED_COLOURS. If this fails, returns an all-white colour scheme. * * @return */ @@ -614,7 +700,7 @@ public class UserDefinedColours extends GUserDefinedColours implements { UserColourScheme ret = null; - String colours = Cache.getProperty(USER_DEFINED_COLOURS); + String colours = Cache.getProperty(Preferences.USER_DEFINED_COLOURS); if (colours != null) { if (colours.indexOf("|") > -1) @@ -640,10 +726,12 @@ public class UserDefinedColours extends GUserDefinedColours implements * name if overwriting *
  • Do the standard file chooser thing to write with extension .jc
    • *
  • If saving changes (possibly not yet applied) to the currently selected - * colour scheme, then apply the changes, as it is too late to back out now
    • + * colour scheme, then apply the changes, as it is too late to back out + * now *
  • Don't apply the changes if the currently selected scheme is different, * to allow a new scheme to be configured and saved but not applied
    • * + * If the scheme is saved to file, the 'changed' flag field is reset to false. */ @Override protected void savebutton_actionPerformed() @@ -651,42 +739,49 @@ public class UserDefinedColours extends GUserDefinedColours implements String name = schemeName.getText().trim(); if (name.length() < 1) { - JvOptionPane.showInternalMessageDialog(Desktop.desktop, MessageManager - .getString("label.user_colour_scheme_must_have_name"), + JvOptionPane.showInternalMessageDialog(Desktop.getDesktopPane(), + MessageManager + .getString("label.user_colour_scheme_must_have_name"), MessageManager.getString("label.no_name_colour_scheme"), JvOptionPane.WARNING_MESSAGE); - return; } - if (ColourSchemes.getInstance().nameExists(name)) + if (!Platform.isJS() && ColourSchemes.getInstance().nameExists(name)) { - int reply = JvOptionPane.showInternalConfirmDialog(Desktop.desktop, - MessageManager.formatMessage( - "label.colour_scheme_exists_overwrite", new Object[] { - name, name }), - MessageManager.getString("label.duplicate_scheme_name"), - JvOptionPane.YES_NO_OPTION); - if (reply != JvOptionPane.YES_OPTION) + /** + * java only + * + * @j2sIgnore + */ { - return; + int reply = JvOptionPane.showInternalConfirmDialog(Desktop.getDesktopPane(), + MessageManager.formatMessage( + "label.colour_scheme_exists_overwrite", new Object[] + { name, name }), + MessageManager.getString("label.duplicate_scheme_name"), + JvOptionPane.YES_NO_OPTION); + if (reply != JvOptionPane.YES_OPTION) + { + return; + } } } + JalviewFileChooser chooser = new JalviewFileChooser("jc", "Jalview User Colours"); JalviewFileView fileView = new JalviewFileView(); chooser.setFileView(fileView); - chooser.setDialogTitle(MessageManager - .getString("label.save_colour_scheme")); + chooser.setDialogTitle( + MessageManager.getString("label.save_colour_scheme")); chooser.setToolTipText(MessageManager.getString("action.save")); - - int value = chooser.showSaveDialog(this); - - if (value == JalviewFileChooser.APPROVE_OPTION) + int option = chooser.showSaveDialog(this); + if (option == JalviewFileChooser.APPROVE_OPTION) { File file = chooser.getSelectedFile(); UserColourScheme updatedScheme = addNewColourScheme(file.getPath()); saveToFile(file); + changedButNotSaved = false; /* * changes saved - apply to alignment if we are changing @@ -717,8 +812,9 @@ public class UserDefinedColours extends GUserDefinedColours implements * update the delimited list of user defined colour files in * Jalview property USER_DEFINED_COLOURS */ - String defaultColours = Cache - .getDefault(USER_DEFINED_COLOURS, filePath); + String defaultColours = Cache.getDefault( + Preferences.USER_DEFINED_COLOURS, + filePath); if (defaultColours.indexOf(filePath) == -1) { if (defaultColours.length() > 0) @@ -727,7 +823,7 @@ public class UserDefinedColours extends GUserDefinedColours implements } defaultColours = defaultColours.concat(filePath); } - Cache.setProperty(USER_DEFINED_COLOURS, defaultColours); + Cache.setProperty(Preferences.USER_DEFINED_COLOURS, defaultColours); /* * construct and register the colour scheme @@ -771,9 +867,14 @@ public class UserDefinedColours extends GUserDefinedColours implements Colour col = new Colour(); col.setName(button.getText()); col.setRGB(Format.getHexString(button.getBackground())); - ucs.addColour(col); + ucs.getColour().add(col); } - ucs.marshal(out); + JAXBContext jaxbContext = JAXBContext + .newInstance(JalviewUserColours.class); + Marshaller jaxbMarshaller = jaxbContext.createMarshaller(); + jaxbMarshaller.marshal( + new ObjectFactory().createJalviewUserColours(ucs), out); + // ucs.marshal(out); out.close(); } catch (Exception ex) { @@ -789,7 +890,7 @@ public class UserDefinedColours extends GUserDefinedColours implements protected void cancelButton_actionPerformed() { ap.alignFrame.changeColour(oldColourScheme); - ap.paintAlignment(true); + ap.paintAlignment(true, true); try {