br.usp.ime.klava.segmentit.gui
Enum Tool

java.lang.Object
  extended by java.lang.Enum<Tool>
      extended by br.usp.ime.klava.segmentit.gui.Tool
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Tool>

public enum Tool
extends java.lang.Enum<Tool>

Tools used to trigger the available functionalities.

Author:
Bruno Klava

Enum Constant Summary
BORDERS_BRUSH
          Used to draw an external and and internal marker for a border.
BRUSH_COLOR
          Used to hold and pick (from a JColorChooser) the color of the BRUSH_ERASER.
BRUSH_ERASER
          Used to draw and erase markers.
COLOR_SELECTOR
          Used to select a color for the BRUSH_ERASER from an existing marker.
HIERARCHY
          Used to select a region for hierarchical segmentation.
SEGMENT
          Used to trigger an execution of the watershed from markers algorithm if the option "Segment automatically" is not active.
WELDING_BRUSH
          Used to select regions to be welded.
ZOOM
          Used to zoom the image being segmented.
 
Method Summary
 javax.swing.AbstractAction getAction()
          Returns the action triggered by the tool.
 javax.swing.ImageIcon getIcon()
          Returns the icon of the tool.
 java.lang.String getMiniHelp()
          Returns a help information about the usage of the tool.
 java.lang.String getName()
          Returns the name of the tool.
 boolean isSelectable()
          Returns if the tool is selectable.
static Tool valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Tool[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

BRUSH_ERASER

public static final Tool BRUSH_ERASER
Used to draw and erase markers.


BRUSH_COLOR

public static final Tool BRUSH_COLOR
Used to hold and pick (from a JColorChooser) the color of the BRUSH_ERASER.


BORDERS_BRUSH

public static final Tool BORDERS_BRUSH
Used to draw an external and and internal marker for a border. Experimental functionality (currently, it is DEACTIVATED in the SegmentationContainer).


WELDING_BRUSH

public static final Tool WELDING_BRUSH
Used to select regions to be welded.


COLOR_SELECTOR

public static final Tool COLOR_SELECTOR
Used to select a color for the BRUSH_ERASER from an existing marker.


SEGMENT

public static final Tool SEGMENT
Used to trigger an execution of the watershed from markers algorithm if the option "Segment automatically" is not active.


HIERARCHY

public static final Tool HIERARCHY
Used to select a region for hierarchical segmentation.


ZOOM

public static final Tool ZOOM
Used to zoom the image being segmented.

Method Detail

values

public static Tool[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (Tool c : Tool.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static Tool valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

getName

public java.lang.String getName()
Returns the name of the tool.

Returns:
the name of the tool

getIcon

public javax.swing.ImageIcon getIcon()
Returns the icon of the tool.

Returns:
the icon of the tool

getMiniHelp

public java.lang.String getMiniHelp()
Returns a help information about the usage of the tool.

Returns:
a help information about the usage of the tool

getAction

public javax.swing.AbstractAction getAction()
Returns the action triggered by the tool.

Returns:
the action triggered by the tool

isSelectable

public boolean isSelectable()
Returns if the tool is selectable.

Returns:
true if the tool is selectable