Class RulerRenderer

java.lang.Object
org.biojava.bio.gui.sequence.RulerRenderer
All Implemented Interfaces:
SequenceRenderer

public class RulerRenderer extends Object implements SequenceRenderer

RulerRenderer renders numerical scales in sequence coordinates. The tick direction may be set to point upwards (or left when the scale is vertical) or downwards (right when the scale is vertical).

Note: The Compaq Java VMs 1.3.1 - 1.4.0 on Tru64 appear to have a bug in font transformation which prevents a vertically oriented ruler displaying correctly rotated text.

Author:
Matthew Pocock, Thomas Down, David Huen, Keith James, Kalle Näslund
  • Field Details

    • TICKS_UP

      public static final int TICKS_UP
      TICKS_UP indicates that the ticks will point upwards from a baseline.
      See Also:
    • TICKS_DOWN

      public static final int TICKS_DOWN
      TICKS_DOWN indicates that the ticks will point downwards from a baseline.
      See Also:
  • Constructor Details

  • Method Details

    • getMinimumLeader

      public double getMinimumLeader(SequenceRenderContext context)
      Description copied from interface: SequenceRenderer
      Retrieve the minimum leading distance for this renderer when rendering src.

      The leading distance may vary between sequence panels - for example based upon sequence length.

      Specified by:
      getMinimumLeader in interface SequenceRenderer
      Parameters:
      context - the SequenceRenderContext to return info for
      Returns:
      the leading distance of the renderer for that sequence panel
    • getMinimumTrailer

      public double getMinimumTrailer(SequenceRenderContext context)
      Description copied from interface: SequenceRenderer
      Retrieve the minimum trailing distance for this renderer when rendering src.

      The trailing distance may vary between sequence panels - for example based upon sequence length.

      Specified by:
      getMinimumTrailer in interface SequenceRenderer
      Parameters:
      context - the SequenceRenderContext to return info for
      Returns:
      the trailing distance of the renderer for that sequence panel
    • getDepth

      public double getDepth(SequenceRenderContext src)
      Description copied from interface: SequenceRenderer
      Retrieve the depth of this renderer when rendering src.

      The depth may vary between sequence panels - for example based upon sequence length. Each line of information in the SequenceRendererContext only renders a region of the sequence. The depth for one complete line may be different from that for another due to the sequence having more or less information in that region to show. For example, a feature renderer implementation may chose to collapse down to a depth of zero pixels if there are no features to render within a region.

      Specified by:
      getDepth in interface SequenceRenderer
      Parameters:
      src - the SequenceRenderContext to return info for
      Returns:
      the depth of the renderer for that sequence panel
    • paint

      public void paint(Graphics2D g2, SequenceRenderContext context)
      Description copied from interface: SequenceRenderer
      Render a portion (possibly all) of the information for src to g, displaying all of the data that would fall within seqBox.
      Specified by:
      paint in interface SequenceRenderer
      Parameters:
      g2 - the Graphics2D to render to
      context - the SequenceRenderContext that encapsulates the information to render
    • processMouseEvent

      Description copied from interface: SequenceRenderer
      Produce a SequenceViewerEvent in response to a mouse gesture.

      A SequenceRenderer that performs any form of coordinate remapping should ensure that it appropriately transforms the mouse event. However, in the SequenceViewerEvent returned, the MouseEvent should be in untransformed coordinates.

      The SequenceRenderer implementation should append itself to the path list before constructing the SequenceViewerEvent.

      Specified by:
      processMouseEvent in interface SequenceRenderer
      Parameters:
      context - the SequenceRenderContext currently in scope
      me - a MouseEvent that caused this request
      path - the List of SequenceRenderer instances passed through so far
      Returns:
      a SequenceViewerEvent encapsulating the mouse gesture