org.dhatim.fastexcel

Enum ProtectionOption

java.lang.Object

java.lang.Enum<ProtectionOption>

org.dhatim.fastexcel.ProtectionOption

All Implemented Interfaces:

Serializable, Comparable<ProtectionOption>

public enum ProtectionOption
extends Enum<ProtectionOption>

Represents an attribute on the <protection> xml-tag.

Enum Constant Summary

Enum Constants

Enum Constant and Description
HIDDEN A boolean value indicating if the cell is hidden.
LOCKED A boolean value indicating if the cell is locked.

Method Summary

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

HIDDEN

public static final ProtectionOption HIDDEN

A boolean value indicating if the cell is hidden. When the cell is hidden and the sheet on which the cell resides is protected, then the cell value will be displayed in the cell grid location, but the contents of the cell will not be displayed in the formula bar. This is true for all types of cell content, including formula, text, or numbers. Therefore the cell A4 may contain a formula "=SUM(A1:A3)", but if the cell protection property of A4 is marked as hidden, and the sheet is protected, then the cell should display the calculated result (for example, "6"), but will not display the formula used to calculate the result.

LOCKED

public static final ProtectionOption LOCKED

A boolean value indicating if the cell is locked. When cells are marked as "locked" and the sheet is protected, then the options specified in the Sheet Part's <sheetProtection> element (§3.3.1.81) are prohibited for these cells.

Method Detail

values

public static ProtectionOption[] 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 (ProtectionOption c : ProtectionOption.values())
    System.out.println(c);

Returns:

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

valueOf

public static ProtectionOption valueOf(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:

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

NullPointerException - if the argument is null

getName

public String getName()