org.zkoss.poi.ss.usermodel

Interface SheetProtection

All Known Implementing Classes:

HSSFSheetProtection, XSSFSheetProtection

public interface SheetProtection

Enhanced sheet protection.

Author:

henri

Method Summary

Modifier and Type	Method and Description
boolean	isAutoFilter()
boolean	isDeleteColumns()
boolean	isDeleteRows()
boolean	isFormatCells()
boolean	isFormatColumns()
boolean	isFormatRows()
boolean	isInsertColumns()
boolean	isInsertHyperlinks()
boolean	isInsertRows()
boolean	isObjects()
boolean	isPivotTables()
boolean	isScenarios()
boolean	isSelectLockedCells()
boolean	isSelectUnlockedCells()
boolean	isSort()
void	setAutoFilter(boolean flag) Enable Autofilters locking.
void	setDeleteColumns(boolean flag) Enable Deleting columns locking.
void	setDeleteRows(boolean flag) Enable Deleting rows locking.
void	setFormatCells(boolean flag) Enable Formatting cells locking.
void	setFormatColumns(boolean flag) Enable Formatting columns locking.
void	setFormatRows(boolean flag) Enable Formatting rows locking.
void	setInsertColumns(boolean flag) Enable Inserting columns locking.
void	setInsertHyperlinks(boolean flag) Enable Inserting hyperlinks locking.
void	setInsertRows(boolean flag) Enable Inserting rows locking.
void	setObjects(boolean flag) Enable Objects locking.
void	setPivotTables(boolean flag) Enable Pivot Tables locking.
void	setScenarios(boolean flag) Enable Scenarios locking.
void	setSelectLockedCells(boolean flag) Enable Selection of locked cells locking.
void	setSelectUnlockedCells(boolean flag) Enable Selection of unlocked cells locking.
void	setSort(boolean flag) Enable Sort locking.

Method Detail

isAutoFilter

boolean isAutoFilter()

Returns:

true when Autofilters are locked and the sheet is protected.

isDeleteColumns

boolean isDeleteColumns()

Returns:

true when Deleting columns is locked and the sheet is protected.

isDeleteRows

boolean isDeleteRows()

Returns:

true when Deleting rows is locked and the sheet is protected.

isFormatCells

boolean isFormatCells()

Returns:

true when Formatting cells is locked and the sheet is protected.

isFormatColumns

boolean isFormatColumns()

Returns:

true when Formatting columns is locked and the sheet is protected.

isFormatRows

boolean isFormatRows()

Returns:

true when Formatting rows is locked and the sheet is protected.

isInsertColumns

boolean isInsertColumns()

Returns:

true when Inserting columns is locked and the sheet is protected.

isInsertHyperlinks

boolean isInsertHyperlinks()

Returns:

true when Inserting hyperlinks is locked and the sheet is protected.

isInsertRows

boolean isInsertRows()

Returns:

true when Inserting rows is locked and the sheet is protected.

isPivotTables

boolean isPivotTables()

Returns:

true when Pivot tables are locked and the sheet is protected.

isSort

boolean isSort()

Returns:

true when Sorting is locked and the sheet is protected.

isObjects

boolean isObjects()

Returns:

true when Objects are locked and the sheet is protected.

isScenarios

boolean isScenarios()

Returns:

true when Scenarios are locked and the sheet is protected.

isSelectLockedCells

boolean isSelectLockedCells()

Returns:

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

isSelectUnlockedCells

boolean isSelectUnlockedCells()

Returns:

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

setAutoFilter

void setAutoFilter(boolean flag)

Enable Autofilters locking. This does not modify sheet protection status. To enforce this locking, call #enableLocking()

setDeleteColumns

void setDeleteColumns(boolean flag)

Enable Deleting columns locking. This does not modify sheet protection status. To enforce this locking, call #enableLocking()

setDeleteRows

void setDeleteRows(boolean flag)

Enable Deleting rows locking. This does not modify sheet protection status. To enforce this locking, call #enableLocking()

setFormatCells

void setFormatCells(boolean flag)

Enable Formatting cells locking. This does not modify sheet protection status. To enforce this locking, call #enableLocking()

setFormatColumns

void setFormatColumns(boolean flag)

Enable Formatting columns locking. This does not modify sheet protection status. To enforce this locking, call #enableLocking()

setFormatRows

void setFormatRows(boolean flag)

Enable Formatting rows locking. This does not modify sheet protection status. To enforce this locking, call #enableLocking()

setInsertColumns

void setInsertColumns(boolean flag)

Enable Inserting columns locking. This does not modify sheet protection status. To enforce this locking, call #enableLocking()

setInsertHyperlinks

void setInsertHyperlinks(boolean flag)

Enable Inserting hyperlinks locking. This does not modify sheet protection status. To enforce this locking, call #enableLocking()

setInsertRows

void setInsertRows(boolean flag)

Enable Inserting rows locking. This does not modify sheet protection status. To enforce this locking, call #enableLocking()

setPivotTables

void setPivotTables(boolean flag)

Enable Pivot Tables locking. This does not modify sheet protection status. To enforce this locking, call #enableLocking()

setSort

void setSort(boolean flag)

Enable Sort locking. This does not modify sheet protection status. To enforce this locking, call #enableLocking()

setObjects

void setObjects(boolean flag)

Enable Objects locking. This does not modify sheet protection status. To enforce this locking, call #enableLocking()

setScenarios

void setScenarios(boolean flag)

Enable Scenarios locking. This does not modify sheet protection status. To enforce this locking, call #enableLocking()

setSelectLockedCells

void setSelectLockedCells(boolean flag)

Enable Selection of locked cells locking. This does not modify sheet protection status. To enforce this locking, call #enableLocking()

setSelectUnlockedCells

void setSelectUnlockedCells(boolean flag)

Enable Selection of unlocked cells locking. This does not modify sheet protection status. To enforce this locking, call #enableLocking()