X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fappletgui%2FFeatureRenderer.java;h=df407d6af08d4583cfafa37c43e64d07bba04655;hb=c38d37887ae51d63942ac4321f6769308188ed6b;hp=5e654093f98d42efcc0681479cb7928307be7566;hpb=9c8561a294fb638ae78c01a440a863b05db2bdee;p=jalview.git diff --git a/src/jalview/appletgui/FeatureRenderer.java b/src/jalview/appletgui/FeatureRenderer.java old mode 100755 new mode 100644 index 5e65409..df407d6 --- a/src/jalview/appletgui/FeatureRenderer.java +++ b/src/jalview/appletgui/FeatureRenderer.java @@ -1,105 +1,195 @@ /* - * Jalview - A Sequence Alignment Editor and Viewer - * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License - * as published by the Free Software Foundation; either version 2 + * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$) + * Copyright (C) $$Year-Rel$$ The Jalview Authors + * + * This file is part of Jalview. + * + * Jalview is free software: you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation, either version 3 * of the License, or (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * + * + * Jalview is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty + * of MERCHANTABILITY or FITNESS FOR A PARTICULAR + * PURPOSE. See the GNU General Public License for more details. + * * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + * along with Jalview. If not, see . + * The Jalview Authors are detailed in the 'AUTHORS' file. */ package jalview.appletgui; -import java.util.*; - -import java.awt.*; - -import java.awt.event.*; - - -import jalview.appletgui.FeatureSettings.MyCheckbox; -import jalview.datamodel.*; +import jalview.api.FeatureColourI; +import jalview.datamodel.SearchResults; +import jalview.datamodel.SearchResultsI; +import jalview.datamodel.SequenceFeature; +import jalview.datamodel.SequenceI; +import jalview.io.FeaturesFile; +import jalview.schemes.FeatureColour; +import jalview.util.ColorUtils; +import jalview.util.MessageManager; +import jalview.viewmodel.AlignmentViewport; + +import java.awt.BorderLayout; +import java.awt.Button; +import java.awt.Choice; +import java.awt.Color; +import java.awt.Dimension; +import java.awt.FlowLayout; +import java.awt.Font; +import java.awt.Frame; +import java.awt.Graphics; +import java.awt.GridLayout; +import java.awt.Label; +import java.awt.Panel; +import java.awt.ScrollPane; +import java.awt.TextArea; +import java.awt.TextField; +import java.awt.event.ActionEvent; +import java.awt.event.ActionListener; +import java.awt.event.MouseAdapter; +import java.awt.event.MouseEvent; +import java.awt.event.TextEvent; +import java.awt.event.TextListener; +import java.util.Hashtable; +import java.util.List; /** * DOCUMENT ME! - * + * * @author $author$ * @version $Revision$ */ public class FeatureRenderer + extends jalview.renderer.seqfeatures.FeatureRenderer { - AlignViewport av; - - Hashtable featureColours = new Hashtable(); + /* + * creating a new feature defaults to the type and group as + * the last one created + */ + static String lastFeatureAdded = "feature_1"; - // A higher level for grouping features of a - // particular type - Hashtable featureGroups = null; + static String lastFeatureGroupAdded = "Jalview"; // Holds web links for feature groups and feature types // in the form label|link Hashtable featureLinks = null; - // This is actually an Integer held in the hashtable, - // Retrieved using the key feature type - Object currentColour; + /** + * Creates a new FeatureRenderer object. + * + * @param av + */ + public FeatureRenderer(AlignmentViewport av) + { + super(av); - String[] renderOrder; + } - FontMetrics fm; - int charOffset; + int featureIndex = 0; - float transparency = 1f; + boolean deleteFeature = false; - TransparencySetter transparencySetter = null; + FeatureColourPanel colourPanel; - /** - * Creates a new FeatureRenderer object. - * - * @param av DOCUMENT ME! - */ - public FeatureRenderer(AlignViewport av) + class FeatureColourPanel extends Panel { - this.av = av; + String label = ""; + + private Color maxCol; + + private boolean isColourByLabel, isGcol; - if (!System.getProperty("java.version").startsWith("1.1")) + /** + * render a feature style in the amend feature dialog box + */ + public void updateColor(FeatureColourI newcol) { - transparencySetter = new TransparencySetter(); + Color bg = null; + String vlabel = ""; + if (newcol.isSimpleColour()) + { + bg = newcol.getColour(); + setBackground(bg); + } + else + { + if (newcol.isAboveThreshold()) + { + vlabel += " (>)"; + } + else if (newcol.isBelowThreshold()) + { + vlabel += " (<)"; + } + + if (isColourByLabel = newcol.isColourByLabel()) + { + setBackground(bg = Color.white); + vlabel += " (by Label)"; + } + else + { + setBackground(bg = newcol.getMinColour()); + maxCol = newcol.getMaxColour(); + } + } + label = vlabel; + setBackground(bg); + repaint(); } - } - public void transferSettings(FeatureRenderer fr) - { - renderOrder = fr.renderOrder; - featureGroups = fr.featureGroups; - featureColours = fr.featureColours; - transparency = fr.transparency; - } + FeatureColourPanel() + { + super(null); + } + @Override + public void paint(Graphics g) + { + Dimension d = getSize(); + if (isGcol) + { + if (isColourByLabel) + { + g.setColor(Color.white); + g.fillRect(d.width / 2, 0, d.width / 2, d.height); + g.setColor(Color.black); + Font f = new Font("Verdana", Font.PLAIN, 10); + g.setFont(f); + g.drawString(MessageManager.getString("label.label"), 0, 0); + } + else + { + g.setColor(maxCol); + g.fillRect(d.width / 2, 0, d.width / 2, d.height); - static String lastFeatureAdded; - static String lastFeatureGroupAdded; - static String lastDescriptionAdded; + } + } + } - int featureIndex = 0; - boolean deleteFeature = false; - Panel colourPanel; - boolean amendFeatures(final SequenceI[] sequences, - final SequenceFeature[] features, - boolean newFeatures, - final AlignmentPanel ap) + } + + /** + * Shows a dialog allowing the user to create, or amend or delete, sequence + * features. If null in the supplied feature(s), feature type and group + * default to those for the last feature created (with initial defaults of + * "feature_1" and "Jalview"). + * + * @param sequences + * @param features + * @param create + * @param ap + * @return + */ + boolean amendFeatures(final List sequences, + final List features, boolean create, + final AlignmentPanel ap) { - Panel bigPanel = new Panel(new BorderLayout()); + final Panel bigPanel = new Panel(new BorderLayout()); final TextField name = new TextField(16); - final TextField source = new TextField(16); + final TextField group = new TextField(16); final TextArea description = new TextArea(3, 35); final TextField start = new TextField(8); final TextField end = new TextField(8); @@ -107,105 +197,127 @@ public class FeatureRenderer Button deleteButton = new Button("Delete"); deleteFeature = false; - colourPanel = new Panel(null); - colourPanel.setSize(110,15); + name.addTextListener(new TextListener() + { + @Override + public void textValueChanged(TextEvent e) + { + warnIfTypeHidden(ap.alignFrame, name.getText()); + } + }); + group.addTextListener(new TextListener() + { + @Override + public void textValueChanged(TextEvent e) + { + warnIfGroupHidden(ap.alignFrame, group.getText()); + } + }); + colourPanel = new FeatureColourPanel(); + colourPanel.setSize(110, 15); final FeatureRenderer fr = this; Panel panel = new Panel(new GridLayout(3, 1)); + featureIndex = 0; // feature to be amended. Panel tmp; - /////////////////////////////////////// - ///MULTIPLE FEATURES AT SELECTED RESIDUE - if(!newFeatures && features.length>1) + // ///////////////////////////////////// + // /MULTIPLE FEATURES AT SELECTED RESIDUE + if (!create && features.size() > 1) { - panel = new Panel(new GridLayout(4, 1)); - tmp = new Panel(); - tmp.add(new Label("Select Feature: ")); - overlaps = new Choice(); - for(int i=0; i0) + @Override + public void mousePressed(MouseEvent evt) { - for (int i = 0; i < sequences.length; i++) - { - features[i].type = lastFeatureAdded; - features[i].featureGroup = lastFeatureGroupAdded; - features[i].description = lastDescriptionAdded; - sequences[i].addSequenceFeature(features[i]); - ffile.parseDescriptionHTML(features[i], false); - } - - if (av.featuresDisplayed == null) - { - av.featuresDisplayed = new Hashtable(); - } - - if (featureGroups == null) + if (!colourPanel.isGcol) { - featureGroups = new Hashtable(); + new UserDefinedColours(fr, ap.alignFrame); } - - col = colourPanel.getBackground(); - setColour(lastFeatureAdded, col); - - if(lastFeatureGroupAdded!=null) + else { - featureGroups.put(lastFeatureGroupAdded, new Boolean(true)); - av.featuresDisplayed.put(lastFeatureGroupAdded, - new Integer(col.getRGB())); + new FeatureColourChooser(ap.alignFrame, name.getText()); + dialog.transferFocus(); } - findAllFeatures(); - - String [] tro = new String[renderOrder.length]; - tro[0] = renderOrder[renderOrder.length-1]; - System.arraycopy(renderOrder,0,tro,1,renderOrder.length-1); - renderOrder = tro; - - ap.paintAlignment(true); - - return true; } - else - { - return false; - } - } - - findAllFeatures(); - - ap.paintAlignment(true); - - return true; - } - - - public Color findFeatureColour(Color initialCol, SequenceI seq, int i) - { - overview = true; - if (!av.showSequenceFeatures) - { - return initialCol; - } - - lastSeq = seq; - sequenceFeatures = lastSeq.getSequenceFeatures(); - if (sequenceFeatures == null) - { - return initialCol; - } - - sfSize = sequenceFeatures.length; - - if (jalview.util.Comparison.isGap(lastSeq.getCharAt(i))) - { - return Color.white; - } - - currentColour = null; - - drawSequence(null, lastSeq, lastSeq.findPosition(i), -1, -1); - - if (currentColour == null) - { - return initialCol; - } - - return new Color( ( (Integer) currentColour).intValue()); - } - - /** - * This is used by the Molecule Viewer to get the accurate colour - * of the rendered sequence - */ - boolean overview = false; - - - /** - * DOCUMENT ME! - * - * @param g DOCUMENT ME! - * @param seq DOCUMENT ME! - * @param sg DOCUMENT ME! - * @param start DOCUMENT ME! - * @param end DOCUMENT ME! - * @param x1 DOCUMENT ME! - * @param y1 DOCUMENT ME! - * @param width DOCUMENT ME! - * @param height DOCUMENT ME! - */ - // String type; - // SequenceFeature sf; - - SequenceI lastSeq; - SequenceFeature[] sequenceFeatures; - int sfSize, sfindex, spos, epos; + }); + dialog.setVisible(true); - synchronized public void drawSequence(Graphics g, SequenceI seq, - int start, int end, int y1) - { - if (seq.getSequenceFeatures() == null - || seq.getSequenceFeatures().length == 0) - { - return; - } + FeaturesFile ffile = new FeaturesFile(); - if (transparencySetter != null && g != null) - { - transparencySetter.setTransparency(g, transparency); - } + /* + * only update default type and group if we used defaults + */ + final String enteredType = name.getText().trim(); + final String enteredGroup = group.getText().trim(); + final String enteredDesc = description.getText().replace('\n', ' '); - if (lastSeq == null || seq != lastSeq || sequenceFeatures!=seq.getSequenceFeatures()) + if (dialog.accept && useLastDefaults) { - lastSeq = seq; - sequenceFeatures = seq.getSequenceFeatures(); - sfSize = sequenceFeatures.length; + lastFeatureAdded = enteredType; + lastFeatureGroupAdded = enteredGroup; } - if (av.featuresDisplayed == null || renderOrder == null) + if (!create) { - findAllFeatures(); - if (av.featuresDisplayed.size() < 1) - { - return; - } - - sequenceFeatures = seq.getSequenceFeatures(); - sfSize = sequenceFeatures.length; - } - if (!overview) - { - spos = lastSeq.findPosition(start); - epos = lastSeq.findPosition(end); - if (g != null) - { - fm = g.getFontMetrics(); - } - } - String type; - for (int renderIndex = 0; renderIndex < renderOrder.length; renderIndex++) - { - type = renderOrder[renderIndex]; - if (!av.featuresDisplayed.containsKey(type)) - { - continue; - } - - // loop through all features in sequence to find - // current feature to render - for (sfindex = 0; sfindex < sfSize; sfindex++) + SequenceFeature sf = features.get(featureIndex); + if (dialog.accept) { - if (!sequenceFeatures[sfindex].type.equals(type)) - { - continue; - } - - if (featureGroups != null - && sequenceFeatures[sfindex].featureGroup != null - && - featureGroups.containsKey(sequenceFeatures[sfindex].featureGroup) - && - ! ( (Boolean) featureGroups.get(sequenceFeatures[sfindex]. - featureGroup)). - booleanValue()) + if (!colourPanel.isGcol) { - continue; + // update colour - otherwise its already done. + setColour(enteredType, + new FeatureColour(colourPanel.getBackground())); } - - if (!overview && (sequenceFeatures[sfindex].getBegin() > epos - || sequenceFeatures[sfindex].getEnd() < spos)) + int newBegin = sf.begin; + int newEnd = sf.end; + try { - continue; - } - - if (overview) + newBegin = Integer.parseInt(start.getText()); + newEnd = Integer.parseInt(end.getText()); + } catch (NumberFormatException ex) { - if (sequenceFeatures[sfindex].begin <= start && - sequenceFeatures[sfindex].end >= start) - { - currentColour = av.featuresDisplayed.get(sequenceFeatures[sfindex]. - type); - } - + // } - else if (sequenceFeatures[sfindex].type.equals("disulfide bond")) - { - renderFeature(g, seq, - seq.findIndex(sequenceFeatures[sfindex].begin) - 1, - seq.findIndex(sequenceFeatures[sfindex].begin) - 1, - new Color( ( (Integer) av.featuresDisplayed.get( - sequenceFeatures[sfindex].type)).intValue()), - start, end, y1); - renderFeature(g, seq, - seq.findIndex(sequenceFeatures[sfindex].end) - 1, - seq.findIndex(sequenceFeatures[sfindex].end) - 1, - new Color( ( (Integer) av.featuresDisplayed.get( - sequenceFeatures[sfindex].type)).intValue()), - start, end, y1); + /* + * replace the feature by deleting it and adding a new one + * (to ensure integrity of SequenceFeatures data store) + */ + sequences.get(0).deleteFeature(sf); + SequenceFeature newSf = new SequenceFeature(sf, enteredType, + newBegin, newEnd, enteredGroup, sf.getScore()); + newSf.setDescription(enteredDesc); + ffile.parseDescriptionHTML(newSf, false); + // amend features dialog only updates one sequence at a time + sequences.get(0).addSequenceFeature(newSf); + boolean typeOrGroupChanged = (!featureType.equals(newSf.getType()) || !featureGroup + .equals(newSf.getFeatureGroup())); - } - else + ffile.parseDescriptionHTML(sf, false); + if (typeOrGroupChanged) { - renderFeature(g, seq, - seq.findIndex(sequenceFeatures[sfindex].begin) - 1, - seq.findIndex(sequenceFeatures[sfindex].end) - 1, - getColour(sequenceFeatures[sfindex].type), - start, end, y1); + featuresAdded(); } - - } - } - - if (transparencySetter != null && g != null) - { - transparencySetter.setTransparency(g, 1.0f); - } - } - - char s; - int i; - void renderFeature(Graphics g, SequenceI seq, - int fstart, int fend, Color featureColour, int start, - int end, int y1) - { - - if ( ( (fstart <= end) && (fend >= start))) - { - if (fstart < start) - { // fix for if the feature we have starts before the sequence start, - fstart = start; // but the feature end is still valid!! } - - if (fend >= end) + if (deleteFeature) { - fend = end; - } - - for (i = fstart; i <= fend; i++) - { - s = seq.getCharAt(i); - - if (jalview.util.Comparison.isGap(s)) - { - continue; - } - - g.setColor(featureColour); - - g.fillRect( (i - start) * av.charWidth, y1, av.charWidth, av.charHeight); - - if (!av.validCharWidth) - { - continue; - } - - g.setColor(Color.white); - charOffset = (av.charWidth - fm.charWidth(s)) / 2; - g.drawString(String.valueOf(s), - charOffset + (av.charWidth * (i - start)), - (y1 + av.charHeight) - av.charHeight / 5); //pady = height / 5; - + sequences.get(0).deleteFeature(sf); + // ensure Feature Settings reflects removal of feature / group + featuresAdded(); } } - } - - void findAllFeatures() - { - jalview.schemes.UserColourScheme ucs = new - jalview.schemes.UserColourScheme(); - - av.featuresDisplayed = new Hashtable(); - Vector allfeatures = new Vector(); - for (int i = 0; i < av.alignment.getHeight(); i++) + else { - SequenceFeature[] features = av.alignment.getSequenceAt(i). - getSequenceFeatures(); - - if (features == null) - { - continue; - } - - int index = 0; - while (index < features.length) + /* + * adding feature(s) + */ + if (dialog.accept && name.getText().length() > 0) { - if (!av.featuresDisplayed.containsKey(features[index].getType())) + for (int i = 0; i < sequences.size(); i++) { - if (getColour(features[index].getType()) == null) - { - featureColours.put(features[index].getType(), - ucs.createColourFromName(features[index]. - getType())); - } - - av.featuresDisplayed.put(features[index].getType(), - new Integer(getColour(features[index]. - getType()).getRGB())); - allfeatures.addElement(features[index].getType()); + SequenceFeature sf = features.get(i); + SequenceFeature sf2 = new SequenceFeature(enteredType, + enteredDesc, sf.getBegin(), sf.getEnd(), enteredGroup); + ffile.parseDescriptionHTML(sf2, false); + sequences.get(i).addSequenceFeature(sf2); } - index++; - } - } - - renderOrder = new String[allfeatures.size()]; - Enumeration en = allfeatures.elements(); - int i = allfeatures.size() - 1; - while (en.hasMoreElements()) - { - renderOrder[i] = en.nextElement().toString(); - i--; - } - } - public Color getColour(String featureType) - { - if (!featureColours.containsKey(featureType)) - { - jalview.schemes.UserColourScheme ucs = new - jalview.schemes.UserColourScheme(); - Color col = ucs.createColourFromName(featureType); - featureColours.put(featureType, col); - return col; - } - else - return (Color) featureColours.get(featureType); - } - - - public void setColour(String featureType, Color col) - { - featureColours.put(featureType, col); - } - - public void setFeaturePriority(Object[][] data) - { - // The feature table will display high priority - // features at the top, but theses are the ones - // we need to render last, so invert the data - if (av.featuresDisplayed != null) - { - av.featuresDisplayed.clear(); - } + Color newColour = colourPanel.getBackground(); + // setColour(lastFeatureAdded, fcol); - /* if (visibleNew) - { - if (av.featuresDisplayed != null) - { - av.featuresDisplayed.clear(); + setColour(enteredType, new FeatureColour(newColour)); // was fcol + featuresAdded(); } else { - av.featuresDisplayed = new Hashtable(); + // no update to the alignment + return false; } } - if (data == null) + // refresh the alignment and the feature settings dialog + if (((jalview.appletgui.AlignViewport) av).featureSettings != null) { - return; - }*/ - - - renderOrder = new String[data.length]; + ((jalview.appletgui.AlignViewport) av).featureSettings.refreshTable(); + } + // findAllFeatures(); - if (data.length > 0) - { - for (int i = 0; i < data.length; i++) - { - String type = data[i][0].toString(); - setColour(type, (Color) data[i][1]); - if ( ( (Boolean) data[i][2]).booleanValue()) - { - av.featuresDisplayed.put(type, new Integer(getColour(type).getRGB())); - } + ap.paintAlignment(true, true); - renderOrder[data.length - i - 1] = type; - } - } - } - /** - * @return a simple list of feature group names or null - */ - public String[] getGroups() - { - buildGroupHash(); - if (featureGroups!=null) - { - String[] gps = new String[featureGroups.size()]; - Enumeration gn = featureGroups.keys(); - int i=0; - while (gn.hasMoreElements()) - { - gps[i++] = (String) gn.nextElement(); - } - return gps; - } - return null; + return true; } - /** - * get visible or invisible groups - * @param visible true to return visible groups, false to return hidden ones. - * @return list of groups - */ - public String[] getGroups(boolean visible) + + protected void warnIfGroupHidden(Frame frame, String group) { - buildGroupHash(); - if (featureGroups!=null) + if (featureGroups.containsKey(group) && !featureGroups.get(group)) { - Vector gp = new Vector(); - - Enumeration gn = featureGroups.keys(); - while (gn.hasMoreElements()) - { - String nm = (String) gn.nextElement(); - Boolean state = (Boolean) featureGroups.get(nm); - if (state.booleanValue()==visible) - { - gp.addElement(nm); - } - } - String[] gps = new String[gp.size()]; - gp.copyInto(gps); - - int i=0; - while (gn.hasMoreElements()) - { - gps[i++] = (String) gn.nextElement(); - } - return gps; + String msg = MessageManager.formatMessage("label.warning_hidden", + MessageManager.getString("label.group"), group); + showWarning(frame, msg); } - return null; } - /** - * set all feature groups in toset to be visible or invisible - * @param toset group names - * @param visible the state of the named groups to set - */ - public void setGroupState(String[] toset, boolean visible) + + protected void warnIfTypeHidden(Frame frame, String type) { - buildGroupHash(); - if (toset!=null && toset.length>0 && featureGroups!=null) + if (getRenderOrder().contains(type)) { - boolean rdrw = false; - for (int i=0;i0) - { - String[] neworder = new String[allFeatures.size()]; - int p=neworder.length-1; - for (int i=renderOrder.length-1; i>=0; i--) - { - if (allFeatures.contains(renderOrder[i])) - { - neworder[p--] = renderOrder[i]; - allFeatures.removeElement(renderOrder[i]); - } else { - av.featuresDisplayed.remove(renderOrder[i]); - } - } - for (int i=allFeatures.size()-1; i>0; i++) - { - Object e = allFeatures.elementAt(i); - if (e!=null) - { - neworder[p--] = (String) e; - av.featuresDisplayed.put(e, getColour((String)e)); - } - } - renderOrder = neworder; - return true; - } - - return alignmentHasFeatures; - } -} - -class TransparencySetter -{ - void setTransparency(Graphics g, float value) + protected void showWarning(Frame frame, String msg) { - Graphics2D g2 = (Graphics2D) g; - g2.setComposite( - AlphaComposite.getInstance( - AlphaComposite.SRC_OVER, value)); + JVDialog d = new JVDialog(frame, "", true, 350, 200); + Panel mp = new Panel(); + d.ok.setLabel(MessageManager.getString("action.ok")); + d.cancel.setVisible(false); + mp.setLayout(new FlowLayout()); + mp.add(new Label(msg)); + d.setMainPanel(mp); + d.setVisible(true); } }