org.biojava.bio.gui.sequence
Class PaddingRenderer

java.lang.Object
  |
  +--org.biojava.utils.AbstractChangeable
        |
        +--org.biojava.bio.gui.sequence.SequenceRendererWrapper
              |
              +--org.biojava.bio.gui.sequence.PaddingRenderer

All Implemented Interfaces:

Changeable, SequenceRenderer, java.io.Serializable

public class PaddingRenderer

extends SequenceRendererWrapper

A renderer that adds padding before and after a delegate renderer.

Since:

1.2

Author:

Matthew Pocock

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class org.biojava.bio.gui.sequence.SequenceRenderer

SequenceRenderer.RendererForwarder

Field Summary

static ChangeType

PADDING Event type for when the size of the padding changes.

Fields inherited from class org.biojava.bio.gui.sequence.SequenceRendererWrapper

RENDERER

Constructor Summary

PaddingRenderer()
Build a new PaddingRenderer with zero padding.

PaddingRenderer(SequenceRenderer renderer, double padding)
Build a new PaddingRenderer that wraps renderer and has padding depth padding.

Method Summary

protected ChangeSupport	getChangeSupport(ChangeType ct) Called to retrieve the ChangeSupport for this object
double	getDepth(SequenceRenderContext src) Retrieve the depth of this renderer when rendering src.
double	getMinimumLeader(SequenceRenderContext src) Retrieve the minimum leading distance for this renderer when rendering src.
double	getMinimumTrailer(SequenceRenderContext src) Retrieve the minimum trailing distance for this renderer when rendering src.
double	getPadding() Retrieve the current padding.
protected boolean	hasListeners()
void	paint(java.awt.Graphics2D g, SequenceRenderContext src) Render a portion (possibly all) of the information for src to g, displaying all of the data that would fall within seqBox.
SequenceViewerEvent	processMouseEvent(SequenceRenderContext src, java.awt.event.MouseEvent me, java.util.List path) Produce a SequenceViewerEvent in response to a mouse gesture.
void	setPadding(double padding) Set the padding.
java.lang.String	toString()

Methods inherited from class org.biojava.bio.gui.sequence.SequenceRendererWrapper

getRenderer, setRenderer

Methods inherited from class org.biojava.utils.AbstractChangeable

addChangeListener, addChangeListener, generateChangeSupport, isUnchanging, removeChangeListener, removeChangeListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PADDING

public static ChangeType PADDING

Event type for when the size of the padding changes.

Constructor Detail

PaddingRenderer

public PaddingRenderer()

Build a new PaddingRenderer with zero padding.

This will cause a rendering effect equivalent to missing out the padding renderer all together.

PaddingRenderer

public PaddingRenderer(SequenceRenderer renderer,
                       double padding)

Build a new PaddingRenderer that wraps renderer and has padding depth padding.

Parameters:

renderer - the SequenceRenderer that will actually do the rendering

padding - the number of pixels to leave both before and after rendering the child renderer

Method Detail

hasListeners

protected boolean hasListeners()

Overrides:

hasListeners in class AbstractChangeable

getChangeSupport

protected ChangeSupport getChangeSupport(ChangeType ct)

Description copied from class: AbstractChangeable

Called to retrieve the ChangeSupport for this object

Overrides:

getChangeSupport in class SequenceRendererWrapper

setPadding

public void setPadding(double padding)
                throws ChangeVetoException

Set the padding.

The padding will be added to the area before and after that required to render the delegate renderer.

Parameters:

padding - the new padding size

Throws:

ChangeVetoException - if padding is negative or if any listener objected to the change

getPadding

public double getPadding()

Retrieve the current padding.

Returns:

the current padding

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

Overrides:

getDepth in class SequenceRendererWrapper

Parameters:

src - the SequenceRenderContext to return info for

Returns:

the depth of the renderer for that sequence panel

getMinimumLeader

public double getMinimumLeader(SequenceRenderContext src)

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

Overrides:

getMinimumLeader in class SequenceRendererWrapper

Parameters:

src - the SequenceRenderContext to return info for

Returns:

the leading distance of the renderer for that sequence panel

getMinimumTrailer

public double getMinimumTrailer(SequenceRenderContext src)

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

Overrides:

getMinimumTrailer in class SequenceRendererWrapper

Parameters:

src - the SequenceRenderContext to return info for

Returns:

the trailing distance of the renderer for that sequence panel

paint

public void paint(java.awt.Graphics2D g,
                  SequenceRenderContext src)

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

Overrides:

paint in class SequenceRendererWrapper

Parameters:

g - the Graphics2D to render to

src - the SequenceRenderContext that encapsulates the information to render

processMouseEvent

public SequenceViewerEvent processMouseEvent(SequenceRenderContext src,
                                             java.awt.event.MouseEvent me,
                                             java.util.List path)

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

Overrides:

processMouseEvent in class SequenceRendererWrapper

Parameters:

src - 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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object