Package annotationMark

Class MarkOverlayDraw

java.lang.Object

PamView.PanelOverlayDraw

PamView.PamDetectionOverlayGraphics

annotationMark.MarkOverlayDraw

Direct Known Subclasses:

QuickAnnotationOverlayDraw

public class MarkOverlayDraw
extends PamDetectionOverlayGraphics

Field Summary

Fields

Modifier and Type	Field	Description
static final SymbolData	defaultSymbolData

Fields inherited from class PamView.PamDetectionOverlayGraphics

lineColour, locColour, pamSymbol

Constructor Summary

Constructors

Constructor	Description
MarkOverlayDraw(MarkDataBlock markDataBlock, MarkModule annotationModule)

Method Summary

Modifier and Type	Method	Description
boolean	canDraw(GeneralProjector.ParameterType[] parameterTypes, GeneralProjector.ParameterUnits[] parameterUnits)	Used to tell the various displays whether or not the data in the parentDataBlock can be drawn on each of those displays.
PamKeyItem	createKeyItem(GeneralProjector generalProjector, int keyType)	Gets information for making up a key on various displays.
Rectangle	drawOnSpectrogram(Graphics g, PamDataUnit pamDataUnit, GeneralProjector generalProjector)	Draw on spectrogram changed March 2010 so that the default time unit is milliseconds (Java time from 1970) rather than samples.
PamSymbol	getDefaultSymbol()
String	getHoverText(GeneralProjector generalProjector, PamDataUnit dataUnit, int iSide)	Get tool tip content for the data unit for this projector.
boolean	hasOptionsDialog(GeneralProjector generalProjector)
boolean	showOptions(Window parentWindow, GeneralProjector generalProjector)	Show an options dialog for a particular projector.

Methods inherited from class PamView.PamDetectionOverlayGraphics

canDraw, canDrawOnMap, canDrawOnRadar, canDrawOnSpectrogram, drawAmplitudeOnRadar, drawDataUnit, drawLineAndSymbol, drawLineAndSymbol, drawLineAndSymbol, drawLineOnly, drawOnMap, drawRangeOnRadar, drawSlantOnRadar, getDefaultRange, getHoverImage, getHoverTextWithoutWrap, getHydrophones, getLineColor, getLineColour, getLocColour, getMenuKeyItem, getPamSymbol, getParentDataBlock, getPerspectiveSymbol, getSymbolInfo, isDetectionData, setDefaultRange, setDetectionData, setLineColor, setLineColour, setLocColour

Methods inherited from class PamView.PanelOverlayDraw

preDrawAnything, setDefaultSymbol

Methods inherited from class java.lang.Object

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

Field Details

defaultSymbolData

public static final SymbolData defaultSymbolData

Constructor Details

MarkOverlayDraw

public MarkOverlayDraw(MarkDataBlock markDataBlock,
 MarkModule annotationModule)

Method Details

drawOnSpectrogram

public Rectangle drawOnSpectrogram(Graphics g,
 PamDataUnit pamDataUnit,
 GeneralProjector generalProjector)

Description copied from class: PamDetectionOverlayGraphics

Draw on spectrogram changed March 2010 so that the default time unit is milliseconds (Java time from 1970) rather than samples. This makes it posible to work with data collected over multiple files when operating in viewer mode.

Overrides:

drawOnSpectrogram in class PamDetectionOverlayGraphics

Parameters:

g -

pamDataUnit -

generalProjector -

Returns:

updated rectangle

canDraw

public boolean canDraw(GeneralProjector.ParameterType[] parameterTypes,
 GeneralProjector.ParameterUnits[] parameterUnits)

Description copied from class: PamDetectionOverlayGraphics

Used to tell the various displays whether or not the data in the parentDataBlock can be drawn on each of those displays. This is based purely on the axis types of the displays and whether or not the parentDataBlock's data untits are likely to have data which can transform into those axis types.

Overrides:

canDraw in class PamDetectionOverlayGraphics

Parameters:

parameterTypes - parameter types

parameterUnits - parameter units.

Returns:

true if the data can be (probably) drawn using this projector.

createKeyItem

public PamKeyItem createKeyItem(GeneralProjector generalProjector,
 int keyType)

Description copied from class: PamDetectionOverlayGraphics

Gets information for making up a key on various displays. PamKeyItem is not yet implemented.

Overrides:

createKeyItem in class PamDetectionOverlayGraphics

Parameters:

generalProjector - Reference to a GeneralProjector responsible for drawing with the PAnelOverlayDraw implementation

keyType - Draw a more complicated key, giving more detail

Returns:

java.awt compnent (usually a JPanel).

See Also:

• WhistleGraphics
• PamSymbol

getHoverText

public String getHoverText(GeneralProjector generalProjector,
 PamDataUnit dataUnit,
 int iSide)

Description copied from class: PamDetectionOverlayGraphics

Get tool tip content for the data unit for this projector.

Overrides:

getHoverText in class PamDetectionOverlayGraphics

Parameters:

generalProjector - projector

dataUnit - dataunit

iSide - left or right (0 or 1 I think, might be -1 or +1 though !)

Returns:

tooltip content consisting of text and / or an image.

hasOptionsDialog

public boolean hasOptionsDialog(GeneralProjector generalProjector)

Overrides:

hasOptionsDialog in class PamDetectionOverlayGraphics

Parameters:

generalProjector - projector

Returns:

true if the drawing methods have options relevant to this projection which can be shown in a dialog of some sort (see showOptions)

showOptions

public boolean showOptions(Window parentWindow,
 GeneralProjector generalProjector)

Description copied from class: PanelOverlayDraw

Show an options dialog for a particular projector.

Overrides:

showOptions in class PamDetectionOverlayGraphics

Parameters:

parentWindow - parent window or frame

generalProjector - projector

Returns:

getDefaultSymbol

public PamSymbol getDefaultSymbol()

Overrides:

getDefaultSymbol in class PanelOverlayDraw