Package io.keikai.api
Class SheetProtection
- java.lang.Object
-
- io.keikai.api.SheetProtection
-
public class SheetProtection extends Object
SheetProtection values config.Using
SheetProtection.Builder
you can construct a SheetProtection object.- Since:
- 5.0.0
- Author:
- jumperchen
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SheetProtection.Builder
Builder is used to build instances of SheetProtection from values configured by the setters
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getPassword()
Returns the password.boolean
isAutoFilterAllowed()
Returns whether to allow user to set filters on the protected sheet.boolean
isDeleteColumnsAllowed()
Returns whether to allow user to delete columns on the protected sheet.boolean
isDeleteRowsAllowed()
Returns whether to allow user to delete rows on the protected sheet.boolean
isFormatCellsAllowed()
Returns whether to allow user to format any cell on the protected sheet.boolean
isFormatColumnsAllowed()
Returns whether to allow user to format any columns on the protected sheet.boolean
isFormatRowsAllowed()
Returns whether to allow user to format any rows on the protected sheet.boolean
isInsertColumnsAllowed()
Returns whether to allow user to insert columns on the protected sheet.boolean
isInsertHyperlinksAllowed()
Returns whether to allow user to insert hyperlinks on the protected sheet.boolean
isInsertRowsAllowed()
Returns whether to allow user to insert rows on the protected sheet.boolean
isObjectsEditable()
Returns whether to protect objects.boolean
isPivotTablesAllowed()
Returns whether to allow user to use pivot table reports on the protected sheet.boolean
isScenariosEditable()
Returns whether to protect scenarios.boolean
isSelectLockedCellsAllowed()
Returns whether to allow select locked cells.boolean
isSelectUnlockedCellsAllowed()
Returns whether to allow select unlocked cells.boolean
isSortAllowed()
Returns whether to allow user to sort on the protected sheet.
-
-
-
Method Detail
-
getPassword
public String getPassword()
Returns the password.- Returns:
-
isObjectsEditable
public boolean isObjectsEditable()
Returns whether to protect objects.Default to true
- Returns:
-
isScenariosEditable
public boolean isScenariosEditable()
Returns whether to protect scenarios.Default to true
- Returns:
-
isFormatCellsAllowed
public boolean isFormatCellsAllowed()
Returns whether to allow user to format any cell on the protected sheet.Default to false
- Returns:
-
isFormatColumnsAllowed
public boolean isFormatColumnsAllowed()
Returns whether to allow user to format any columns on the protected sheet.Default to false
- Returns:
-
isFormatRowsAllowed
public boolean isFormatRowsAllowed()
Returns whether to allow user to format any rows on the protected sheet.Default to false
- Returns:
-
isInsertColumnsAllowed
public boolean isInsertColumnsAllowed()
Returns whether to allow user to insert columns on the protected sheet.Default to false
- Returns:
-
isInsertRowsAllowed
public boolean isInsertRowsAllowed()
Returns whether to allow user to insert rows on the protected sheet.Default to false
- Returns:
-
isInsertHyperlinksAllowed
public boolean isInsertHyperlinksAllowed()
Returns whether to allow user to insert hyperlinks on the protected sheet.Default to false
- Returns:
-
isDeleteColumnsAllowed
public boolean isDeleteColumnsAllowed()
Returns whether to allow user to delete columns on the protected sheet.Default to false
- Returns:
-
isDeleteRowsAllowed
public boolean isDeleteRowsAllowed()
Returns whether to allow user to delete rows on the protected sheet.Default to false
- Returns:
-
isSortAllowed
public boolean isSortAllowed()
Returns whether to allow user to sort on the protected sheet.Default to false
- Returns:
-
isAutoFilterAllowed
public boolean isAutoFilterAllowed()
Returns whether to allow user to set filters on the protected sheet.Default to false
- Returns:
-
isPivotTablesAllowed
public boolean isPivotTablesAllowed()
Returns whether to allow user to use pivot table reports on the protected sheet.Default to false
- Returns:
-
isSelectLockedCellsAllowed
public boolean isSelectLockedCellsAllowed()
Returns whether to allow select locked cells.Default to false
- Returns:
-
isSelectUnlockedCellsAllowed
public boolean isSelectUnlockedCellsAllowed()
Returns whether to allow select unlocked cells.Default to false
- Returns:
-
-