Module org.dhatim.fastexcel

Package org.dhatim.fastexcel

Enum SheetProtectionOption

java.lang.Object

java.lang.Enum<SheetProtectionOption>

org.dhatim.fastexcel.SheetProtectionOption

All Implemented Interfaces:

Serializable, Comparable<SheetProtectionOption>

public enum SheetProtectionOption
extends Enum<SheetProtectionOption>

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

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTO_FILTER	Autofilters are locked when the sheet is protected.
DELETE_COLUMNS	Deleting columns is locked when the sheet is protected.
DELETE_ROWS	Deleting rows is locked when the sheet is protected.
FORMAT_CELLS	Formatting cells is locked when the sheet is protected.
FORMAT_COLUMNS	Formatting columns is locked when the sheet is protected.
FORMAT_ROWS	Formatting rows is locked when the sheet is protected.
INSERT_COLUMNS	Inserting columns is locked when the sheet is protected.
INSERT_HYPERLINKS	Inserting hyperlinks is locked when the sheet is protected.
INSERT_ROWS	Inserting rows is locked when the sheet is protected.
OBJECTS	Objects are locked when the sheet is protected.
PIVOT_TABLES	Pivot tables are locked when the sheet is protected.
SCENARIOS	Scenarios are locked when the sheet is protected.
SELECT_LOCKED_CELLS	Selection of locked cells is locked when the sheet is protected.
SELECT_UNLOCKED_CELLS	Selection of unlocked cells is locked when the sheet is protected.
SHEET	Sheet is locked when the sheet is protected.
SORT	Sorting is locked when the sheet is protected.

Field Summary

Fields

Modifier and Type	Field	Description
static Set<SheetProtectionOption>	DEFAULT_OPTIONS	The options that are true by default AND 'sheet'.

Method Summary

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

AUTO_FILTER

public static final SheetProtectionOption AUTO_FILTER

Autofilters are locked when the sheet is protected.

DELETE_COLUMNS

public static final SheetProtectionOption DELETE_COLUMNS

Deleting columns is locked when the sheet is protected.

DELETE_ROWS

public static final SheetProtectionOption DELETE_ROWS

Deleting rows is locked when the sheet is protected.

FORMAT_CELLS

public static final SheetProtectionOption FORMAT_CELLS

Formatting cells is locked when the sheet is protected.

FORMAT_COLUMNS

public static final SheetProtectionOption FORMAT_COLUMNS

Formatting columns is locked when the sheet is protected.

FORMAT_ROWS

public static final SheetProtectionOption FORMAT_ROWS

Formatting rows is locked when the sheet is protected.

INSERT_COLUMNS

public static final SheetProtectionOption INSERT_COLUMNS

Inserting columns is locked when the sheet is protected.

INSERT_HYPERLINKS

public static final SheetProtectionOption INSERT_HYPERLINKS

Inserting hyperlinks is locked when the sheet is protected.

INSERT_ROWS

public static final SheetProtectionOption INSERT_ROWS

Inserting rows is locked when the sheet is protected.

PIVOT_TABLES

public static final SheetProtectionOption PIVOT_TABLES

Pivot tables are locked when the sheet is protected.

SORT

public static final SheetProtectionOption SORT

Sorting is locked when the sheet is protected.

SHEET

public static final SheetProtectionOption SHEET

Sheet is locked when the sheet is protected.

OBJECTS

public static final SheetProtectionOption OBJECTS

Objects are locked when the sheet is protected.

SCENARIOS

public static final SheetProtectionOption SCENARIOS

Scenarios are locked when the sheet is protected.

SELECT_LOCKED_CELLS

public static final SheetProtectionOption SELECT_LOCKED_CELLS

Selection of locked cells is locked when the sheet is protected.

SELECT_UNLOCKED_CELLS

public static final SheetProtectionOption SELECT_UNLOCKED_CELLS

Selection of unlocked cells is locked when the sheet is protected.

Field Detail

DEFAULT_OPTIONS

public static final Set<SheetProtectionOption> DEFAULT_OPTIONS

The options that are true by default AND 'sheet'.

Method Detail

values

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

Returns:

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

valueOf

public static SheetProtectionOption 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()

getDefaultValue

public boolean getDefaultValue()