Package org.biojava.bio.gui.sequence
Class SubPairwiseRenderContext
java.lang.Object
org.biojava.bio.gui.sequence.SubPairwiseRenderContext
- All Implemented Interfaces:
SwingConstants
,PairwiseRenderContext
,SequenceRenderContext
SubPairwiseRenderContext
is a rendering context
which wraps a delegate context and effectively hides some of the
delegate's properties with its own. If any of the
SymbolList
, FeatureHolder
or
RangeLocation
arguments are not null, their values are
returned. Otherwise the delegate's method is called and its return
value is returned instead.
- Since:
- 1.2
- Author:
- Keith James, Matthew Pocock
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.biojava.bio.gui.sequence.SequenceRenderContext
SequenceRenderContext.Border
-
Field Summary
Fields inherited from interface org.biojava.bio.gui.sequence.SequenceRenderContext
LAYOUT, REPAINT
Fields inherited from interface javax.swing.SwingConstants
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
-
Constructor Summary
ConstructorsConstructorDescriptionSubPairwiseRenderContext
(PairwiseRenderContext context, SymbolList symbols, SymbolList secondarySymbols, FeatureHolder features, FeatureHolder secondaryFeatures, RangeLocation range, RangeLocation secondaryRange) Creates a newSubPairwiseRenderContext
. -
Method Summary
Modifier and TypeMethodDescriptionint
Gets the direction in which this context expects sequences to be rendered - HORIZONTAL or VERTICAL.The features to render.getFont()
Gets the Font attribute of the SequenceRenderContext objectGets the LeadingBorder attribute of the SequenceRenderContext object.getRange()
The range of the SymbolList to render.double
getScale()
Gets the scale as pixels per Symbolint
getSecondaryDirection
returns the direction in which the secondary sequence is rendered.getSecondaryFeatures
returns the features on the secondary sequence.getSecondaryRange
returns the range of the secondary sequence currently rendered.getSecondarySymbols
returns the symbols of the secondary sequence.The SymbolList that is currently rendered by this SequenceRenderContext.Gets the TrailingBorder attribute of the SequenceRenderContext object.int
graphicsToSecondarySequence
(double graphicsPos) graphicsToSecondarySequence
converts a graphical position to a sequence coordinate on the secondary sequence.int
graphicsToSecondarySequence
(Point point) graphicsToSecondarySequence
converts a graphical position to a secondary sequence index.int
graphicsToSequence
(double graphicsPos) Converts a graphical position into a sequence coordinate.int
graphicsToSequence
(Point2D point) Converts a graphical position into a sequence coordinate.double
secondarySequenceToGraphics
(int sequencePos) secondarySequenceToGraphics
converts a sequence coordinate on the secondary sequence to a graphical position.double
sequenceToGraphics
(int sequencePos) Converts a sequence index into a graphical coordinate.
-
Constructor Details
-
SubPairwiseRenderContext
public SubPairwiseRenderContext(PairwiseRenderContext context, SymbolList symbols, SymbolList secondarySymbols, FeatureHolder features, FeatureHolder secondaryFeatures, RangeLocation range, RangeLocation secondaryRange) Creates a newSubPairwiseRenderContext
.- Parameters:
context
- aPairwiseRenderContext
to wrap. This should not be null.symbols
- aSymbolList
to use instead of the delegate's. May be null.secondarySymbols
- aSymbolList
to use instead of the delegate's. May be null.features
- aFeatureHolder
to use instead of the delegate's. May be null.secondaryFeatures
- aFeatureHolder
to use instead of the delegate's. May be null.range
- aRangeLocation
to use instead of the delegate's. May be null.secondaryRange
- aRangeLocation
to use instead of the delegate's. May be null.
-
-
Method Details
-
getSymbols
Description copied from interface:SequenceRenderContext
The SymbolList that is currently rendered by this SequenceRenderContext.- Specified by:
getSymbols
in interfaceSequenceRenderContext
- Returns:
- The Sequence value
-
getSecondarySymbols
Description copied from interface:PairwiseRenderContext
getSecondarySymbols
returns the symbols of the secondary sequence.- Specified by:
getSecondarySymbols
in interfacePairwiseRenderContext
- Returns:
- a
SymbolList
.
-
getFeatures
Description copied from interface:SequenceRenderContext
The features to render.- Specified by:
getFeatures
in interfaceSequenceRenderContext
- Returns:
- a FeatureHolder with the Features to render
-
getSecondaryFeatures
Description copied from interface:PairwiseRenderContext
getSecondaryFeatures
returns the features on the secondary sequence.- Specified by:
getSecondaryFeatures
in interfacePairwiseRenderContext
- Returns:
- a
FeatureHolder
.
-
getRange
Description copied from interface:SequenceRenderContext
The range of the SymbolList to render.- Specified by:
getRange
in interfaceSequenceRenderContext
- Returns:
- the RangeLocation specifying which indices (inclusive) to render
-
getSecondaryRange
Description copied from interface:PairwiseRenderContext
getSecondaryRange
returns the range of the secondary sequence currently rendered.- Specified by:
getSecondaryRange
in interfacePairwiseRenderContext
- Returns:
- a
RangeLocation
.
-
getDirection
Description copied from interface:SequenceRenderContext
Gets the direction in which this context expects sequences to be rendered - HORIZONTAL or VERTICAL.- Specified by:
getDirection
in interfaceSequenceRenderContext
- Returns:
- The Direction value
-
getSecondaryDirection
Description copied from interface:PairwiseRenderContext
getSecondaryDirection
returns the direction in which the secondary sequence is rendered. This may be either HORIZONTAL or VERTICAL.- Specified by:
getSecondaryDirection
in interfacePairwiseRenderContext
- Returns:
- an
int
.
-
getScale
Description copied from interface:SequenceRenderContext
Gets the scale as pixels per Symbol- Specified by:
getScale
in interfaceSequenceRenderContext
- Returns:
- The scale value
-
getLeadingBorder
Description copied from interface:SequenceRenderContext
Gets the LeadingBorder attribute of the SequenceRenderContext object. This represents the space between the beginning of the rendering area and the beginning of the sequence.- Specified by:
getLeadingBorder
in interfaceSequenceRenderContext
- Returns:
- The LeadingBorder value
-
getTrailingBorder
Description copied from interface:SequenceRenderContext
Gets the TrailingBorder attribute of the SequenceRenderContext object. This represents the space between the end of the sequence and the end of the rendering area.- Specified by:
getTrailingBorder
in interfaceSequenceRenderContext
- Returns:
- The TrailingBorder value
-
sequenceToGraphics
Description copied from interface:SequenceRenderContext
Converts a sequence index into a graphical coordinate. You will need to use this in conjunction with getDirection to correctly lay graphics out.- Specified by:
sequenceToGraphics
in interfaceSequenceRenderContext
- Parameters:
sequencePos
- Index within the sequence- Returns:
- Equivalent graphical position in pixels
-
secondarySequenceToGraphics
Description copied from interface:PairwiseRenderContext
secondarySequenceToGraphics
converts a sequence coordinate on the secondary sequence to a graphical position.- Specified by:
secondarySequenceToGraphics
in interfacePairwiseRenderContext
- Parameters:
sequencePos
- anint
.- Returns:
- a
double
.
-
graphicsToSequence
Description copied from interface:SequenceRenderContext
Converts a graphical position into a sequence coordinate. You will need to have used getDirection to decide whether to use the x or y coordinate.- Specified by:
graphicsToSequence
in interfaceSequenceRenderContext
- Parameters:
graphicsPos
- A pixel position- Returns:
- The corresponding sequence index
-
graphicsToSequence
Description copied from interface:SequenceRenderContext
Converts a graphical position into a sequence coordinate. This will use getDirection to decide whether to use the x or y coordinate.- Specified by:
graphicsToSequence
in interfaceSequenceRenderContext
- Parameters:
point
- a point representing the position- Returns:
- the corresponding sequence index
-
graphicsToSecondarySequence
Description copied from interface:PairwiseRenderContext
graphicsToSecondarySequence
converts a graphical position to a sequence coordinate on the secondary sequence.- Specified by:
graphicsToSecondarySequence
in interfacePairwiseRenderContext
- Parameters:
graphicsPos
- adouble
.- Returns:
- an
int
.
-
graphicsToSecondarySequence
Description copied from interface:PairwiseRenderContext
graphicsToSecondarySequence
converts a graphical position to a secondary sequence index.- Specified by:
graphicsToSecondarySequence
in interfacePairwiseRenderContext
- Parameters:
point
- aPoint
.- Returns:
- an
int
.
-
getFont
Description copied from interface:SequenceRenderContext
Gets the Font attribute of the SequenceRenderContext object- Specified by:
getFont
in interfaceSequenceRenderContext
- Returns:
- The Font value
-