Package Map

Class MapCommentOverlayGraphics

java.lang.Object

PamView.PanelOverlayDraw

PamView.PamDetectionOverlayGraphics

Map.MapCommentOverlayGraphics

public class MapCommentOverlayGraphics
extends PamDetectionOverlayGraphics

Field Summary

Fields

Modifier and Type	Field	Description
static final SymbolData	defaultSymbol

Constructor Summary

Constructors

Constructor	Description
MapCommentOverlayGraphics(PamDataBlock parentDataBlock)

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.
Rectangle	drawDataUnit(Graphics g, PamDataUnit pamDataUnit, GeneralProjector generalProjector)	Draw a PamDataUnit on a display.
String	getHoverText(GeneralProjector generalProjector, PamDataUnit dataUnit, int side)	Get tool tip content for the data unit for this projector.

Methods inherited from class PamView.PamDetectionOverlayGraphics

canDraw, createKeyItem, getDefaultRange, getHoverImage, getHoverTextWithoutWrap, getLineColor, getLineColour, getLocColour, getMenuKeyItem, getPamSymbol, getParentDataBlock, getPerspectiveSymbol, getSymbolInfo, hasOptionsDialog, isDetectionData, setDefaultRange, setDetectionData, setLineColor, setLineColour, setLocColour, showOptions

Methods inherited from class PamView.PanelOverlayDraw

getDefaultSymbol, preDrawAnything, setDefaultSymbol

Methods inherited from class java.lang.Object

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

Field Details

defaultSymbol

public static final SymbolData defaultSymbol

Constructor Details

MapCommentOverlayGraphics

public MapCommentOverlayGraphics(PamDataBlock parentDataBlock)

Method Details

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.

drawDataUnit

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

Description copied from class: PamDetectionOverlayGraphics

Draw a PamDataUnit on a display.

This is split into separate routines for the three main display types for simplicity both of reading this code and for overriding the various functions.

If display types are added to PAMGUARD, these functions will need to be added to.

Overrides:

drawDataUnit in class PamDetectionOverlayGraphics

Parameters:

g - Graphics handle to draw on

pamDataUnit - PamDataUnit to draw

generalProjector - Projector to use when drawing.

Returns:

A rectangle surrouding whatever has just been drawn.

getHoverText

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

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

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

Returns:

tooltip content consisting of text and / or an image.