Package io.keikai.model

Enum Class CalcMode

java.lang.Object

java.lang.Enum<CalcMode>

io.keikai.model.CalcMode

All Implemented Interfaces:

Serializable, Comparable<CalcMode>, Constable

public enum CalcMode
extends Enum<CalcMode>

Calculation mode for a workbook, controlling when formulas are recalculated.

Corresponds to the calcMode attribute of <calcPr> in ECMA-376 Section 18.2.2.

Since:

7.0.0

See Also:

• SBook.getCalcMode()
• SBook.setCalcMode(CalcMode)

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
AUTOMATIC	Formulas are recalculated automatically whenever a dependent value changes.
AUTOMATIC_EXCEPT_TABLE	Formulas are recalculated automatically except for data table formulas.
MANUAL	Formulas are only recalculated when explicitly triggered by the user (e.g.

Method Summary

Modifier and Type	Method	Description
static CalcMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CalcMode[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

AUTOMATIC

public static final CalcMode AUTOMATIC

Formulas are recalculated automatically whenever a dependent value changes. This is the default mode. Corresponds to calcMode="auto" in OOXML.

AUTOMATIC_EXCEPT_TABLE

public static final CalcMode AUTOMATIC_EXCEPT_TABLE

Formulas are recalculated automatically except for data table formulas. Corresponds to calcMode="autoNoTable" in OOXML.

MANUAL

public static final CalcMode MANUAL

Formulas are only recalculated when explicitly triggered by the user (e.g. via SBook.calculateAll()). Corresponds to calcMode="manual" in OOXML.

Method Details

values

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