org.concord.biologica.ui
Class Tool

java.lang.Object
  |
  +--org.concord.biologica.ui.Tool

public final class Tool

extends java.lang.Object

The BioLogica Tool class.

Version:

$Revision: 1.3 $ $Date: 2001/08/16 21:01:30 $

Author:

$Author: bdias $

Field Summary

static int	CHROMOSOME
static java.lang.String	CHROMOSOME_NAME
static java.awt.Cursor	chromosomeToolCursor
static javax.swing.ImageIcon	chromosomeToolImageIcon
static java.lang.String	COMMAND_CHROMOSOME
static java.lang.String	COMMAND_CROSS
static java.lang.String	COMMAND_PEDIGREE
static java.lang.String	COMMAND_SELECTION
static java.lang.String	COMMAND_SNIP
static int	CROSS
static java.lang.String	CROSS_NAME
static java.awt.Cursor	crossToolCursor
static javax.swing.ImageIcon	crossToolImageIcon
static int	NO_TOOL
static int	NUMBER_OF_TOOLS
static int	PEDIGREE
static java.lang.String	PEDIGREE_NAME
static java.awt.Cursor	pedigreeToolCursor
static javax.swing.ImageIcon	pedigreeToolImageIcon
static int	SELECTION
static java.lang.String	SELECTION_NAME
static java.awt.Cursor	selectionToolCursor Tool cursors
static javax.swing.ImageIcon	selectionToolImageIcon Image icons
static int	SNIP
static java.lang.String	SNIP_NAME
static java.awt.Cursor	snipToolCursor
static javax.swing.ImageIcon	snipToolImageIcon
static java.lang.String	TIP_CHROMOSOME
static java.lang.String	TIP_CROSS
static java.lang.String	TIP_PEDIGREE
static java.lang.String	TIP_SELECTION
static java.lang.String	TIP_SNIP

Constructor Summary

Tool()

Method Summary

static java.lang.String	getCommandString(int toolID) Get the command string for the given tool.
static java.awt.Cursor	getCursor(int toolID) Get the cursor for the given tool.
static java.lang.String	getEnabledPropertyChangeEvent(int toolID) Get the enabled property change event for the given tool.
static javax.swing.ImageIcon	getImageIcon(int toolID) Get the image icon for the given tool.
static java.lang.String	getToolTipString(int toolID) Get the tool tip string for the given tool.
static java.lang.String	getVisiblePropertyChangeEvent(int toolID) Get the visible property change event for the given tool.
static boolean	validTool(int toolID) Get whether or not this is a valid tool.

Methods inherited from class java.lang.Object

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

Field Detail

SELECTION_NAME

public static final java.lang.String SELECTION_NAME

CROSS_NAME

public static final java.lang.String CROSS_NAME

SNIP_NAME

public static final java.lang.String SNIP_NAME

CHROMOSOME_NAME

public static final java.lang.String CHROMOSOME_NAME

PEDIGREE_NAME

public static final java.lang.String PEDIGREE_NAME

NO_TOOL

public static final int NO_TOOL

SELECTION

public static final int SELECTION

CROSS

public static final int CROSS

SNIP

public static final int SNIP

CHROMOSOME

public static final int CHROMOSOME

PEDIGREE

public static final int PEDIGREE

NUMBER_OF_TOOLS

public static final int NUMBER_OF_TOOLS

COMMAND_SELECTION

public static final java.lang.String COMMAND_SELECTION

COMMAND_CROSS

public static final java.lang.String COMMAND_CROSS

COMMAND_SNIP

public static final java.lang.String COMMAND_SNIP

COMMAND_CHROMOSOME

public static final java.lang.String COMMAND_CHROMOSOME

COMMAND_PEDIGREE

public static final java.lang.String COMMAND_PEDIGREE

TIP_SELECTION

public static final java.lang.String TIP_SELECTION

TIP_CROSS

public static final java.lang.String TIP_CROSS

TIP_SNIP

public static final java.lang.String TIP_SNIP

TIP_CHROMOSOME

public static final java.lang.String TIP_CHROMOSOME

TIP_PEDIGREE

public static final java.lang.String TIP_PEDIGREE

selectionToolCursor

public static final java.awt.Cursor selectionToolCursor

Tool cursors

crossToolCursor

public static final java.awt.Cursor crossToolCursor

snipToolCursor

public static final java.awt.Cursor snipToolCursor

chromosomeToolCursor

public static final java.awt.Cursor chromosomeToolCursor

pedigreeToolCursor

public static final java.awt.Cursor pedigreeToolCursor

selectionToolImageIcon

public static final javax.swing.ImageIcon selectionToolImageIcon

Image icons

crossToolImageIcon

public static final javax.swing.ImageIcon crossToolImageIcon

snipToolImageIcon

public static final javax.swing.ImageIcon snipToolImageIcon

chromosomeToolImageIcon

public static final javax.swing.ImageIcon chromosomeToolImageIcon

pedigreeToolImageIcon

public static final javax.swing.ImageIcon pedigreeToolImageIcon

Constructor Detail

Tool

public Tool()

Method Detail

getCursor

public static java.awt.Cursor getCursor(int toolID)

Get the cursor for the given tool. Returns null if the tool id is not recognized.

Parameters:

toolID - int - tool id (one of the above)

Returns:

Cursor - tool cursor

getImageIcon

public static javax.swing.ImageIcon getImageIcon(int toolID)

Get the image icon for the given tool. Returns null if the tool id is not recognized.

Parameters:

toolID - int - tool id (one of the above)

Returns:

ImageIcon - tool ImageIcon

getCommandString

public static java.lang.String getCommandString(int toolID)

Get the command string for the given tool. Returns null if the tool id is not recognized.

Parameters:

toolID - int - tool id (one of the above)

Returns:

String - command string, null if not recognized

getToolTipString

public static java.lang.String getToolTipString(int toolID)

Get the tool tip string for the given tool. Returns null if the tool id is not recognized.

Parameters:

toolID - int - tool id (one of the above)

Returns:

String - tool tip string, null if not recognized

getEnabledPropertyChangeEvent

public static java.lang.String getEnabledPropertyChangeEvent(int toolID)

Get the enabled property change event for the given tool.

Parameters:

toolID - int - tool id (one of the above)

Returns:

String - enabled property change event string

getVisiblePropertyChangeEvent

public static java.lang.String getVisiblePropertyChangeEvent(int toolID)

Get the visible property change event for the given tool.

Parameters:

toolID - int - tool id (one of the above)

Returns:

String - visible property change event string

validTool

public static boolean validTool(int toolID)

Get whether or not this is a valid tool.

Parameters:

toolID - int - tool id (one of the above)

Returns:

boolean - valid (true) or invalid (false) tool?