Merge branch 'develop' into releases/Release_2_11_Branch
[jalview.git] / src / jalview / commands / TrimRegionCommand.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
4  * 
5  * This file is part of Jalview.
6  * 
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.
11  *  
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.
16  * 
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.
20  */
21 package jalview.commands;
22
23 import jalview.datamodel.AlignmentI;
24 import jalview.datamodel.SequenceI;
25
26 public class TrimRegionCommand extends EditCommand
27 {
28   int columnsDeleted;
29
30   /**
31    * Constructs and performs a trim alignment command
32    * 
33    * @param description
34    *          (to show in Undo/Redo menu)
35    * @param trimLeft
36    *          if true trim to left of column, else to right
37    * @param seqs
38    *          the sequences to trim
39    * @param column
40    *          the alignment column (base 0) from which to trim
41    * @param al
42    */
43   public TrimRegionCommand(String description, boolean trimLeft,
44           SequenceI[] seqs, int column, AlignmentI al)
45   {
46     this.description = description;
47     if (trimLeft)
48     {
49       if (column == 0)
50       {
51         return;
52       }
53
54       columnsDeleted = column;
55
56       setEdit(new Edit(Action.CUT, seqs, 0, column, al));
57     }
58     else
59     {
60       int width = al.getWidth() - column - 1;
61       if (width < 1)
62       {
63         return;
64       }
65
66       columnsDeleted = width;
67
68       setEdit(new Edit(Action.CUT, seqs, column + 1, width, al));
69     }
70
71     performEdit(0, null);
72   }
73
74   @Override
75   public int getSize()
76   {
77     return columnsDeleted;
78   }
79
80 }