X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FUserDefinedColours.java;h=b1f6d1b8d194996f65d9ccf41e787546707c0362;hb=9cd96dd3e43ae32814fa8c62df274ff9224bfdbc;hp=369dde67928ad52d6563b89d71672f4a4cf8a6b5;hpb=8e9cee1be3194bacb353d94a2166fff1afe8029b;p=jalview.git diff --git a/src/jalview/gui/UserDefinedColours.java b/src/jalview/gui/UserDefinedColours.java index 369dde6..b1f6d1b 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,9 @@ import jalview.schemes.UserColourScheme; import jalview.util.ColorUtils; import jalview.util.Format; import jalview.util.MessageManager; +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 +52,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,11 +62,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); + private static final Font VERDANA_BOLD_10 = new Font("Verdana", Font.BOLD, + 10); public static final String USER_DEFINED_COLOURS = "USER_DEFINED_COLOURS"; @@ -77,8 +80,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 changed; + JInternalFrame frame; List upperCaseButtons; @@ -103,7 +116,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 +139,7 @@ public class UserDefinedColours extends GUserDefinedColours implements UserDefinedColours() { super(); - selectedButtons = new ArrayList(); + selectedButtons = new ArrayList<>(); } void showFrame() @@ -152,7 +166,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 +197,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 +253,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 +263,8 @@ public class UserDefinedColours extends GUserDefinedColours implements button.setBackground(newColour); button.setForeground(ColorUtils.brighterThan(newColour)); } + + changed = true; } /** @@ -309,8 +326,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 +340,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 +349,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 +447,25 @@ public class UserDefinedColours extends GUserDefinedColours implements { if (isNoSelectionMade()) { - JvOptionPane.showMessageDialog(Desktop.desktop, MessageManager - .getString("label.no_colour_selection_in_scheme"), + JvOptionPane.showMessageDialog(Desktop.desktop, + 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 +476,57 @@ 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() + { + if (!changed) + { + return; + } + + 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.desktop, + question, title, JvOptionPane.DEFAULT_OPTION, + JvOptionPane.PLAIN_MESSAGE, null, options, options[0]); + + boolean saved = false; + if (response == 0) + { + /* + * prompt to save changes to file + */ + saved = 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 (!saved) + { + /* + * 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 +551,9 @@ public class UserDefinedColours extends GUserDefinedColours implements { if (isNoSelectionMade()) { - JvOptionPane.showMessageDialog(Desktop.desktop, MessageManager - .getString("label.no_colour_selection_in_scheme"), + JvOptionPane.showMessageDialog(Desktop.desktop, + MessageManager + .getString("label.no_colour_selection_in_scheme"), MessageManager.getString("label.no_colour_selection_warn"), JvOptionPane.WARNING_MESSAGE); @@ -553,14 +634,14 @@ 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); @@ -572,8 +653,8 @@ public class UserDefinedColours extends GUserDefinedColours implements File choice = chooser.getSelectedFile(); Cache.setProperty(LAST_DIRECTORY, choice.getParent()); - UserColourScheme ucs = ColourSchemeLoader.loadColourScheme(choice - .getAbsolutePath()); + UserColourScheme ucs = ColourSchemeLoader + .loadColourScheme(choice.getAbsolutePath()); Color[] colors = ucs.getColours(); schemeName.setText(ucs.getSchemeName()); @@ -640,35 +721,40 @@ 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
    • * + * Returns true if the scheme is saved to file, false if it is not + * + * @return */ @Override - protected void savebutton_actionPerformed() + protected boolean savebutton_actionPerformed() { 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.desktop, + MessageManager + .getString("label.user_colour_scheme_must_have_name"), MessageManager.getString("label.no_name_colour_scheme"), JvOptionPane.WARNING_MESSAGE); - return; + return false; } if (ColourSchemes.getInstance().nameExists(name)) { int reply = JvOptionPane.showInternalConfirmDialog(Desktop.desktop, MessageManager.formatMessage( - "label.colour_scheme_exists_overwrite", new Object[] { - name, name }), + "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; + return false; } } JalviewFileChooser chooser = new JalviewFileChooser("jc", @@ -676,28 +762,34 @@ public class UserDefinedColours extends GUserDefinedColours implements 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) + if (value != JalviewFileChooser.APPROVE_OPTION) { - File file = chooser.getSelectedFile(); - addNewColourScheme(file.getPath()); - saveToFile(file); + return false; + } - /* - * changes saved - apply to alignment if we are changing - * the currently selected colour scheme - */ - if (oldColourScheme != null - && name.equals(oldColourScheme.getSchemeName())) - { - applyButton_actionPerformed(); - } + File file = chooser.getSelectedFile(); + UserColourScheme updatedScheme = addNewColourScheme(file.getPath()); + saveToFile(file); + changed = false; + + /* + * changes saved - apply to alignment if we are changing + * the currently selected colour scheme; also make the updated + * colours the 'backout' scheme on Cancel + */ + if (oldColourScheme != null + && name.equals(oldColourScheme.getSchemeName())) + { + oldColourScheme = updatedScheme; + applyButton_actionPerformed(); } + return true; } /** @@ -707,15 +799,16 @@ public class UserDefinedColours extends GUserDefinedColours implements * the colour scheme. * * @param filePath + * @return */ - protected void addNewColourScheme(String filePath) + protected UserColourScheme addNewColourScheme(String filePath) { /* * 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(USER_DEFINED_COLOURS, + filePath); if (defaultColours.indexOf(filePath) == -1) { if (defaultColours.length() > 0) @@ -739,6 +832,8 @@ public class UserDefinedColours extends GUserDefinedColours implements { ap.alignFrame.buildColourMenu(); } + + return ucs; } /** @@ -766,9 +861,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) { @@ -784,7 +884,7 @@ public class UserDefinedColours extends GUserDefinedColours implements protected void cancelButton_actionPerformed() { ap.alignFrame.changeColour(oldColourScheme); - ap.paintAlignment(true); + ap.paintAlignment(true, true); try {