Package PamView

Class SymbolKeyItem

java.lang.Object

PamView.SymbolKeyItem

All Implemented Interfaces:

PamKeyItem

public class SymbolKeyItem
extends Object
implements PamKeyItem

Field Summary

Fields inherited from interface PamView.PamKeyItem

KEY_SHORT, KEY_VERBOSE

Constructor Summary

Constructors

Constructor	Description
SymbolKeyItem(PamSymbol pamSymbol, String text)

Method Summary

Modifier and Type	Method	Description
Component	getIcon(int keyType, int nComponent)
int	getNumItems(int keyType)
String	getText(int keyType, int nComponent)

Methods inherited from class java.lang.Object

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

Constructor Details

SymbolKeyItem

public SymbolKeyItem(PamSymbol pamSymbol,
 String text)

Method Details

getIcon

public 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 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