Class SequenceRendererWrapper
- All Implemented Interfaces:
Serializable
,SequenceRenderer
,Changeable
- Direct Known Subclasses:
AlignmentRenderer
,BumpedRenderer
,FilteringRenderer
,GappedRenderer
,PaddingRenderer
This takes care of all event notification and method invocation for you. Subclass this and over-ride methods, and then possibly call the method on super to forward the call on to the wrapped renderer.
- Author:
- Matthew Pocock
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.biojava.bio.gui.sequence.SequenceRenderer
SequenceRenderer.RendererForwarder
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionCreate a new renderer with no wrapped renderer.SequenceRendererWrapper
(SequenceRenderer renderer) Create a new wrapper with a wrapped renderer -
Method Summary
Modifier and TypeMethodDescriptionprotected ChangeSupport
Called to retrieve the ChangeSupport for this object.double
Retrieve the depth of this renderer when rendering src.double
Retrieve the minimum leading distance for this renderer when rendering src.double
Retrieve the minimum trailing distance for this renderer when rendering src.void
paint
(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.processMouseEvent
(SequenceRenderContext src, MouseEvent me, List path) Produce a SequenceViewerEvent in response to a mouse gesture.void
setRenderer
(SequenceRenderer renderer) Methods inherited from class org.biojava.utils.AbstractChangeable
addChangeListener, addChangeListener, generateChangeSupport, hasListeners, hasListeners, isUnchanging, removeChangeListener, removeChangeListener
-
Field Details
-
RENDERER
-
-
Constructor Details
-
SequenceRendererWrapper
public SequenceRendererWrapper()Create a new renderer with no wrapped renderer. It is important that you call setRenderer() on this instance before trying to use it to display anything. -
SequenceRendererWrapper
Create a new wrapper with a wrapped renderer- Parameters:
renderer
- the SequenceRenderer to wrap up
-
-
Method Details
-
getChangeSupport
Description copied from class:AbstractChangeable
Called to retrieve the ChangeSupport for this object.Your implementation of this method should have the following structure:
It is usual for the forwarding listeners (someForwarder in this example) to be transient and lazily instantiated. Be sure to register invalid input: '&' unregister the forwarder in the code that does the ChangeEvent handling in setter methods.ChangeSupport cs = super.getChangeSupport(ct); if(someForwarder == null invalid input: '&'invalid input: '&' ct.isMatching(SomeInterface.SomeChangeType)) { someForwarder = new ChangeForwarder(... this.stateVariable.addChangeListener(someForwarder, VariableInterface.AChange); } return cs;
- Overrides:
getChangeSupport
in classAbstractChangeable
-
setRenderer
- Throws:
ChangeVetoException
-
getRenderer
-
getDepth
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 interfaceSequenceRenderer
- Parameters:
src
- the SequenceRenderContext to return info for- Returns:
- the depth of the renderer for that sequence panel
-
getMinimumLeader
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 interfaceSequenceRenderer
- Parameters:
src
- the SequenceRenderContext to return info for- Returns:
- the leading distance of the renderer for that sequence panel
-
getMinimumTrailer
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 interfaceSequenceRenderer
- Parameters:
src
- the SequenceRenderContext to return info for- Returns:
- the trailing distance of the renderer for that sequence panel
-
paint
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 interfaceSequenceRenderer
- Parameters:
g
- the Graphics2D to render tosrc
- 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 interfaceSequenceRenderer
- Parameters:
src
- the SequenceRenderContext currently in scopeme
- a MouseEvent that caused this requestpath
- the List of SequenceRenderer instances passed through so far- Returns:
- a SequenceViewerEvent encapsulating the mouse gesture
-