PamView
Class PanelOverlayKeyItem

java.lang.Object
  PamView.PanelOverlayKeyItem

All Implemented Interfaces:

PamKeyItem

public class PanelOverlayKeyItem
extends java.lang.Object
implements PamKeyItem

Field Summary

(package private) PamDetectionOverlayGraphics

pamDetectionOverlayGraphics

Fields inherited from interface PamView.PamKeyItem

KEY_SHORT, KEY_VERBOSE

Constructor Summary

PanelOverlayKeyItem(PamDetectionOverlayGraphics pamDetectionOverlayGraphics)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

pamDetectionOverlayGraphics

PamDetectionOverlayGraphics pamDetectionOverlayGraphics

Constructor Detail

PanelOverlayKeyItem

public PanelOverlayKeyItem(PamDetectionOverlayGraphics pamDetectionOverlayGraphics)

Method Detail

getIcon

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

Specified by:

getIcon in interface PamKeyItem

Parameters:

keyType - type of key - verbose or short

nComponent - component number (where there are > 1)

Returns:

a graphics component to include in the key

getNumItems

public int getNumItems(int keyType)

Specified by:

getNumItems in interface PamKeyItem

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.

getText

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

Specified by:

getText in interface PamKeyItem

Parameters:

keyType - type of key - verbose or short

nComponent - component number (where there are > 1)

Returns:

text to include in the key