Interface SequenceRenderContext

All Superinterfaces:
SwingConstants
All Known Subinterfaces:
PairwiseRenderContext
All Known Implementing Classes:
HeadlessRenderContext, PairwiseSequencePanel, SequencePanel, SequencePoster, SubPairwiseRenderContext, SubSequenceRenderContext, TranslatedSequencePanel

public interface SequenceRenderContext extends SwingConstants
A context within which sequence information may be rendered. It encapsulates the rendering direction, the size of the leading and trailing (header/footer, left/right areas), scale and the currently rendered symbols, features and region.
Author:
Thomas Down, Matthew Pocock
  • Field Details

  • Method Details

    • getDirection

      Gets the direction in which this context expects sequences to be rendered - HORIZONTAL or VERTICAL.
      Returns:
      The Direction value
    • getScale

      double getScale()
      Gets the scale as pixels per Symbol
      Returns:
      The scale value
    • sequenceToGraphics

      double sequenceToGraphics(int i)
      Converts a sequence index into a graphical coordinate. You will need to use this in conjunction with getDirection to correctly lay graphics out.
      Parameters:
      i - Index within the sequence
      Returns:
      Equivalent graphical position in pixels
    • graphicsToSequence

      int graphicsToSequence(double d)
      Converts a graphical position into a sequence coordinate. You will need to have used getDirection to decide whether to use the x or y coordinate.
      Parameters:
      d - A pixel position
      Returns:
      The corresponding sequence index
    • graphicsToSequence

      Converts a graphical position into a sequence coordinate. This will use getDirection to decide whether to use the x or y coordinate.
      Parameters:
      point - a point representing the position
      Returns:
      the corresponding sequence index
    • getSymbols

      The SymbolList that is currently rendered by this SequenceRenderContext.
      Returns:
      The Sequence value
    • getFeatures

      The features to render.
      Returns:
      a FeatureHolder with the Features to render
    • getRange

      The range of the SymbolList to render.
      Returns:
      the RangeLocation specifying which indices (inclusive) to render
    • getLeadingBorder

      Gets the LeadingBorder attribute of the SequenceRenderContext object. This represents the space between the beginning of the rendering area and the beginning of the sequence.
      Returns:
      The LeadingBorder value
    • getTrailingBorder

      Gets the TrailingBorder attribute of the SequenceRenderContext object. This represents the space between the end of the sequence and the end of the rendering area.
      Returns:
      The TrailingBorder value
    • getFont

      Gets the Font attribute of the SequenceRenderContext object
      Returns:
      The Font value