X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fapi%2FAlignViewportI.java;h=8482f6b2a9441f80e1198c8adf6b53e7b76acf6c;hb=5d59bb58f5bcecc6b240d125e13bbe1f1868f681;hp=60ee8d5162cdc2d35b6845d366a6ce007bd548ad;hpb=9de04d9b678021165d2f6df691234e7ad7b16f88;p=jalview.git diff --git a/src/jalview/api/AlignViewportI.java b/src/jalview/api/AlignViewportI.java index 60ee8d5..8482f6b 100644 --- a/src/jalview/api/AlignViewportI.java +++ b/src/jalview/api/AlignViewportI.java @@ -1,6 +1,6 @@ /* - * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2) - * Copyright (C) 2014 The Jalview Authors + * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$) + * Copyright (C) $$Year-Rel$$ The Jalview Authors * * This file is part of Jalview. * @@ -20,6 +20,11 @@ */ package jalview.api; +import java.awt.Color; +import java.util.Hashtable; +import java.util.List; +import java.util.Map; + import jalview.analysis.Conservation; import jalview.datamodel.AlignmentAnnotation; import jalview.datamodel.AlignmentI; @@ -31,24 +36,15 @@ import jalview.datamodel.SequenceGroup; import jalview.datamodel.SequenceI; import jalview.schemes.ColourSchemeI; -import java.awt.Color; -import java.util.Hashtable; -import java.util.List; -import java.util.Map; - /** * @author jimp * */ -public interface AlignViewportI +public interface AlignViewportI extends ViewStyleI { - int getCharWidth(); - int getEndRes(); - int getCharHeight(); - /** * calculate the height for visible annotation, revalidating bounds where * necessary ABSTRACT GUI METHOD @@ -75,11 +71,16 @@ public interface AlignViewportI Hashtable[] getSequenceConsensusHash(); - Hashtable[] getRnaStructureConsensusHash(); + /** + * Get consensus data table for the cDNA complement of this alignment (if any) + * + * @return + */ + Hashtable[] getComplementConsensusHash(); - boolean getIgnoreGapsConsensus(); + Hashtable[] getRnaStructureConsensusHash(); - boolean getCentreColumnLabels(); + boolean isIgnoreGapsConsensus(); boolean isCalculationInProgress(AlignmentAnnotation alignmentAnnotation); @@ -95,6 +96,13 @@ public interface AlignViewportI AlignmentAnnotation getAlignmentConsensusAnnotation(); /** + * get the container for cDNA complement consensus annotation + * + * @return + */ + AlignmentAnnotation getComplementConsensusAnnotation(); + + /** * Test to see if viewport is still open and active * * @return true indicates that all references to viewport should be dropped @@ -122,6 +130,13 @@ public interface AlignViewportI void setSequenceConsensusHash(Hashtable[] hconsensus); /** + * Set the cDNA complement consensus for the viewport + * + * @param hconsensus + */ + void setComplementConsensusHash(Hashtable[] hconsensus); + + /** * * @return the alignment annotatino row for the structure consensus * calculation @@ -164,29 +179,6 @@ public interface AlignViewportI void updateGroupAnnotationSettings(boolean applyGlobalSettings, boolean preserveNewGroupSettings); - /** - * @return true if a reference sequence is set and should be displayed - */ - public boolean isDisplayReferenceSeq(); - - /** - * @return set the flag for displaying reference sequences when they are - * available - */ - public void setDisplayReferenceSeq(boolean displayReferenceSeq); - - /** - * @return true if colourschemes should render according to reference sequence - * rather than consensus if available - */ - public boolean isColourByReferenceSeq(); - - /** - * @return true set flag for deciding if colourschemes should render according - * to reference sequence rather than consensus if available - */ - public void setColourByReferenceSeq(boolean colourByReferenceSeq); - void setSequenceColour(SequenceI seq, Color col); Color getSequenceColour(SequenceI seq); @@ -269,35 +261,8 @@ public interface AlignViewportI String getSequenceSetId(); - boolean isShowSequenceFeatures(); - - void setShowSequenceFeatures(boolean b); - - /** - * - * @param flag - * indicating if annotation panel shown below alignment - * - */ - void setShowAnnotation(boolean b); - - /** - * flag indicating if annotation panel shown below alignment - * - * @return - */ - boolean isShowAnnotation(); - - boolean isRightAlignIds(); - - void setRightAlignIds(boolean rightAlignIds); - boolean areFeaturesDisplayed(); - void setShowSequenceFeaturesHeight(boolean selected); - - boolean isShowSequenceFeaturesHeight(); - void setFeaturesDisplayed(FeaturesDisplayedI featuresDisplayedI); void alignmentChanged(AlignmentViewPanel ap); @@ -320,10 +285,9 @@ public interface AlignViewportI * first column (inclusive, from 0) * @param max * last column (exclusive) - * @return int[][] range of {start,end} visible positions TODO: change to list - * of int ranges + * @return int[][] range of {start,end} visible positions */ - int[][] getVisibleRegionBoundaries(int min, int max); + List getVisibleRegionBoundaries(int min, int max); /** * This method returns an array of new SequenceI objects derived from the @@ -352,4 +316,60 @@ public interface AlignViewportI */ int adjustForHiddenSeqs(int alignmentIndex); + boolean hasHiddenRows(); + + /** + * + * @return a copy of this view's current display settings + */ + public ViewStyleI getViewStyle(); + + /** + * update the view's display settings with the given style set + * + * @param settingsForView + */ + public void setViewStyle(ViewStyleI settingsForView); + + /** + * Returns a viewport which holds the cDna for this (protein), or vice versa, + * or null if none is set. + * + * @return + */ + AlignViewportI getCodingComplement(); + + /** + * Sets the viewport which holds the cDna for this (protein), or vice versa. + * Implementation should guarantee that the reciprocal relationship is always + * set, i.e. each viewport is the complement of the other. + */ + void setCodingComplement(AlignViewportI sl); + + /** + * Answers true if viewport hosts DNA/RNA, else false. + * + * @return + */ + boolean isNucleotide(); + + /** + * Returns an id guaranteed to be unique for this viewport. + * + * @return + */ + String getViewId(); + + /** + * Return true if view should scroll to show the highlighted region of a + * sequence + * + * @return + */ + boolean isFollowHighlight(); + + /** + * Set whether view should scroll to show the highlighted region of a sequence + */ + void setFollowHighlight(boolean b); }