Package Array

Class StreamerOverlayGraphics

java.lang.Object

PamView.PanelOverlayDraw

Array.StreamerOverlayGraphics

public class StreamerOverlayGraphics
extends PanelOverlayDraw

Field Summary

Fields

Modifier and Type	Field	Description
static final SymbolData	streamerSymbol

Constructor Summary

Constructors

Constructor	Description
StreamerOverlayGraphics()

Method Summary

Modifier and Type	Method	Description
boolean	canDraw(GeneralProjector.ParameterType[] parameterTypes, GeneralProjector.ParameterUnits[] parameterUnits)
PamKeyItem	createKeyItem(GeneralProjector generalProjector, int keyType)	provide a graphics component (probably a JPanel) that can be incorporated into a key panel for maps, and anything else that uses overlay graphics.
Rectangle	drawDataUnit(Graphics g, PamDataUnit pamDataUnit, GeneralProjector generalProjector)
Rectangle	drawOnMap(Graphics g, PamDataUnit pamDataUnit, GeneralProjector generalProjector)
String	getHoverText(GeneralProjector generalProjector, PamDataUnit dataUnit, int iSide)	Provides text for popup hover windows on displays.
boolean	hasOptionsDialog(GeneralProjector generalProjector)
boolean	showOptions(Window parentWindow, GeneralProjector generalProjector)	Show an options dialog for a particular projector.

Methods inherited from class PamView.PanelOverlayDraw

canDraw, getDefaultSymbol, getPamSymbol, preDrawAnything, setDefaultSymbol

Methods inherited from class java.lang.Object

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

Field Details

streamerSymbol

public static final SymbolData streamerSymbol

Constructor Details

StreamerOverlayGraphics

public StreamerOverlayGraphics()

Method Details

drawDataUnit

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

Specified by:

drawDataUnit in class PanelOverlayDraw

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.

drawOnMap

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

canDraw

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

Specified by:

canDraw in class PanelOverlayDraw

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: PanelOverlayDraw

provide a graphics component (probably a JPanel) that can be incorporated into a key panel for maps, and anything else that uses overlay graphics.

Since multiple keys may be created in various displays, new ones should normally be created each time this is called.

The GeneralProjector reference is passed as a parameter since the type of symbol or shape drawn on a particular plot may depend on the type of coordinate system. For example, whistles are drawn as a contour on the spectrogram display, but as a point (PamSymbol) on the map.

It is possible that some PanelOverlayDraw implementations will be rather complicated and the keys consequently quite large. The extendedKey parameter may therefore be used to draw a full or a cut down version of the key. It is expected that most implementations will ignore this parameter !

Specified by:

createKeyItem in class PanelOverlayDraw

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: PanelOverlayDraw

Provides text for popup hover windows on displays.

Specified by:

getHoverText in class PanelOverlayDraw

Parameters:

generalProjector - Projector associated with the display requiring the text

dataUnit - Data unit the mouse hovered over

Returns:

Text to display

hasOptionsDialog

public boolean hasOptionsDialog(GeneralProjector generalProjector)

Overrides:

hasOptionsDialog in class PanelOverlayDraw

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 PanelOverlayDraw

Parameters:

parentWindow - parent window or frame

generalProjector - projector

Returns: