X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FUserDefinedColours.java;h=89ddf87b24294c1f9a6ef00a2d00de4bfba53e65;hb=7534e6f358b2bba0db179cb2f496bd2e5a4da43d;hp=012edb6ea8a09836b499ff019e80a15b36ce34b7;hpb=8b55eedb9d76a8c65b80f756c4412bf029906bf7;p=jalview.git diff --git a/src/jalview/gui/UserDefinedColours.java b/src/jalview/gui/UserDefinedColours.java index 012edb6..89ddf87 100755 --- a/src/jalview/gui/UserDefinedColours.java +++ b/src/jalview/gui/UserDefinedColours.java @@ -20,15 +20,14 @@ */ package jalview.gui; -import jalview.api.structures.JalviewStructureDisplayI; import jalview.bin.Cache; -import jalview.datamodel.SequenceGroup; 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; import jalview.schemes.ResidueProperties; import jalview.schemes.UserColourScheme; @@ -39,7 +38,6 @@ import jalview.util.MessageManager; import java.awt.Color; import java.awt.Font; import java.awt.Insets; -import java.awt.event.ActionEvent; import java.awt.event.MouseAdapter; import java.awt.event.MouseEvent; import java.io.File; @@ -61,16 +59,17 @@ 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"; private static final String LAST_DIRECTORY = "LAST_DIRECTORY"; - private static final int MY_FRAME_HEIGHT = 420; + private static final int MY_FRAME_HEIGHT = 440; private static final int MY_FRAME_WIDTH = 810; @@ -78,48 +77,44 @@ public class UserDefinedColours extends GUserDefinedColours implements AlignmentPanel ap; - SequenceGroup seqGroup; - - List selectedButtons; - + /* + * the colour scheme when the dialog was opened, or + * the scheme last saved to file + */ ColourSchemeI oldColourScheme; - JInternalFrame frame; + /* + * flag is true if the colour scheme has been changed since the + * dialog was opened, or the changes last saved to file + */ + boolean changed; - JalviewStructureDisplayI structureViewer; + JInternalFrame frame; List upperCaseButtons; List lowerCaseButtons; /** - * Creates a new UserDefinedColours object. + * Creates and displays a new UserDefinedColours panel * - * @param ap - * @param sg + * @param alignPanel */ - public UserDefinedColours(AlignmentPanel ap, SequenceGroup sg) + public UserDefinedColours(AlignmentPanel alignPanel) { - super(); + this(); lcaseColour.setEnabled(false); - this.ap = ap; - seqGroup = sg; + this.ap = alignPanel; - if (seqGroup != null) - { - oldColourScheme = seqGroup.cs; - } - else - { - oldColourScheme = ap.av.getGlobalColourScheme(); - } + oldColourScheme = alignPanel.av.getGlobalColourScheme(); if (oldColourScheme instanceof UserColourScheme) { schemeName.setText(oldColourScheme.getSchemeName()); - if (((UserColourScheme) oldColourScheme).getLowerCaseColours() != null) + if (((UserColourScheme) oldColourScheme) + .getLowerCaseColours() != null) { caseSensitive.setSelected(true); lcaseColour.setEnabled(true); @@ -138,25 +133,10 @@ public class UserDefinedColours extends GUserDefinedColours implements showFrame(); } - public UserDefinedColours(JalviewStructureDisplayI viewer, - ColourSchemeI oldcs) + UserDefinedColours() { super(); - this.structureViewer = viewer; - - colorChooser.getSelectionModel().addChangeListener(this); - - oldColourScheme = oldcs; - - if (oldColourScheme instanceof UserColourScheme) - { - schemeName.setText(((UserColourScheme) oldColourScheme).getSchemeName()); - } - - resetButtonPanel(false); - - showFrame(); - + selectedButtons = new ArrayList<>(); } void showFrame() @@ -167,11 +147,6 @@ public class UserDefinedColours extends GUserDefinedColours implements Desktop.addInternalFrame(frame, MessageManager.getString("label.user_defined_colours"), MY_FRAME_WIDTH, MY_FRAME_HEIGHT, true); - - if (seqGroup != null) - { - frame.setTitle(frame.getTitle() + " (" + seqGroup.getName() + ")"); - } } /** @@ -188,7 +163,7 @@ public class UserDefinedColours extends GUserDefinedColours implements if (upperCaseButtons == null) { - upperCaseButtons = new ArrayList(); + upperCaseButtons = new ArrayList<>(); } for (int i = 0; i < 20; i++) @@ -219,7 +194,7 @@ public class UserDefinedColours extends GUserDefinedColours implements if (lowerCaseButtons == null) { - lowerCaseButtons = new ArrayList(); + lowerCaseButtons = new ArrayList<>(); } for (int i = 0; i < 20; i++) @@ -254,35 +229,39 @@ public class UserDefinedColours extends GUserDefinedColours implements } /** - * DOCUMENT ME! + * ChangeListener handler for when a colour is picked in the colour chooser. + * The action is to apply the colour to all selected buttons as their + * background colour. Foreground colour (text) is set to a lighter shade in + * order to highlight which buttons are selected. If 'Lower Case Colour' is + * active, then the colour is applied to all lower case buttons (as well as + * the Lower Case Colour button itself). * * @param evt - * DOCUMENT ME! */ @Override public void stateChanged(ChangeEvent evt) { - if (selectedButtons != null) + JButton button = null; + final Color newColour = colorChooser.getColor(); + if (lcaseColour.isSelected()) { - JButton button = null; - final Color newColour = colorChooser.getColor(); - for (int i = 0; i < selectedButtons.size(); i++) + selectedButtons.clear(); + for (int i = 0; i < lowerCaseButtons.size(); i++) { - button = selectedButtons.get(i); + button = lowerCaseButtons.get(i); button.setBackground(newColour); - button.setForeground(ColorUtils.brighterThan(newColour)); - } - if (button == lcaseColour) - { - for (int i = 0; i < lowerCaseButtons.size(); i++) - { - 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++) + { + button = selectedButtons.get(i); + button.setBackground(newColour); + button.setForeground(ColorUtils.brighterThan(newColour)); + } + + changed = true; } /** @@ -305,11 +284,6 @@ public class UserDefinedColours extends GUserDefinedColours implements */ public void colourButtonPressed(MouseEvent e) { - if (selectedButtons == null) - { - selectedButtons = new ArrayList(); - } - JButton pressed = (JButton) e.getSource(); if (e.isShiftDown()) @@ -349,8 +323,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); } } @@ -363,7 +337,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); } @@ -371,13 +346,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); } } @@ -403,8 +379,8 @@ public class UserDefinedColours extends GUserDefinedColours implements * @param buttonIndex * the button's position in the list */ - JButton makeButton(String label, String residue, - List buttons, int buttonIndex) + JButton makeButton(String label, String residue, List buttons, + int buttonIndex) { final JButton button; Color col; @@ -435,7 +411,8 @@ public class UserDefinedColours extends GUserDefinedColours implements col = Color.white; if (oldColourScheme != null && oldColourScheme.isSimple()) { - col = oldColourScheme.findColour(residue.charAt(0)); + col = oldColourScheme.findColour(residue.charAt(0), 0, null, null, + 0f); } } @@ -467,15 +444,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); @@ -486,6 +473,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). * @@ -503,37 +541,31 @@ public class UserDefinedColours extends GUserDefinedColours implements } /** - * Applies the current colour scheme to the alignment, sequence group or - * structure view. + * Applies the current colour scheme to the alignment or sequence group */ @Override protected void applyButton_actionPerformed() { 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); } UserColourScheme ucs = getSchemeFromButtons(); - if (seqGroup != null) - { - seqGroup.cs = ucs; - ap.paintAlignment(true); - } - else if (ap != null) - { - ap.alignFrame.changeColour(ucs); - } - else if (structureViewer != null) - { - structureViewer.setJalviewColourScheme(ucs); - } + ap.alignFrame.changeColour(ucs); } + /** + * Constructs an instance of UserColourScheme with the residue colours + * currently set on the buttons on the panel + * + * @return + */ UserColourScheme getSchemeFromButtons() { @@ -585,31 +617,28 @@ public class UserDefinedColours extends GUserDefinedColours implements ucs.setLowerCaseColours(newColours); } - if (ap != null) - { - ucs.setThreshold(0, ap.av.isIgnoreGapsConsensus()); - } - return ucs; } /** - * DOCUMENT ME! - * - * @param e - * DOCUMENT ME! + * Action on clicking Load scheme button. + *
    + *
  • Open a file chooser to browse for files with extension .jc
    • + *
  • Load in the colour scheme and transfer it to this panel's buttons
    • + *
  • Register the loaded colour scheme
    • + *
