X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fapi%2FAlignViewControllerI.java;h=35f084fd3fd4043933cefc7d45cc8ac463d9efa6;hb=5893c4925975c697f345f37c27e53b149c0ab6ac;hp=be845bc5e1666bf336e664f89349a65db2c5e2c4;hpb=47168f025aefdaa044802bd5f8f510ffe43a4808;p=jalview.git diff --git a/src/jalview/api/AlignViewControllerI.java b/src/jalview/api/AlignViewControllerI.java index be845bc..35f084f 100644 --- a/src/jalview/api/AlignViewControllerI.java +++ b/src/jalview/api/AlignViewControllerI.java @@ -22,13 +22,18 @@ 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(); @@ -39,16 +44,24 @@ public interface AlignViewControllerI public boolean deleteGroups(); - public void setViewportAndAlignmentPanel(AlignViewportI viewport, AlignmentViewPanel alignPanel); + public void setViewportAndAlignmentPanel(AlignViewportI viewport, + AlignmentViewPanel alignPanel); /** - * 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 + * 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); + boolean markColumnsContainingFeatures(boolean invert, + boolean extendCurrent, boolean clearColumns, String featureType); }