PamView

Class BasicKeyItem

java.lang.Object

PamView.BasicKeyItem

All Implemented Interfaces:

PamKeyItem

public class BasicKeyItem
extends java.lang.Object
implements PamKeyItem

Field Summary

Fields inherited from interface PamView.PamKeyItem

KEY_SHORT, KEY_VERBOSE

Constructor Summary

Constructors

Constructor and Description
BasicKeyItem()
BasicKeyItem(java.awt.Component component, java.lang.String text)
BasicKeyItem(javax.swing.Icon icon, java.lang.String text)

Method Summary

Methods

Modifier and Type	Method and Description
void	addIcon(java.awt.Component component, java.lang.String text)
void	addIcon(javax.swing.Icon icon, java.lang.String text)
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

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

Constructor Detail

BasicKeyItem

public BasicKeyItem()

BasicKeyItem

public BasicKeyItem(javax.swing.Icon icon,
            java.lang.String text)

BasicKeyItem

public BasicKeyItem(java.awt.Component component,
            java.lang.String text)

Method Detail

addIcon

public void addIcon(javax.swing.Icon icon,
           java.lang.String text)

addIcon

public void addIcon(java.awt.Component component,
           java.lang.String text)

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