Package com.xinapse.multisliceimage.roi

Enum Class VertexHandle.Spacing

java.lang.Object

java.lang.Enum<VertexHandle.Spacing>

com.xinapse.multisliceimage.roi.VertexHandle.Spacing

All Implemented Interfaces:

Serializable, Comparable<VertexHandle.Spacing>, Constable

Enclosing class:

VertexHandle

public static enum VertexHandle.Spacing
extends Enum<VertexHandle.Spacing>

Enumeration of the possible spacing factors for VertexHandles when displayed on an ROI, to prevent then being shown too close together.

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
HIGH	Far apart spacing.
LOW	Close together spacing.
MEDIUM	Medium-density spacing.

Method Summary

Modifier and Type	Method	Description
static VertexHandle.Spacing	getInstance(String descrip)	Returns a vertex handle spacing according to the supplied String.
static VertexHandle.Spacing	getPreferredSpacing()	Returns the Spacing set in the user Preferences, or the default if not in the preferences.
int	getSpacingFactor()	Returns the spacing factor between handles.
static void	savePreferredSpacing(VertexHandle.Spacing spacing)	Saves the supplied Spacing to the user Preferences.
String	toString()
static VertexHandle.Spacing	valueOf(String name)	Returns the enum constant of this class with the specified name.
static VertexHandle.Spacing[]	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

LOW

public static final VertexHandle.Spacing LOW

Close together spacing.

MEDIUM

public static final VertexHandle.Spacing MEDIUM

Medium-density spacing.

HIGH

public static final VertexHandle.Spacing HIGH

Far apart spacing.

Method Details

values

public static VertexHandle.Spacing[] 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 VertexHandle.Spacing 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

getSpacingFactor

public int getSpacingFactor()

Returns the spacing factor between handles.

Returns:

the spacing factor between handles.

toString

public String toString()

Overrides:

toString in class Enum<VertexHandle.Spacing>

getInstance

public static VertexHandle.Spacing getInstance(String descrip)

Returns a vertex handle spacing according to the supplied String.

Parameters:

descrip - a String that has been obtained using the toString() method of VertexHandle.Spacing. The case is ignored.

Returns:

a Spaing corresponding to the supplied argument.

getPreferredSpacing

public static VertexHandle.Spacing getPreferredSpacing()

Returns the Spacing set in the user Preferences, or the default if not in the preferences.

Returns:

the Spacing set in the user Preferences.

savePreferredSpacing

public static void savePreferredSpacing(VertexHandle.Spacing spacing)

Saves the supplied Spacing to the user Preferences.

Parameters:

spacing - the Spacing set as the user's preferred spacing.