io.keikai.client.api

Class SheetProtection.Builder

java.lang.Object

io.keikai.client.api.SheetProtection.Builder

Enclosing class:

SheetProtection

public static final class SheetProtection.Builder
extends Object

Builder is used to build instances of SheetProtection from values configured by the setters

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SheetProtection	build() Returns an instance of SheetProtection created from the fields set on this builder.
void	clear() Resets the builder to its initial, empty state.
SheetProtection.Builder	setAllowDeletingColumns(boolean allowDeletingColumns) Sets true to allow user to delete columns on the protected sheet.
SheetProtection.Builder	setAllowDeletingRows(boolean allowDeletingRows) Sets true to allow user to delete rows on the protected sheet.
SheetProtection.Builder	setAllowFiltering(boolean allowFiltering) Sets true to allow user to set filters on the protected sheet
SheetProtection.Builder	setAllowFormattingCells(boolean allowFormattingCells) Sets true to allow user to format any cell on the protected sheet.
SheetProtection.Builder	setAllowFormattingColumns(boolean allowFormattingColumns) Sets true to allow user to format any columns on the protected sheet.
SheetProtection.Builder	setAllowFormattingRows(boolean allowFormattingRows) Sets true to allow user to format any rows on the protected sheet.
SheetProtection.Builder	setAllowInsertingColumns(boolean allowInsertingColumns) Sets true to allow user to insert columns on the protected sheet.
SheetProtection.Builder	setAllowInsertingHyperlinks(boolean allowInsertingHyperlinks) Sets true to allow user to insert hyperlinks on the protected sheet.
SheetProtection.Builder	setAllowInsertingRows(boolean allowInsertingRows) Sets true to allow user to insert rows on the protected sheet.
SheetProtection.Builder	setAllowSelectLockedCells(boolean allowSelectLockedCells) Sets true to allow select locked cells.
SheetProtection.Builder	setAllowSelectUnlockedCells(boolean allowSelectUnlockedCells) Sets true to allow select unlocked cells
SheetProtection.Builder	setAllowSorting(boolean allowSorting) Sets true to allow user to sort on the protected sheet.
SheetProtection.Builder	setAllowUsingPivotTables(boolean allowUsingPivotTables) Sets true to allow user to use pivot table reports on the protected sheet.
SheetProtection.Builder	setDrawingObjects(boolean drawingObjects) Sets the drawingObjects to true to protect objects.
SheetProtection.Builder	setPassword(String password) Sets the case-sensitive password for the sheet; null or empty string means protect the sheet without password.
SheetProtection.Builder	setScenarios(boolean scenarios) Sets true to protect scenarios.
SheetProtection.Builder	setUserInterfaceOnly(boolean userInterfaceOnly) Sets true to forbid user to modify this the through UI e.g.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

setPassword

public SheetProtection.Builder setPassword(String password)

Sets the case-sensitive password for the sheet; null or empty string means protect the sheet without password.

Default to null

Parameters:

password -

setDrawingObjects

public SheetProtection.Builder setDrawingObjects(boolean drawingObjects)

Sets the drawingObjects to true to protect objects.

Default to true

Parameters:

drawingObjects -

setScenarios

public SheetProtection.Builder setScenarios(boolean scenarios)

Sets true to protect scenarios.

Default to true

Parameters:

scenarios -

setUserInterfaceOnly

public SheetProtection.Builder setUserInterfaceOnly(boolean userInterfaceOnly)

Sets true to forbid user to modify this the through UI e.g. click a button on the toolbar, but calling API still can modify the sheet.

Default to false

Parameters:

userInterfaceOnly -

setAllowFormattingCells

public SheetProtection.Builder setAllowFormattingCells(boolean allowFormattingCells)

Sets true to allow user to format any cell on the protected sheet.

Default to false

Parameters:

allowFormattingCells -

setAllowFormattingColumns

public SheetProtection.Builder setAllowFormattingColumns(boolean allowFormattingColumns)

Sets true to allow user to format any columns on the protected sheet.

Default to false

Parameters:

allowFormattingColumns -

setAllowFormattingRows

public SheetProtection.Builder setAllowFormattingRows(boolean allowFormattingRows)

Sets true to allow user to format any rows on the protected sheet.

Default to false

Parameters:

allowFormattingRows -

setAllowInsertingColumns

public SheetProtection.Builder setAllowInsertingColumns(boolean allowInsertingColumns)

Sets true to allow user to insert columns on the protected sheet.

Default to false

Parameters:

allowInsertingColumns -

setAllowInsertingRows

public SheetProtection.Builder setAllowInsertingRows(boolean allowInsertingRows)

Sets true to allow user to insert rows on the protected sheet.

Default to false

Parameters:

allowInsertingRows -

setAllowInsertingHyperlinks

public SheetProtection.Builder setAllowInsertingHyperlinks(boolean allowInsertingHyperlinks)

Sets true to allow user to insert hyperlinks on the protected sheet.

Default to false

Parameters:

allowInsertingHyperlinks -

setAllowDeletingColumns

public SheetProtection.Builder setAllowDeletingColumns(boolean allowDeletingColumns)

Sets true to allow user to delete columns on the protected sheet.

Default to false

Parameters:

allowDeletingColumns -

setAllowDeletingRows

public SheetProtection.Builder setAllowDeletingRows(boolean allowDeletingRows)

Sets true to allow user to delete rows on the protected sheet.

Default to false

Parameters:

allowDeletingRows -

setAllowSorting

public SheetProtection.Builder setAllowSorting(boolean allowSorting)

Sets true to allow user to sort on the protected sheet.

Default to false

Parameters:

allowSorting -

setAllowFiltering

public SheetProtection.Builder setAllowFiltering(boolean allowFiltering)

Sets true to allow user to set filters on the protected sheet

Default to false

Parameters:

allowFiltering -

setAllowUsingPivotTables

public SheetProtection.Builder setAllowUsingPivotTables(boolean allowUsingPivotTables)

Sets true to allow user to use pivot table reports on the protected sheet.

Default to false

Parameters:

allowUsingPivotTables -

setAllowSelectLockedCells

public SheetProtection.Builder setAllowSelectLockedCells(boolean allowSelectLockedCells)

Sets true to allow select locked cells.

Default to false

Parameters:

allowSelectLockedCells -

setAllowSelectUnlockedCells

public SheetProtection.Builder setAllowSelectUnlockedCells(boolean allowSelectUnlockedCells)

Sets true to allow select unlocked cells

Parameters:

allowSelectUnlockedCells -

build

public SheetProtection build()

Returns an instance of SheetProtection created from the fields set on this builder.

Returns:

clear

public void clear()

Resets the builder to its initial, empty state.