*/ @Override - protected void loadbutton_actionPerformed(ActionEvent e) + protected void loadbutton_actionPerformed() { - upperCaseButtons = new ArrayList(); - lowerCaseButtons = new ArrayList(); - - JalviewFileChooser chooser = new JalviewFileChooser( - Cache.getProperty(LAST_DIRECTORY), "jc", "Jalview User Colours"); + upperCaseButtons = new ArrayList<>(); + lowerCaseButtons = new ArrayList<>(); + // TODO: JAL-3048 requires Castor dependency for Jalview-JS + 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); @@ -621,7 +650,8 @@ public class UserDefinedColours extends GUserDefinedColours implements File choice = chooser.getSelectedFile(); Cache.setProperty(LAST_DIRECTORY, choice.getParent()); - UserColourScheme ucs = ColourSchemes.loadColourScheme(choice.getAbsolutePath()); + UserColourScheme ucs = ColourSchemeLoader + .loadColourScheme(choice.getAbsolutePath()); Color[] colors = ucs.getColours(); schemeName.setText(ucs.getSchemeName()); @@ -669,7 +699,7 @@ public class UserDefinedColours extends GUserDefinedColours implements { colours = colours.substring(0, colours.indexOf("|")); } - ret = ColourSchemes.loadColourScheme(colours); + ret = ColourSchemeLoader.loadColourScheme(colours); } if (ret == null) @@ -681,56 +711,84 @@ public class UserDefinedColours extends GUserDefinedColours implements } /** - * DOCUMENT ME! + * Action on pressing the Save button. + *
    + *
  • Check a name has been entered
    • + *
  • Warn if the name already exists, remove any existing scheme of the same + * 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
    • + *
  • 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 * - * @param e - * DOCUMENT ME! + * @return */ @Override - protected void savebutton_actionPerformed(ActionEvent e) + 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; } - ColourSchemes.getInstance().removeColourScheme(name); } - JalviewFileChooser chooser = new JalviewFileChooser( - Cache.getProperty(LAST_DIRECTORY), "jc", + // TODO: JAL-3048 saveas, also requires Castor dependency for Jalview-JS + + 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) + if (value != JalviewFileChooser.APPROVE_OPTION) { - File file = chooser.getSelectedFile(); - addNewColourScheme(file.getPath()); - saveToFile(file); + return false; } + + 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; } /** @@ -740,15 +798,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) @@ -772,6 +831,8 @@ public class UserDefinedColours extends GUserDefinedColours implements { ap.alignFrame.buildColourMenu(); } + + return ucs; } /** @@ -786,7 +847,8 @@ public class UserDefinedColours extends GUserDefinedColours implements * marshal to file */ JalviewUserColours ucs = new JalviewUserColours(); - ucs.setSchemeName(schemeName.getText()); + String name = schemeName.getText(); + ucs.setSchemeName(name); try { PrintWriter out = new PrintWriter(new OutputStreamWriter( @@ -809,30 +871,14 @@ public class UserDefinedColours extends GUserDefinedColours implements } /** - * On cancel, restores the colour scheme before the dialogue was opened - * - * @param e + * On cancel, restores the colour scheme that was selected before the dialogue + * was opened */ @Override - protected void cancelButton_actionPerformed(ActionEvent e) + protected void cancelButton_actionPerformed() { - if (ap != null) - { - if (seqGroup != null) - { - seqGroup.cs = oldColourScheme; - } - else - { - ap.alignFrame.changeColour(oldColourScheme); - } - ap.paintAlignment(true); - } - - if (structureViewer != null) - { - structureViewer.setJalviewColourScheme(oldColourScheme); - } + ap.alignFrame.changeColour(oldColourScheme); + ap.paintAlignment(true, true); try { @@ -842,24 +888,17 @@ public class UserDefinedColours extends GUserDefinedColours implements } } + /** + * Action on selecting or deselecting the Case Sensitive option. When + * selected, separate buttons are shown for lower case residues, and the panel + * is resized to accommodate them. Also, the checkbox for 'apply colour to all + * lower case' is enabled. + */ @Override - public void caseSensitive_actionPerformed(ActionEvent e) - { - resetButtonPanel(caseSensitive.isSelected()); - lcaseColour.setEnabled(caseSensitive.isSelected()); - } - - @Override - public void lcaseColour_actionPerformed(ActionEvent e) + public void caseSensitive_actionPerformed() { - if (selectedButtons == null) - { - selectedButtons = new ArrayList(); - } - else - { - selectedButtons.clear(); - } - selectedButtons.add(lcaseColour); + boolean selected = caseSensitive.isSelected(); + resetButtonPanel(selected); + lcaseColour.setEnabled(selected); } }