Class AbstractBeadRenderer

  • All Implemented Interfaces:
    Serializable, BeadFeatureRenderer, FeatureRenderer, Changeable
    Direct Known Subclasses:
    EllipticalBeadRenderer, RectangularBeadRenderer, RoundRectangularBeadRenderer

    public abstract class AbstractBeadRenderer
    extends AbstractChangeable
    implements BeadFeatureRenderer, Serializable

    AbstractBeadRenderer is a an abstract base class for the creation of FeatureRenderers which use a 'string of beads' metaphor for displaying features. Each subclass of AbstractBeadRenderer should override the abstract method renderBead() and provide the drawing routine for its particular bead type.

    A concrete BeadFeatureRenderer may render a series of features in more than one style by delegating to other BeadFeatureRenderers for the additional style(s). This is achieved using the setDelegateRenderer() method which associates an OptimizableFilter with another BeadFeatureRenderer. Any feature accepted by the filter is rendered with that renderer, while the remainder are rendered by the current renderer.

    Keith James, Paul Seed
    See Also:
    Serialized Form
    • Constructor Detail

      • AbstractBeadRenderer

        public AbstractBeadRenderer()
        Creates a new AbstractBeadRenderer with no delegates. It will render all features itself, using its own style settings.
      • AbstractBeadRenderer

        public AbstractBeadRenderer​(double beadDepth,
                                    double beadDisplacement,
                                    Paint beadOutline,
                                    Paint beadFill,
                                    Stroke beadStroke)
        Creates a new AbstractBeadRenderer object.
        beadDepth - a double.
        beadDisplacement - a double.
        beadOutline - a Paint.
        beadFill - a Paint.
        beadStroke - a Stroke.
    • Method Detail

      • renderFeature

        public void renderFeature​(Graphics2D g2,
                                  Feature f,
                                  SequenceRenderContext context)
        renderFeature draws a feature using the supplied graphics context. The rendering may be delegated to another FeatureRenderer instance.
        Specified by:
        renderFeature in interface FeatureRenderer
        g2 - a Graphics2D context.
        f - a Feature to render.
        context - a SequenceRenderContext context.
      • removeDelegateRenderer

        public void removeDelegateRenderer​(OptimizableFilter filter)
        removeDelegateRenderer removes any association of the given OptimizableFilter with a BeadFeatureRenderer.
        filter - an OptimizableFilter.
      • getDepth

        public double getDepth​(SequenceRenderContext context)
        getDepth calculates the depth required by this renderer to display its beads. It recurses through its delegate renderers and returns the highest value. Concrete renderers should override this method and supply code to calculate their own depth. If a subclass needs to know the depth of its delegates (as is likely if it has any) they can call this method using super.getDepth().
        Specified by:
        getDepth in interface FeatureRenderer
        context - a SequenceRenderContext.
        a double.
      • getBeadDisplacement

        public double getBeadDisplacement()
        getBeadDisplacement returns the displacement of beads from the centre line of the renderer. A positive value indicates displacment downwards (for horizontal renderers) or to the right (for vertical renderers).
        Specified by:
        getBeadDisplacement in interface BeadFeatureRenderer
        a double.
      • setBeadDisplacement

        public void setBeadDisplacement​(double displacement)
                                 throws ChangeVetoException
        setBeadDisplacement sets the displacement of beads from the centre line of the renderer. A positive value indicates displacment downwards (for horizontal renderers) or to the right (for vertical renderers).
        displacement - a double.
        ChangeVetoException - if an error occurs.
      • getBeadOutline

        public Paint getBeadOutline()
        getBeadOutline returns the bead outline paint.
        a Paint.
      • getBeadStroke

        public Stroke getBeadStroke()
        getBeadStroke returns the bead outline stroke.
        a Stroke.
      • getBeadFill

        public Paint getBeadFill()
        getBeadFill returns the bead fill paint.
        a Paint.