X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fapi%2FAlignViewControllerI.java;h=35f084fd3fd4043933cefc7d45cc8ac463d9efa6;hb=d305e02d8b425bb501141ad32142aeb8572adc57;hp=1d1e5fb9aedaf2dfdcffbccd04d8a8dfd788848e;hpb=b89d9889b3cc4ef1fd81de15edfd94ff9c426fa5;p=jalview.git diff --git a/src/jalview/api/AlignViewControllerI.java b/src/jalview/api/AlignViewControllerI.java index 1d1e5fb..35f084f 100644 --- a/src/jalview/api/AlignViewControllerI.java +++ b/src/jalview/api/AlignViewControllerI.java @@ -1,14 +1,39 @@ +/* + * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2) + * Copyright (C) 2014 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. + * + * 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 Jalview. If not, see . + * The Jalview Authors are detailed in the 'AUTHORS' file. + */ package jalview.api; /** * prototype abstract controller for a Jalview alignment view + * * @author jimp * - * All operations should return true if the view has changed as a result of the operation - * @param - * + * All operations should return true if the view has changed as a result + * of the operation + * + * The controller holds methods that operate on an alignment view, + * modifying its state in some way that may result in side effects + * reflected in an associated GUI + * */ -public interface AlignViewControllerI +public interface AlignViewControllerI { public boolean makeGroupsFromSelection(); @@ -19,8 +44,24 @@ public interface AlignViewControllerI public boolean deleteGroups(); - public void setViewportAndAlignmentPanel(AlignViewportI viewport, AlignmentViewPanel alignPanel); + public void setViewportAndAlignmentPanel(AlignViewportI viewport, + AlignmentViewPanel alignPanel); - boolean markColumnsContainingFeatures(boolean invert, String featureType); + /** + * Mark columns in the current column selection according to positions of + * sequence features + * + * @param invert + * - when set, mark all but columns containing given type + * @param extendCurrent + * - when set, do not clear existing column selection + * @param toggle + * - rather than explicitly set, toggle selection state + * @param featureType + * - feature type string + * @return true if operation affected state + */ + boolean markColumnsContainingFeatures(boolean invert, + boolean extendCurrent, boolean clearColumns, String featureType); }