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.
21 package jalview.appletgui;
23 import jalview.api.FeatureColourI;
24 import jalview.api.FeatureSettingsControllerI;
25 import jalview.datamodel.AlignmentI;
26 import jalview.datamodel.SequenceFeature;
27 import jalview.util.MessageManager;
29 import java.awt.BorderLayout;
30 import java.awt.Button;
31 import java.awt.Checkbox;
32 import java.awt.Color;
33 import java.awt.Component;
34 import java.awt.Dimension;
36 import java.awt.FontMetrics;
37 import java.awt.Frame;
38 import java.awt.Graphics;
39 import java.awt.GridLayout;
40 import java.awt.Image;
41 import java.awt.Label;
42 import java.awt.MenuItem;
43 import java.awt.Panel;
44 import java.awt.PopupMenu;
45 import java.awt.ScrollPane;
46 import java.awt.Scrollbar;
47 import java.awt.event.ActionEvent;
48 import java.awt.event.ActionListener;
49 import java.awt.event.AdjustmentEvent;
50 import java.awt.event.AdjustmentListener;
51 import java.awt.event.InputEvent;
52 import java.awt.event.ItemEvent;
53 import java.awt.event.ItemListener;
54 import java.awt.event.MouseEvent;
55 import java.awt.event.MouseListener;
56 import java.awt.event.MouseMotionListener;
57 import java.awt.event.WindowAdapter;
58 import java.awt.event.WindowEvent;
59 import java.util.Arrays;
60 import java.util.Enumeration;
61 import java.util.List;
63 import java.util.Vector;
65 public class FeatureSettings extends Panel implements ItemListener,
66 MouseListener, MouseMotionListener, ActionListener,
67 AdjustmentListener, FeatureSettingsControllerI
79 Panel featurePanel = new Panel();
81 ScrollPane scrollPane;
85 Scrollbar transparency;
87 public FeatureSettings(final AlignmentPanel ap)
91 ap.av.featureSettings = this;
92 fr = ap.seqPanel.seqCanvas.getFeatureRenderer();
94 transparency = new Scrollbar(Scrollbar.HORIZONTAL,
95 100 - (int) (fr.getTransparency() * 100), 1, 1, 100);
97 transparency.addAdjustmentListener(this);
99 java.net.URL url = getClass().getResource("/images/link.gif");
102 linkImage = java.awt.Toolkit.getDefaultToolkit().getImage(url);
105 if (av.isShowSequenceFeatures() || !fr.hasRenderOrder())
107 fr.findAllFeatures(true); // was default - now true to make all visible
110 discoverAllFeatureData();
112 this.setLayout(new BorderLayout());
113 scrollPane = new ScrollPane();
114 scrollPane.add(featurePanel);
115 if (fr.getAllFeatureColours() != null
116 && fr.getAllFeatureColours().size() > 0)
118 add(scrollPane, BorderLayout.CENTER);
121 Button invert = new Button("Invert Selection");
122 invert.addActionListener(this);
124 Panel lowerPanel = new Panel(new GridLayout(2, 1, 5, 10));
125 lowerPanel.add(invert);
127 Panel tPanel = new Panel(new BorderLayout());
129 tPanel.add(transparency, BorderLayout.CENTER);
130 tPanel.add(new Label("Transparency"), BorderLayout.EAST);
132 lowerPanel.add(tPanel, BorderLayout.SOUTH);
134 add(lowerPanel, BorderLayout.SOUTH);
136 if (groupPanel != null)
138 groupPanel.setLayout(new GridLayout(
139 (fr.getFeatureGroupsSize()) / 4 + 1, 4)); // JBPNote - this was
140 // scaled on number of
141 // visible groups. seems
143 groupPanel.validate();
145 add(groupPanel, BorderLayout.NORTH);
149 final FeatureSettings me = this;
150 frame.addWindowListener(new WindowAdapter()
153 public void windowClosing(WindowEvent e)
155 if (me.av.featureSettings == me)
157 me.av.featureSettings = null;
163 int height = featurePanel.getComponentCount() * 50 + 60;
165 height = Math.max(200, height);
166 height = Math.min(400, height);
168 jalview.bin.JalviewLite.addFrame(frame,
169 MessageManager.getString("label.sequence_feature_settings"),
174 public void paint(Graphics g)
176 g.setColor(Color.black);
177 g.drawString(MessageManager
178 .getString("label.no_features_added_to_this_alignment"), 10, 20);
179 g.drawString(MessageManager
180 .getString("label.features_can_be_added_from_searches_1"), 10,
182 g.drawString(MessageManager
183 .getString("label.features_can_be_added_from_searches_2"), 10,
187 protected void popupSort(final MyCheckbox check,
188 final Map<String, float[][]> minmax, int x, int y)
190 final String type = check.type;
191 final FeatureColourI typeCol = fr.getFeatureStyle(type);
192 PopupMenu men = new PopupMenu(MessageManager.formatMessage(
193 "label.settings_for_type", new String[] { type }));
194 java.awt.MenuItem scr = new MenuItem(
195 MessageManager.getString("label.sort_by_score"));
197 final FeatureSettings me = this;
198 scr.addActionListener(new ActionListener()
202 public void actionPerformed(ActionEvent e)
204 me.ap.alignFrame.avc.sortAlignmentByFeatureScore(Arrays
205 .asList(new String[] { type }));
209 MenuItem dens = new MenuItem(
210 MessageManager.getString("label.sort_by_density"));
211 dens.addActionListener(new ActionListener()
215 public void actionPerformed(ActionEvent e)
217 me.ap.alignFrame.avc.sortAlignmentByFeatureDensity(Arrays
218 .asList(new String[] { type }));
226 final float[][] typeMinMax = minmax.get(type);
228 * final java.awt.CheckboxMenuItem chb = new
229 * java.awt.CheckboxMenuItem("Vary Height"); // this is broken at the
230 * moment chb.setState(minmax.get(type) != null);
231 * chb.addActionListener(new ActionListener() {
233 * public void actionPerformed(ActionEvent e) {
234 * chb.setState(chb.getState()); if (chb.getState()) { minmax.put(type,
235 * null); } else { minmax.put(type, typeMinMax); } }
239 if (typeMinMax != null && typeMinMax[0] != null)
241 // graduated colourschemes for those where minmax exists for the
242 // positional features
243 MenuItem mxcol = new MenuItem(
244 (typeCol.isSimpleColour()) ? "Graduated Colour"
247 mxcol.addActionListener(new ActionListener()
251 public void actionPerformed(ActionEvent e)
253 if (typeCol.isSimpleColour())
255 new FeatureColourChooser(me, type);
256 // write back the current colour object to update the table
257 check.updateColor(fr.getFeatureStyle(type));
261 new UserDefinedColours(me, check.type, typeCol);
269 MenuItem selectContaining = new MenuItem(
270 MessageManager.getString("label.select_columns_containing"));
271 selectContaining.addActionListener(new ActionListener()
274 public void actionPerformed(ActionEvent e)
276 me.ap.alignFrame.avc.markColumnsContainingFeatures(false, false,
280 men.add(selectContaining);
282 MenuItem selectNotContaining = new MenuItem(
283 MessageManager.getString("label.select_columns_not_containing"));
284 selectNotContaining.addActionListener(new ActionListener()
287 public void actionPerformed(ActionEvent e)
289 me.ap.alignFrame.avc.markColumnsContainingFeatures(true, false,
293 men.add(selectNotContaining);
295 MenuItem hideContaining = new MenuItem(
296 MessageManager.getString("label.hide_columns_containing"));
297 hideContaining.addActionListener(new ActionListener()
300 public void actionPerformed(ActionEvent e)
302 hideFeatureColumns(type, true);
305 men.add(hideContaining);
307 MenuItem hideNotContaining = new MenuItem(
308 MessageManager.getString("label.hide_columns_not_containing"));
309 hideNotContaining.addActionListener(new ActionListener()
312 public void actionPerformed(ActionEvent e)
314 hideFeatureColumns(type, false);
317 men.add(hideNotContaining);
319 this.featurePanel.add(men);
320 men.show(this.featurePanel, x, y);
324 public void discoverAllFeatureData()
326 if (fr.getAllFeatureColours() != null
327 && fr.getAllFeatureColours().size() > 0)
336 * rebuilds the group panel
338 public void rebuildGroups()
340 boolean rdrw = false;
341 if (groupPanel == null)
343 groupPanel = new Panel();
348 groupPanel.removeAll();
350 // TODO: JAL-964 - smoothly incorporate new group entries if panel already
351 // displayed and new groups present
352 for (String group : fr.getFeatureGroups())
354 boolean vis = fr.checkGroupVisibility(group, false);
355 Checkbox check = new MyCheckbox(group, vis, false);
356 check.addMouseListener(this);
357 check.setFont(new Font("Serif", Font.BOLD, 12));
358 check.addItemListener(groupItemListener);
359 // note - visibility seems to correlate with displayed. ???wtf ??
360 check.setVisible(vis);
361 groupPanel.add(check);
365 groupPanel.validate();
369 // This routine adds and removes checkboxes depending on
370 // Group selection states
371 void resetTable(boolean groupsChanged)
373 SequenceFeature[] tmpfeatures;
374 String group = null, type;
375 Vector<String> visibleChecks = new Vector<String>();
376 AlignmentI alignment = av.getAlignment();
377 for (int i = 0; i < alignment.getHeight(); i++)
379 if (alignment.getSequenceAt(i).getSequenceFeatures() == null)
384 tmpfeatures = alignment.getSequenceAt(i).getSequenceFeatures();
386 while (index < tmpfeatures.length)
388 group = tmpfeatures[index].featureGroup;
390 if (group == null || fr.checkGroupVisibility(group, true))
392 type = tmpfeatures[index].getType();
393 if (!visibleChecks.contains(type))
395 visibleChecks.addElement(type);
403 int cSize = featurePanel.getComponentCount();
405 // This will remove any checkboxes which shouldn't be
407 for (int i = 0; i < cSize; i++)
409 comps = featurePanel.getComponents();
410 check = (MyCheckbox) comps[i];
411 if (!visibleChecks.contains(check.type))
413 featurePanel.remove(i);
419 if (fr.getRenderOrder() != null)
421 // First add the checks in the previous render order,
422 // in case the window has been closed and reopened
423 List<String> rol = fr.getRenderOrder();
424 for (int ro = rol.size() - 1; ro > -1; ro--)
426 String item = rol.get(ro);
428 if (!visibleChecks.contains(item))
433 visibleChecks.removeElement(item);
435 addCheck(false, item);
439 // now add checkboxes which should be visible,
440 // if they have not already been added
441 Enumeration<String> en = visibleChecks.elements();
443 while (en.hasMoreElements())
445 addCheck(groupsChanged, en.nextElement().toString());
448 featurePanel.setLayout(new GridLayout(featurePanel.getComponentCount(),
450 featurePanel.validate();
452 if (scrollPane != null)
454 scrollPane.validate();
457 itemStateChanged(null);
461 * update the checklist of feature types with the given type
463 * @param groupsChanged
464 * true means if the type is not in the display list then it will be
465 * added and displayed
467 * feature type to be checked for in the list.
469 void addCheck(boolean groupsChanged, String type)
472 Component[] comps = featurePanel.getComponents();
475 for (int i = 0; i < featurePanel.getComponentCount(); i++)
477 check = (MyCheckbox) comps[i];
478 if (check.type.equals(type))
487 boolean selected = false;
488 if (groupsChanged || av.getFeaturesDisplayed().isVisible(type))
493 check = new MyCheckbox(type, selected, false,
494 fr.getFeatureStyle(type));
496 check.addMouseListener(this);
497 check.addMouseMotionListener(this);
498 check.addItemListener(this);
501 // add at beginning of stack.
502 featurePanel.add(check, 0);
506 // add at end of stack.
507 featurePanel.add(check);
513 public void actionPerformed(ActionEvent evt)
515 for (int i = 0; i < featurePanel.getComponentCount(); i++)
517 Checkbox check = (Checkbox) featurePanel.getComponent(i);
518 check.setState(!check.getState());
523 private ItemListener groupItemListener = new ItemListener()
526 public void itemStateChanged(ItemEvent evt)
528 Checkbox source = (Checkbox) evt.getSource();
529 fr.setGroupVisibility(source.getLabel(), source.getState());
530 ap.seqPanel.seqCanvas.repaint();
531 if (ap.overviewPanel != null)
533 ap.overviewPanel.updateOverviewImage();
541 public void itemStateChanged(ItemEvent evt)
546 void selectionChanged()
548 Component[] comps = featurePanel.getComponents();
549 int cSize = comps.length;
551 Object[][] tmp = new Object[cSize][3];
553 for (int i = 0; i < cSize; i++)
555 MyCheckbox check = (MyCheckbox) comps[i];
556 tmp[tmpSize][0] = check.type;
557 tmp[tmpSize][1] = fr.getFeatureStyle(check.type);
558 tmp[tmpSize][2] = new Boolean(check.getState());
562 Object[][] data = new Object[tmpSize][3];
563 System.arraycopy(tmp, 0, data, 0, tmpSize);
565 fr.setFeaturePriority(data);
567 ap.paintAlignment(true);
570 MyCheckbox selectedCheck;
572 boolean dragging = false;
575 public void mouseDragged(MouseEvent evt)
577 if (((Component) evt.getSource()).getParent() != featurePanel)
585 public void mouseReleased(MouseEvent evt)
587 if (((Component) evt.getSource()).getParent() != featurePanel)
592 Component comp = null;
593 Checkbox target = null;
595 int height = evt.getY() + evt.getComponent().getLocation().y;
597 if (height > featurePanel.getSize().height)
601 .getComponent(featurePanel.getComponentCount() - 1);
605 comp = featurePanel.getComponent(0);
609 comp = featurePanel.getComponentAt(evt.getX(), evt.getY()
610 + evt.getComponent().getLocation().y);
613 if (comp != null && comp instanceof Checkbox)
615 target = (Checkbox) comp;
618 if (selectedCheck != null && target != null && selectedCheck != target)
620 int targetIndex = -1;
621 for (int i = 0; i < featurePanel.getComponentCount(); i++)
623 if (target == featurePanel.getComponent(i))
630 featurePanel.remove(selectedCheck);
631 featurePanel.add(selectedCheck, targetIndex);
632 featurePanel.validate();
633 itemStateChanged(null);
637 public void setUserColour(String feature, FeatureColourI originalColour)
639 fr.setColour(feature, originalColour);
643 public void refreshTable()
645 featurePanel.removeAll();
647 ap.paintAlignment(true);
651 public void mouseEntered(MouseEvent evt)
656 public void mouseExited(MouseEvent evt)
661 public void mouseClicked(MouseEvent evt)
663 MyCheckbox check = (MyCheckbox) evt.getSource();
664 if ((evt.getModifiers() & InputEvent.BUTTON3_MASK) != 0)
666 this.popupSort(check, fr.getMinMax(), evt.getX(), evt.getY());
669 if (check.getParent() != featurePanel)
674 if (evt.getClickCount() > 1)
676 FeatureColourI fcol = fr.getFeatureStyle(check.type);
677 if (fcol.isSimpleColour())
679 new UserDefinedColours(this, check.type, fcol.getColour());
683 new FeatureColourChooser(this, check.type);
684 // write back the current colour object to update the table
685 check.updateColor(fr.getFeatureStyle(check.type));
691 public void mouseMoved(MouseEvent evt)
696 public void adjustmentValueChanged(AdjustmentEvent evt)
698 fr.setTransparency((100 - transparency.getValue()) / 100f);
699 ap.seqPanel.seqCanvas.repaint();
703 class MyCheckbox extends Checkbox
707 public int stringWidth;
713 public void updateColor(FeatureColourI newcol)
716 if (col.isSimpleColour())
718 setBackground(col.getColour());
722 String vlabel = type;
723 if (col.isAboveThreshold())
727 else if (col.isBelowThreshold())
731 if (col.isColourByLabel())
733 setBackground(Color.white);
734 vlabel += " (by Label)";
738 setBackground(col.getMinColour());
740 this.setLabel(vlabel);
745 public MyCheckbox(String label, boolean checked, boolean haslink)
747 super(label, checked);
749 FontMetrics fm = av.nullFrame.getFontMetrics(av.nullFrame.getFont());
750 stringWidth = fm.stringWidth(label);
751 this.hasLink = haslink;
754 public MyCheckbox(String type, boolean selected, boolean b,
755 FeatureColourI featureStyle)
757 this(type, selected, b);
758 updateColor(featureStyle);
762 public void paint(Graphics g)
764 Dimension d = getSize();
767 if (col.isColourByLabel())
769 g.setColor(Color.white);
770 g.fillRect(d.width / 2, 0, d.width / 2, d.height);
772 * g.setColor(Color.black); Font f=g.getFont().deriveFont(9);
775 * // g.setFont(g.getFont().deriveFont( //
776 * AffineTransform.getScaleInstance( //
777 * width/g.getFontMetrics().stringWidth("Label"), //
778 * height/g.getFontMetrics().getHeight()))); g.drawString("Label",
783 else if (col.isGraduatedColour())
785 Color maxCol = col.getMaxColour();
787 g.fillRect(d.width / 2, 0, d.width / 2, d.height);
794 g.drawImage(linkImage, stringWidth + 25,
795 (getSize().height - linkImage.getHeight(this)) / 2, this);
801 * Hide columns containing (or not containing) a given feature type
804 * @param columnsContaining
806 void hideFeatureColumns(final String type, boolean columnsContaining)
808 if (ap.alignFrame.avc.markColumnsContainingFeatures(columnsContaining,
811 if (ap.alignFrame.avc.markColumnsContainingFeatures(
812 !columnsContaining, false, false, type))
814 ap.alignFrame.viewport.hideSelectedColumns();
820 public void mousePressed(MouseEvent e)
822 // TODO Auto-generated method stub