clipgenerator

Class ClipOverlayGraphics

java.lang.Object

PamView.PamDetectionOverlayGraphics

clipgenerator.ClipOverlayGraphics

All Implemented Interfaces:

ManagedSymbol, PanelOverlayDraw

public class ClipOverlayGraphics
extends PamDetectionOverlayGraphics

Constructor Summary

Constructors

Constructor and Description
ClipOverlayGraphics(ClipControl clipControl, ClipDataBlock clipDataBlock)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canDraw(GeneralProjector generalProjector) 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.
java.awt.Rectangle	drawDataUnit(java.awt.Graphics g, PamDataUnit pamDataUnit, GeneralProjector generalProjector) Draw a PamDataUnit on a display.
java.awt.image.BufferedImage	getHoverImage(GeneralProjector generalProjector, PamDataUnit dataUnit, int iSide) GEt an image for the data unit to include in overlay text.
boolean	hasOptionsDialog(GeneralProjector generalProjector)
boolean	showOptions(java.awt.Window parentWindow, GeneralProjector generalProjector) Show an options dialog for a particular projector.

Methods inherited from class PamView.PamDetectionOverlayGraphics

getDefaultRange, getHoverText, getHoverTextWithoutWrap, getLineColor, getLineColour, getMenuKeyItem, getPamSymbol, getPamSymbol, getParentDataBlock, getSymbolInfo, isDetectionData, isDrawLineToLocations, setDefaultRange, setDetectionData, setDrawLineToLocations, setLineColor, setLineColour, setPamSymbol

Methods inherited from class java.lang.Object

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

Constructor Detail

ClipOverlayGraphics

public ClipOverlayGraphics(ClipControl clipControl,
                   ClipDataBlock clipDataBlock)

Parameters:

clipControl -

Method Detail

canDraw

public boolean canDraw(GeneralProjector generalProjector)

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.

For simplicity I've broken it up into the three main display types currently existing in Pamguard.

Specified by:

canDraw in interface PanelOverlayDraw

Overrides:

canDraw in class PamDetectionOverlayGraphics

Returns:

Returns whether or not the object can be drawn using the given projector. The implementation of CanDraw should examine the parameter types in GeneralProjector and check that it will know how to prvide those parameters before returning true, or false otherwise.

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.

Specified by:

createKeyItem in interface PanelOverlayDraw

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

drawDataUnit

public java.awt.Rectangle drawDataUnit(java.awt.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.

Specified by:

drawDataUnit in interface PanelOverlayDraw

Overrides:

drawDataUnit in class PamDetectionOverlayGraphics

Parameters:

g - Graphics handle to draw on

pamDataUnit - PamDataUnit to draw

generalProjector - Projector to use when drawing.

Returns:

A rectange surrouding whatever has just been drawn.

getHoverImage

public java.awt.image.BufferedImage getHoverImage(GeneralProjector generalProjector,
                                         PamDataUnit dataUnit,
                                         int iSide)

Description copied from class: PamDetectionOverlayGraphics

GEt an image for the data unit to include in overlay text.

Overrides:

getHoverImage in class PamDetectionOverlayGraphics

Parameters:

generalProjector - projector

dataUnit - dataunit

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

Returns:

a small image or null

hasOptionsDialog

public boolean hasOptionsDialog(GeneralProjector generalProjector)

Specified by:

hasOptionsDialog in interface PanelOverlayDraw

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(java.awt.Window parentWindow,
                  GeneralProjector generalProjector)

Description copied from interface: PanelOverlayDraw

Show an options dialog for a particular projector.

Specified by:

showOptions in interface PanelOverlayDraw

Overrides:

showOptions in class PamDetectionOverlayGraphics

Parameters:

parentWindow - parent window or frame

generalProjector - projector

Returns: