Package org.xlsx4j.sml

Class CTSheetProtection

java.lang.Object
org.xlsx4j.sml.CTSheetProtection
All Implemented Interfaces:
Child
public class CTSheetProtection
extends java.lang.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 Summary

    Fields
    Modifier and Type Field Description
    protected java.lang.String algorithmName  
    protected java.lang.Boolean autoFilter  
    protected java.lang.Boolean deleteColumns  
    protected java.lang.Boolean deleteRows  
    protected java.lang.Boolean formatCells  
    protected java.lang.Boolean formatColumns  
    protected java.lang.Boolean formatRows  
    protected byte[] hashValue  
    protected java.lang.Boolean insertColumns  
    protected java.lang.Boolean insertHyperlinks  
    protected java.lang.Boolean insertRows  
    protected java.lang.Boolean objects  
    protected byte[] password  
    protected java.lang.Boolean pivotTables  
    protected byte[] saltValue  
    protected java.lang.Boolean scenarios  
    protected java.lang.Boolean selectLockedCells  
    protected java.lang.Boolean selectUnlockedCells  
    protected java.lang.Boolean sheet  
    protected java.lang.Boolean sort  
    protected java.lang.Long spinCount  

  • Constructor Summary

    Constructors
    Constructor Description
    CTSheetProtection()  

  • Method Summary

    Modifier and Type Method Description
    void afterUnmarshal​(jakarta.xml.bind.Unmarshaller unmarshaller, java.lang.Object parent)
    This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
    java.lang.String getAlgorithmName()
    Gets the value of the algorithmName property.
    byte[] getHashValue()
    Gets the value of the hashValue property.
    java.lang.Object getParent()
    Gets the parent object in the object tree representing the unmarshalled xml document.
    byte[] getPassword()
    Gets the value of the password property.
    byte[] getSaltValue()
    Gets the value of the saltValue property.
    java.lang.Long getSpinCount()
    Gets the value of the spinCount property.
    boolean isAutoFilter()
    Gets the value of the autoFilter property.
    boolean isDeleteColumns()
    Gets the value of the deleteColumns property.
    boolean isDeleteRows()
    Gets the value of the deleteRows property.
    boolean isFormatCells()
    Gets the value of the formatCells property.
    boolean isFormatColumns()
    Gets the value of the formatColumns property.
    boolean isFormatRows()
    Gets the value of the formatRows property.
    boolean isInsertColumns()
    Gets the value of the insertColumns property.
    boolean isInsertHyperlinks()
    Gets the value of the insertHyperlinks property.
    boolean isInsertRows()
    Gets the value of the insertRows property.
    boolean isObjects()
    Gets the value of the objects property.
    boolean isPivotTables()
    Gets the value of the pivotTables property.
    boolean isScenarios()
    Gets the value of the scenarios property.
    boolean isSelectLockedCells()
    Gets the value of the selectLockedCells property.
    boolean isSelectUnlockedCells()
    Gets the value of the selectUnlockedCells property.
    boolean isSheet()
    Gets the value of the sheet property.
    boolean isSort()
    Gets the value of the sort property.
    void setAlgorithmName​(java.lang.String value)
    Sets the value of the algorithmName property.
    void setAutoFilter​(java.lang.Boolean value)
    Sets the value of the autoFilter property.
    void setDeleteColumns​(java.lang.Boolean value)
    Sets the value of the deleteColumns property.
    void setDeleteRows​(java.lang.Boolean value)
    Sets the value of the deleteRows property.
    void setFormatCells​(java.lang.Boolean value)
    Sets the value of the formatCells property.
    void setFormatColumns​(java.lang.Boolean value)
    Sets the value of the formatColumns property.
    void setFormatRows​(java.lang.Boolean value)
    Sets the value of the formatRows property.
    void setHashValue​(byte[] value)
    Sets the value of the hashValue property.
    void setInsertColumns​(java.lang.Boolean value)
    Sets the value of the insertColumns property.
    void setInsertHyperlinks​(java.lang.Boolean value)
    Sets the value of the insertHyperlinks property.
    void setInsertRows​(java.lang.Boolean value)
    Sets the value of the insertRows property.
    void setObjects​(java.lang.Boolean value)
    Sets the value of the objects property.
    void setParent​(java.lang.Object parent)  
    void setPassword​(byte[] value)
    Sets the value of the password property.
    void setPivotTables​(java.lang.Boolean value)
    Sets the value of the pivotTables property.
    void setSaltValue​(byte[] value)
    Sets the value of the saltValue property.
    void setScenarios​(java.lang.Boolean value)
    Sets the value of the scenarios property.
    void setSelectLockedCells​(java.lang.Boolean value)
    Sets the value of the selectLockedCells property.
    void setSelectUnlockedCells​(java.lang.Boolean value)
    Sets the value of the selectUnlockedCells property.
    void setSheet​(java.lang.Boolean value)
    Sets the value of the sheet property.
    void setSort​(java.lang.Boolean value)
    Sets the value of the sort property.
    void setSpinCount​(java.lang.Long value)
    Sets the value of the spinCount property.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • password

      protected byte[] password

    • algorithmName

      protected java.lang.String algorithmName

    • hashValue

      protected byte[] hashValue

    • saltValue

      protected byte[] saltValue

    • spinCount

      protected java.lang.Long spinCount

    • sheet

      protected java.lang.Boolean sheet

    • objects

      protected java.lang.Boolean objects

    • scenarios

      protected java.lang.Boolean scenarios

    • formatCells

      protected java.lang.Boolean formatCells

    • formatColumns

      protected java.lang.Boolean formatColumns

    • formatRows

      protected java.lang.Boolean formatRows

    • insertColumns

      protected java.lang.Boolean insertColumns

    • insertRows

      protected java.lang.Boolean insertRows

    • deleteColumns

      protected java.lang.Boolean deleteColumns

    • deleteRows

      protected java.lang.Boolean deleteRows

    • selectLockedCells

      protected java.lang.Boolean selectLockedCells

    • sort

      protected java.lang.Boolean sort

    • autoFilter

      protected java.lang.Boolean autoFilter

    • pivotTables

      protected java.lang.Boolean pivotTables

    • selectUnlockedCells

      protected java.lang.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 java.lang.String getAlgorithmName()
      Gets the value of the algorithmName property.
      Returns:
      possible object is String

    • setAlgorithmName

      public void setAlgorithmName​(java.lang.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 java.lang.Long getSpinCount()
      Gets the value of the spinCount property.
      Returns:
      possible object is Long

    • setSpinCount

      public void setSpinCount​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.Boolean value)
      Sets the value of the selectUnlockedCells property.
      Parameters:
      value - allowed object is Boolean

    • getParent

      public java.lang.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​(java.lang.Object parent)
      Specified by:
      setParent in interface Child

    • afterUnmarshal

      public void afterUnmarshal​(jakarta.xml.bind.Unmarshaller unmarshaller, java.lang.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.