Package edu.cnu.mdi.splot.plot

Enum Class LimitsMethod

java.lang.Object

java.lang.Enum<LimitsMethod>

edu.cnu.mdi.splot.plot.LimitsMethod

All Implemented Interfaces:

Serializable, Comparable<LimitsMethod>, Constable

public enum LimitsMethod
extends Enum<LimitsMethod>

How PlotCanvas determines an axis's displayed [min, max] range. Set independently per axis via PlotParameters.

• MANUALLIMITS — use the explicit bounds set via PlotParameters.setXRange(double, double) / PlotParameters.setYRange(double, double).
• ALGORITHMICLIMITS (the default) — for a linear axis, round the data bounds out to "nice" tick-aligned values via NiceScale; for a log axis, use the positive data's exact min/max instead (a "nice" rounding doesn't apply the same way on a log scale).
• USEDATALIMITS — use the data's exact bounds unrounded, on a linear axis; on a log axis this behaves the same as ALGORITHMICLIMITS (both use the positive data's exact min/max).

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
ALGORITHMICLIMITS
MANUALLIMITS
USEDATALIMITS

Method Summary

Modifier and Type	Method	Description
static EnumComboBox<LimitsMethod>	getComboBox(LimitsMethod defaultChoice)	Obtain a combo box of choices.
String	getName()	Nice label for UI (combo boxes, menus, etc.).
static LimitsMethod	getValue(String s)	Returns the enum value from a string.
String	toString()
static LimitsMethod	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LimitsMethod[]	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

MANUALLIMITS

public static final LimitsMethod MANUALLIMITS

ALGORITHMICLIMITS

public static final LimitsMethod ALGORITHMICLIMITS

USEDATALIMITS

public static final LimitsMethod USEDATALIMITS

Method Details

values

public static LimitsMethod[] 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 LimitsMethod 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

getName

public String getName()

Nice label for UI (combo boxes, menus, etc.).

toString

public String toString()

Overrides:

toString in class Enum<LimitsMethod>

getValue

public static LimitsMethod getValue(String s)

Returns the enum value from a string. Matches either the nice label (getName) or the enum constant name() (case-insensitive).

getComboBox

public static EnumComboBox<LimitsMethod> getComboBox(LimitsMethod defaultChoice)

Obtain a combo box of choices.

Parameters:

defaultChoice - which enum should be initially selected (nullable)

Returns:

the combo box