X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fapi%2FAlignExportSettingsI.java;fp=src%2Fjalview%2Fapi%2FAlignExportSettingI.java;h=e4ef584eca05a9de589bc9b0b012e67b5607b4ed;hb=ec8f3cedf60fb1feed6d34de6b49f6bfa78b9dd8;hp=18f529b05f104d2ca4070cb9fe9ae99d9df17a20;hpb=056dad85a910551cc95e44d451a61f6b8c4dd35d;p=jalview.git diff --git a/src/jalview/api/AlignExportSettingI.java b/src/jalview/api/AlignExportSettingsI.java similarity index 51% rename from src/jalview/api/AlignExportSettingI.java rename to src/jalview/api/AlignExportSettingsI.java index 18f529b..e4ef584 100644 --- a/src/jalview/api/AlignExportSettingI.java +++ b/src/jalview/api/AlignExportSettingsI.java @@ -22,52 +22,57 @@ package jalview.api; /** - * Abstract interface implemented by Alignment Export dialog to retrieve user - * configurations - * - * @author tcnofoegbu + * An interface describing settings for including or excluding data when an + * alignment is output * */ -public interface AlignExportSettingI +public interface AlignExportSettingsI { /** - * Checks if hidden sequences should be exported + * Answers true if hidden sequences should be exported, false if not * * @return */ - public boolean isExportHiddenSequences(); + boolean isExportHiddenSequences(); /** - * Checks if hidden columns shoulb be exported + * Answers true if hidden columns should be exported, false if not * * @return */ - public boolean isExportHiddenColumns(); + boolean isExportHiddenColumns(); /** - * Checks if Annotations should be exported, note this is available for - * complex flat file exports like JSON, HTML, GFF + * Answers true if Annotations should be exported. This is available for + * complex flat file exports like JSON, HTML, GFF. * * @return */ - public boolean isExportAnnotations(); + boolean isExportAnnotations(); /** - * Checks if SequenceFeatures should be exported, note this is available for - * complex flat file exports like JSON, HTML, GFF + * Answers true if Sequence Features should be exported. This is available for + * complex flat file exports like JSON, HTML, GFF. * * @return */ - public boolean isExportFeatures(); + boolean isExportFeatures(); /** - * Checks if SequenceGroups should be exported, note this is available for - * complex flat file exports like JSON, HTML, GFF + * Answers true if Sequence Groups should be exported. This is available for + * complex flat file exports like JSON, HTML, GFF. * * @return */ - public boolean isExportGroups(); + boolean isExportGroups(); + + void setExportHiddenSequences(boolean b); + + void setExportHiddenColumns(boolean b); + + void setExportAnnotations(boolean b); - public boolean isCancelled(); + void setExportFeatures(boolean b); + void setExportGroups(boolean b); }