PamView
Interface PamKeyItem

All Known Implementing Classes:

BasicKeyItem, LineKeyItem, PanelOverlayKeyItem, SymbolKeyItem, TextKeyItem

public interface PamKeyItem

Interface for passing information from overlay graphics to plots to give information to include in keys for the various displays.

Currently just a place holder class to include in PanelOverlayDraw implementations. Will need to work out what members and member functions to put in it later.

Author:

Doug Gillespie

See Also:

PanelOverlayDraw

Field Summary

static int	KEY_SHORT A shortened key
static int	KEY_VERBOSE A full key

Method Summary

java.awt.Component	getIcon(int keyType, int nComponent)
int	getNumItems(int keyType)
java.lang.String	getText(int keyType, int nComponent)

Field Detail

KEY_VERBOSE

static final int KEY_VERBOSE

A full key

See Also:

Constant Field Values

KEY_SHORT

static final int KEY_SHORT

A shortened key

See Also:

Constant Field Values

Method Detail

getNumItems

int getNumItems(int keyType)

Returns:

Get's the total number of key items associated with this detection

This can be > 1 for things like the click detector which may want to show different symbols for different species.

getIcon

java.awt.Component getIcon(int keyType,
                           int nComponent)

Parameters:

keyType - type of key - verbose or short

nComponent - component number (where there are > 1)

Returns:

a graphics component to include in the key

getText

java.lang.String getText(int keyType,
                         int nComponent)

Parameters:

keyType - type of key - verbose or short

nComponent - component number (where there are > 1)

Returns:

text to include in the key