Class RulerRenderer
- All Implemented Interfaces:
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
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.biojava.bio.gui.sequence.SequenceRenderer
SequenceRenderer.RendererForwarder
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
TICKS_DOWN
indicates that the ticks will point downwards from a baseline.static final int
TICKS_UP
indicates that the ticks will point upwards from a baseline. -
Constructor Summary
ConstructorsConstructorDescriptionCreates a newRulerRenderer
with the default setting of ticks pointing downwards.RulerRenderer
(int tickDirection) Creates a newRulerRenderer
with the specified tick direction. -
Method Summary
Modifier and TypeMethodDescriptiondouble
Retrieve the depth of this renderer when rendering src.double
getMinimumLeader
(SequenceRenderContext context) Retrieve the minimum leading distance for this renderer when rendering src.double
getMinimumTrailer
(SequenceRenderContext context) Retrieve the minimum trailing distance for this renderer when rendering src.void
paint
(Graphics2D g2, SequenceRenderContext context) Render a portion (possibly all) of the information for src to g, displaying all of the data that would fall within seqBox.processMouseEvent
(SequenceRenderContext context, MouseEvent me, List path) Produce a SequenceViewerEvent in response to a mouse gesture.
-
Field Details
-
TICKS_UP
TICKS_UP
indicates that the ticks will point upwards from a baseline.- See Also:
-
TICKS_DOWN
TICKS_DOWN
indicates that the ticks will point downwards from a baseline.- See Also:
-
-
Constructor Details
-
RulerRenderer
Creates a newRulerRenderer
with the default setting of ticks pointing downwards.- Throws:
IllegalArgumentException
-
RulerRenderer
Creates a newRulerRenderer
with the specified tick direction.- Parameters:
tickDirection
- anint
.- Throws:
IllegalArgumentException
- if an error occurs.
-
-
Method Details
-
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:
context
- 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:
context
- the SequenceRenderContext to return info for- Returns:
- the trailing distance of the renderer for that sequence panel
-
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
-
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:
g2
- the Graphics2D to render tocontext
- the SequenceRenderContext that encapsulates the information to render
-
processMouseEvent
public SequenceViewerEvent processMouseEvent(SequenceRenderContext context, MouseEvent me, 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 interfaceSequenceRenderer
- Parameters:
context
- 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
-