Package com.xinapse.multisliceimage.roi

Enum Class CombineMode

java.lang.Object

java.lang.Enum<CombineMode>

com.xinapse.multisliceimage.roi.CombineMode

All Implemented Interfaces:

Serializable, Comparable<CombineMode>, Constable

public enum CombineMode
extends Enum<CombineMode>

An enumeration of possible ROI combination operations that can be be applied to a set of ROIs to create a single resulting ROI.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CombineMode.Panel	A JPanel for selecting a CombineMode.

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INTERSECTION	CombineMode for creating the intersection of all ROIs.
UNION	CombineMode for creating a union of all ROIs.
XOR	CombineMode for creating the exclusive OR (XOR) of all ROIs.

Method Summary

Modifier and Type	Method	Description
static CombineMode	getPreferredCombineMode(Preferences prefs, CombineMode defaultCombineMode)	Returns the CombineMode set in the UserPreferences, or the default CombineMode, if none is set in the Preferences.
static void	savePreferences(CombineMode combineMode, Preferences prefs)	Saves the supplied CombineMode as the user's preferrred CombineMode.
String	toString()	Returns a string describing this CombineMode.
static CombineMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CombineMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNION

public static final CombineMode UNION

CombineMode for creating a union of all ROIs.

INTERSECTION

public static final CombineMode INTERSECTION

CombineMode for creating the intersection of all ROIs.

XOR

public static final CombineMode XOR

CombineMode for creating the exclusive OR (XOR) of all ROIs.

Method Details

values

public static CombineMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static CombineMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Returns a string describing this CombineMode.

Overrides:

toString in class Enum<CombineMode>

Returns:

a String describing this CombineMode.

savePreferences

public static void savePreferences(CombineMode combineMode,
 Preferences prefs)

Saves the supplied CombineMode as the user's preferrred CombineMode.

Parameters:

combineMode - the CombineMode to save in the user's preferences.

prefs - the user Preferences in which to save the CombineMode.

getPreferredCombineMode

public static CombineMode getPreferredCombineMode(Preferences prefs,
 CombineMode defaultCombineMode)

Returns the CombineMode set in the UserPreferences, or the default CombineMode, if none is set in the Preferences.

Parameters:

prefs - the user Preferences in which to look for the preferred CombineMode.

defaultCombineMode - the default to return if the preferred CombineMode cannot be found in the user Preferences.

Returns:

the user's preferred CombineMode.