Package org.xlsx4j.sml

Class CTSheetProtection

java.lang.Object
org.xlsx4j.sml.CTSheetProtection
All Implemented Interfaces:
Child
public class CTSheetProtection extends Object implements Child

Java class for CT_SheetProtection complex type.

The following schema fragment specifies the expected content contained within this class. 

 <complexType name="CT_SheetProtection">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <attribute name="password" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}ST_UnsignedShortHex" />
       <attribute name="algorithmName" type="{http://schemas.openxmlformats.org/officeDocument/2006/sharedTypes}ST_Xstring" />
       <attribute name="hashValue" type="{http://www.w3.org/2001/XMLSchema}base64Binary" />
       <attribute name="saltValue" type="{http://www.w3.org/2001/XMLSchema}base64Binary" />
       <attribute name="spinCount" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" />
       <attribute name="sheet" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="objects" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="scenarios" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="formatCells" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="formatColumns" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="formatRows" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="insertColumns" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="insertRows" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="insertHyperlinks" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="deleteColumns" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="deleteRows" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="selectLockedCells" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="sort" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="autoFilter" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="pivotTables" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="selectUnlockedCells" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
     </restriction>
   </complexContent>
 </complexType>

  • Field Details

    • password

      protected byte[] password

    • algorithmName

      protected String algorithmName

    • hashValue

      protected byte[] hashValue

    • saltValue

      protected byte[] saltValue

    • spinCount

      protected Long spinCount

    • sheet

      protected Boolean sheet

    • objects

      protected Boolean objects

    • scenarios

      protected Boolean scenarios

    • formatCells

      protected Boolean formatCells

    • formatColumns

      protected Boolean formatColumns

    • formatRows

      protected Boolean formatRows

    • insertColumns

      protected Boolean insertColumns

    • insertRows

      protected Boolean insertRows

    • deleteColumns

      protected Boolean deleteColumns

    • deleteRows

      protected Boolean deleteRows

    • selectLockedCells

      protected Boolean selectLockedCells

    • sort

      protected Boolean sort

    • autoFilter

      protected Boolean autoFilter

    • pivotTables

      protected Boolean pivotTables

    • selectUnlockedCells

      protected Boolean selectUnlockedCells

  • Constructor Details

    • CTSheetProtection

      public CTSheetProtection()

  • Method Details

    • getPassword

      public byte[] getPassword()
      Gets the value of the password property.
      Returns:
      possible object is String

    • setPassword

      public void setPassword(byte[] value)
      Sets the value of the password property.
      Parameters:
      value - allowed object is String

    • getAlgorithmName

      public String getAlgorithmName()
      Gets the value of the algorithmName property.
      Returns:
      possible object is String

    • setAlgorithmName

      public void setAlgorithmName(String value)
      Sets the value of the algorithmName property.
      Parameters:
      value - allowed object is String

    • getHashValue

      public byte[] getHashValue()
      Gets the value of the hashValue property.
      Returns:
      possible object is byte[]

    • setHashValue

      public void setHashValue(byte[] value)
      Sets the value of the hashValue property.
      Parameters:
      value - allowed object is byte[]

    • getSaltValue

      public byte[] getSaltValue()
      Gets the value of the saltValue property.
      Returns:
      possible object is byte[]

    • setSaltValue

      public void setSaltValue(byte[] value)
      Sets the value of the saltValue property.
      Parameters:
      value - allowed object is byte[]

    • getSpinCount

      public Long getSpinCount()
      Gets the value of the spinCount property.
      Returns:
      possible object is Long

    • setSpinCount

      public void setSpinCount(Long value)
      Sets the value of the spinCount property.
      Parameters:
      value - allowed object is Long

    • isSheet

      public boolean isSheet()
      Gets the value of the sheet property.
      Returns:
      possible object is Boolean

    • setSheet

      public void setSheet(Boolean value)
      Sets the value of the sheet property.
      Parameters:
      value - allowed object is Boolean

    • isObjects

      public boolean isObjects()
      Gets the value of the objects property.
      Returns:
      possible object is Boolean

    • setObjects

      public void setObjects(Boolean value)
      Sets the value of the objects property.
      Parameters:
      value - allowed object is Boolean

    • isScenarios

      public boolean isScenarios()
      Gets the value of the scenarios property.
      Returns:
      possible object is Boolean

    • setScenarios

      public void setScenarios(Boolean value)
      Sets the value of the scenarios property.
      Parameters:
      value - allowed object is Boolean

    • isFormatCells

      public boolean isFormatCells()
      Gets the value of the formatCells property.
      Returns:
      possible object is Boolean

    • setFormatCells

      public void setFormatCells(Boolean value)
      Sets the value of the formatCells property.
      Parameters:
      value - allowed object is Boolean

    • isFormatColumns

      public boolean isFormatColumns()
      Gets the value of the formatColumns property.
      Returns:
      possible object is Boolean

    • setFormatColumns

      public void setFormatColumns(Boolean value)
      Sets the value of the formatColumns property.
      Parameters:
      value - allowed object is Boolean

    • isFormatRows

      public boolean isFormatRows()
      Gets the value of the formatRows property.
      Returns:
      possible object is Boolean

    • setFormatRows

      public void setFormatRows(Boolean value)
      Sets the value of the formatRows property.
      Parameters:
      value - allowed object is Boolean

    • isInsertColumns

      public boolean isInsertColumns()
      Gets the value of the insertColumns property.
      Returns:
      possible object is Boolean

    • setInsertColumns

      public void setInsertColumns(Boolean value)
      Sets the value of the insertColumns property.
      Parameters:
      value - allowed object is Boolean

    • isInsertRows

      public boolean isInsertRows()
      Gets the value of the insertRows property.
      Returns:
      possible object is Boolean

    • setInsertRows

      public void setInsertRows(Boolean value)
      Sets the value of the insertRows property.
      Parameters:
      value - allowed object is Boolean

    • isInsertHyperlinks

      public boolean isInsertHyperlinks()
      Gets the value of the insertHyperlinks property.
      Returns:
      possible object is Boolean

    • setInsertHyperlinks

      public void setInsertHyperlinks(Boolean value)
      Sets the value of the insertHyperlinks property.
      Parameters:
      value - allowed object is Boolean

    • isDeleteColumns

      public boolean isDeleteColumns()
      Gets the value of the deleteColumns property.
      Returns:
      possible object is Boolean

    • setDeleteColumns

      public void setDeleteColumns(Boolean value)
      Sets the value of the deleteColumns property.
      Parameters:
      value - allowed object is Boolean

    • isDeleteRows

      public boolean isDeleteRows()
      Gets the value of the deleteRows property.
      Returns:
      possible object is Boolean

    • setDeleteRows

      public void setDeleteRows(Boolean value)
      Sets the value of the deleteRows property.
      Parameters:
      value - allowed object is Boolean

    • isSelectLockedCells

      public boolean isSelectLockedCells()
      Gets the value of the selectLockedCells property.
      Returns:
      possible object is Boolean

    • setSelectLockedCells

      public void setSelectLockedCells(Boolean value)
      Sets the value of the selectLockedCells property.
      Parameters:
      value - allowed object is Boolean

    • isSort

      public boolean isSort()
      Gets the value of the sort property.
      Returns:
      possible object is Boolean

    • setSort

      public void setSort(Boolean value)
      Sets the value of the sort property.
      Parameters:
      value - allowed object is Boolean

    • isAutoFilter

      public boolean isAutoFilter()
      Gets the value of the autoFilter property.
      Returns:
      possible object is Boolean

    • setAutoFilter

      public void setAutoFilter(Boolean value)
      Sets the value of the autoFilter property.
      Parameters:
      value - allowed object is Boolean

    • isPivotTables

      public boolean isPivotTables()
      Gets the value of the pivotTables property.
      Returns:
      possible object is Boolean

    • setPivotTables

      public void setPivotTables(Boolean value)
      Sets the value of the pivotTables property.
      Parameters:
      value - allowed object is Boolean

    • isSelectUnlockedCells

      public boolean isSelectUnlockedCells()
      Gets the value of the selectUnlockedCells property.
      Returns:
      possible object is Boolean

    • setSelectUnlockedCells

      public void setSelectUnlockedCells(Boolean value)
      Sets the value of the selectUnlockedCells property.
      Parameters:
      value - allowed object is Boolean

    • getParent

      public Object getParent()
      Gets the parent object in the object tree representing the unmarshalled xml document.
      Specified by:
      getParent in interface Child
      Returns:
      The parent object.

    • setParent

      public void setParent(Object parent)
      Specified by:
      setParent in interface Child

    • afterUnmarshal

      public void afterUnmarshal(jakarta.xml.bind.Unmarshaller unmarshaller, Object parent)
      This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
      Parameters:
      parent - The parent object in the object tree.
      unmarshaller - The unmarshaller that generated the instance.