CTWorkbookProtection (docx4j 3.2.1 API)

java.lang.Object
- org.xlsx4j.sml.CTWorkbookProtection

All Implemented Interfaces:: Child

public class CTWorkbookProtection
extends Object
implements Child

Java class for CT_WorkbookProtection complex type.

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

 <complexType name="CT_WorkbookProtection">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <attribute name="workbookPassword" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}ST_UnsignedShortHex" />
       <attribute name="workbookPasswordCharacterSet" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="revisionsPassword" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}ST_UnsignedShortHex" />
       <attribute name="revisionsPasswordCharacterSet" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="lockStructure" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="lockWindows" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="lockRevision" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="revisionsAlgorithmName" type="{http://schemas.openxmlformats.org/officeDocument/2006/sharedTypes}ST_Xstring" />
       <attribute name="revisionsHashValue" type="{http://www.w3.org/2001/XMLSchema}base64Binary" />
       <attribute name="revisionsSaltValue" type="{http://www.w3.org/2001/XMLSchema}base64Binary" />
       <attribute name="revisionsSpinCount" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" />
       <attribute name="workbookAlgorithmName" type="{http://schemas.openxmlformats.org/officeDocument/2006/sharedTypes}ST_Xstring" />
       <attribute name="workbookHashValue" type="{http://www.w3.org/2001/XMLSchema}base64Binary" />
       <attribute name="workbookSaltValue" type="{http://www.w3.org/2001/XMLSchema}base64Binary" />
       <attribute name="workbookSpinCount" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`lockRevision`
`protected Boolean`	`lockStructure`
`protected Boolean`	`lockWindows`
`protected String`	`revisionsAlgorithmName`
`protected byte[]`	`revisionsHashValue`
`protected byte[]`	`revisionsPassword`
`protected String`	`revisionsPasswordCharacterSet`
`protected byte[]`	`revisionsSaltValue`
`protected Long`	`revisionsSpinCount`
`protected String`	`workbookAlgorithmName`
`protected byte[]`	`workbookHashValue`
`protected byte[]`	`workbookPassword`
`protected String`	`workbookPasswordCharacterSet`
`protected byte[]`	`workbookSaltValue`
`protected Long`	`workbookSpinCount`

Constructor Summary

Constructors
Constructor and Description

CTWorkbookProtection()

Constructors
Constructor and Description
`CTWorkbookProtection()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`afterUnmarshal(javax.xml.bind.Unmarshaller unmarshaller, Object parent)` This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
`Object`	`getParent()` Gets the parent object in the object tree representing the unmarshalled xml document.
`String`	`getRevisionsAlgorithmName()` Gets the value of the revisionsAlgorithmName property.
`byte[]`	`getRevisionsHashValue()` Gets the value of the revisionsHashValue property.
`byte[]`	`getRevisionsPassword()` Gets the value of the revisionsPassword property.
`String`	`getRevisionsPasswordCharacterSet()` Gets the value of the revisionsPasswordCharacterSet property.
`byte[]`	`getRevisionsSaltValue()` Gets the value of the revisionsSaltValue property.
`Long`	`getRevisionsSpinCount()` Gets the value of the revisionsSpinCount property.
`String`	`getWorkbookAlgorithmName()` Gets the value of the workbookAlgorithmName property.
`byte[]`	`getWorkbookHashValue()` Gets the value of the workbookHashValue property.
`byte[]`	`getWorkbookPassword()` Gets the value of the workbookPassword property.
`String`	`getWorkbookPasswordCharacterSet()` Gets the value of the workbookPasswordCharacterSet property.
`byte[]`	`getWorkbookSaltValue()` Gets the value of the workbookSaltValue property.
`Long`	`getWorkbookSpinCount()` Gets the value of the workbookSpinCount property.
`boolean`	`isLockRevision()` Gets the value of the lockRevision property.
`boolean`	`isLockStructure()` Gets the value of the lockStructure property.
`boolean`	`isLockWindows()` Gets the value of the lockWindows property.
`void`	`setLockRevision(Boolean value)` Sets the value of the lockRevision property.
`void`	`setLockStructure(Boolean value)` Sets the value of the lockStructure property.
`void`	`setLockWindows(Boolean value)` Sets the value of the lockWindows property.
`void`	`setParent(Object parent)`
`void`	`setRevisionsAlgorithmName(String value)` Sets the value of the revisionsAlgorithmName property.
`void`	`setRevisionsHashValue(byte[] value)` Sets the value of the revisionsHashValue property.
`void`	`setRevisionsPassword(byte[] value)` Sets the value of the revisionsPassword property.
`void`	`setRevisionsPasswordCharacterSet(String value)` Sets the value of the revisionsPasswordCharacterSet property.
`void`	`setRevisionsSaltValue(byte[] value)` Sets the value of the revisionsSaltValue property.
`void`	`setRevisionsSpinCount(Long value)` Sets the value of the revisionsSpinCount property.
`void`	`setWorkbookAlgorithmName(String value)` Sets the value of the workbookAlgorithmName property.
`void`	`setWorkbookHashValue(byte[] value)` Sets the value of the workbookHashValue property.
`void`	`setWorkbookPassword(byte[] value)` Sets the value of the workbookPassword property.
`void`	`setWorkbookPasswordCharacterSet(String value)` Sets the value of the workbookPasswordCharacterSet property.
`void`	`setWorkbookSaltValue(byte[] value)` Sets the value of the workbookSaltValue property.
`void`	`setWorkbookSpinCount(Long value)` Sets the value of the workbookSpinCount property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - workbookPassword
```
protected byte[] workbookPassword
```
  - workbookPasswordCharacterSet
```
protected String workbookPasswordCharacterSet
```
  - revisionsPassword
```
protected byte[] revisionsPassword
```
  - revisionsPasswordCharacterSet
```
protected String revisionsPasswordCharacterSet
```
  - lockStructure
```
protected Boolean lockStructure
```
  - lockWindows
```
protected Boolean lockWindows
```
  - lockRevision
```
protected Boolean lockRevision
```
  - revisionsAlgorithmName
```
protected String revisionsAlgorithmName
```
  - revisionsHashValue
```
protected byte[] revisionsHashValue
```
  - revisionsSaltValue
```
protected byte[] revisionsSaltValue
```
  - revisionsSpinCount
```
protected Long revisionsSpinCount
```
  - workbookAlgorithmName
```
protected String workbookAlgorithmName
```
  - workbookHashValue
```
protected byte[] workbookHashValue
```
  - workbookSaltValue
```
protected byte[] workbookSaltValue
```
  - workbookSpinCount
```
protected Long workbookSpinCount
```
- Constructor Detail
  - CTWorkbookProtection
```
public CTWorkbookProtection()
```
- Method Detail
  - getWorkbookPassword
```
public byte[] getWorkbookPassword()
```
    Gets the value of the workbookPassword property.
    
    Returns:
    possible object is String
  - setWorkbookPassword
```
public void setWorkbookPassword(byte[] value)
```
    Sets the value of the workbookPassword property.
    
    Parameters:
    value - allowed object is String
  - getWorkbookPasswordCharacterSet
```
public String getWorkbookPasswordCharacterSet()
```
    Gets the value of the workbookPasswordCharacterSet property.
    
    Returns:
    possible object is String
  - setWorkbookPasswordCharacterSet
```
public void setWorkbookPasswordCharacterSet(String value)
```
    Sets the value of the workbookPasswordCharacterSet property.
    
    Parameters:
    value - allowed object is String
  - getRevisionsPassword
```
public byte[] getRevisionsPassword()
```
    Gets the value of the revisionsPassword property.
    
    Returns:
    possible object is String
  - setRevisionsPassword
```
public void setRevisionsPassword(byte[] value)
```
    Sets the value of the revisionsPassword property.
    
    Parameters:
    value - allowed object is String
  - getRevisionsPasswordCharacterSet
```
public String getRevisionsPasswordCharacterSet()
```
    Gets the value of the revisionsPasswordCharacterSet property.
    
    Returns:
    possible object is String
  - setRevisionsPasswordCharacterSet
```
public void setRevisionsPasswordCharacterSet(String value)
```
    Sets the value of the revisionsPasswordCharacterSet property.
    
    Parameters:
    value - allowed object is String
  - isLockStructure
```
public boolean isLockStructure()
```
    Gets the value of the lockStructure property.
    
    Returns:
    possible object is Boolean
  - setLockStructure
```
public void setLockStructure(Boolean value)
```
    Sets the value of the lockStructure property.
    
    Parameters:
    value - allowed object is Boolean
  - isLockWindows
```
public boolean isLockWindows()
```
    Gets the value of the lockWindows property.
    
    Returns:
    possible object is Boolean
  - setLockWindows
```
public void setLockWindows(Boolean value)
```
    Sets the value of the lockWindows property.
    
    Parameters:
    value - allowed object is Boolean
  - isLockRevision
```
public boolean isLockRevision()
```
    Gets the value of the lockRevision property.
    
    Returns:
    possible object is Boolean
  - setLockRevision
```
public void setLockRevision(Boolean value)
```
    Sets the value of the lockRevision property.
    
    Parameters:
    value - allowed object is Boolean
  - getRevisionsAlgorithmName
```
public String getRevisionsAlgorithmName()
```
    Gets the value of the revisionsAlgorithmName property.
    
    Returns:
    possible object is String
  - setRevisionsAlgorithmName
```
public void setRevisionsAlgorithmName(String value)
```
    Sets the value of the revisionsAlgorithmName property.
    
    Parameters:
    value - allowed object is String
  - getRevisionsHashValue
```
public byte[] getRevisionsHashValue()
```
    Gets the value of the revisionsHashValue property.
    
    Returns:
    possible object is byte[]
  - setRevisionsHashValue
```
public void setRevisionsHashValue(byte[] value)
```
    Sets the value of the revisionsHashValue property.
    
    Parameters:
    value - allowed object is byte[]
  - getRevisionsSaltValue
```
public byte[] getRevisionsSaltValue()
```
    Gets the value of the revisionsSaltValue property.
    
    Returns:
    possible object is byte[]
  - setRevisionsSaltValue
```
public void setRevisionsSaltValue(byte[] value)
```
    Sets the value of the revisionsSaltValue property.
    
    Parameters:
    value - allowed object is byte[]
  - getRevisionsSpinCount
```
public Long getRevisionsSpinCount()
```
    Gets the value of the revisionsSpinCount property.
    
    Returns:
    possible object is Long
  - setRevisionsSpinCount
```
public void setRevisionsSpinCount(Long value)
```
    Sets the value of the revisionsSpinCount property.
    
    Parameters:
    value - allowed object is Long
  - getWorkbookAlgorithmName
```
public String getWorkbookAlgorithmName()
```
    Gets the value of the workbookAlgorithmName property.
    
    Returns:
    possible object is String
  - setWorkbookAlgorithmName
```
public void setWorkbookAlgorithmName(String value)
```
    Sets the value of the workbookAlgorithmName property.
    
    Parameters:
    value - allowed object is String
  - getWorkbookHashValue
```
public byte[] getWorkbookHashValue()
```
    Gets the value of the workbookHashValue property.
    
    Returns:
    possible object is byte[]
  - setWorkbookHashValue
```
public void setWorkbookHashValue(byte[] value)
```
    Sets the value of the workbookHashValue property.
    
    Parameters:
    value - allowed object is byte[]
  - getWorkbookSaltValue
```
public byte[] getWorkbookSaltValue()
```
    Gets the value of the workbookSaltValue property.
    
    Returns:
    possible object is byte[]
  - setWorkbookSaltValue
```
public void setWorkbookSaltValue(byte[] value)
```
    Sets the value of the workbookSaltValue property.
    
    Parameters:
    value - allowed object is byte[]
  - getWorkbookSpinCount
```
public Long getWorkbookSpinCount()
```
    Gets the value of the workbookSpinCount property.
    
    Returns:
    possible object is Long
  - setWorkbookSpinCount
```
public void setWorkbookSpinCount(Long value)
```
    Sets the value of the workbookSpinCount property.
    
    Parameters:
    value - allowed object is Long
  - 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(javax.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.

Class CTWorkbookProtection

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

workbookPassword

workbookPasswordCharacterSet

revisionsPassword

revisionsPasswordCharacterSet

lockStructure

lockWindows

lockRevision

revisionsAlgorithmName

revisionsHashValue

revisionsSaltValue

revisionsSpinCount

workbookAlgorithmName

workbookHashValue

workbookSaltValue

workbookSpinCount

Constructor Detail

CTWorkbookProtection

Method Detail

getWorkbookPassword

setWorkbookPassword

getWorkbookPasswordCharacterSet

setWorkbookPasswordCharacterSet

getRevisionsPassword

setRevisionsPassword

getRevisionsPasswordCharacterSet

setRevisionsPasswordCharacterSet

isLockStructure

setLockStructure

isLockWindows

setLockWindows

isLockRevision

setLockRevision

getRevisionsAlgorithmName

setRevisionsAlgorithmName

getRevisionsHashValue

setRevisionsHashValue

getRevisionsSaltValue

setRevisionsSaltValue

getRevisionsSpinCount

setRevisionsSpinCount

getWorkbookAlgorithmName

setWorkbookAlgorithmName

getWorkbookHashValue

setWorkbookHashValue

getWorkbookSaltValue

setWorkbookSaltValue

getWorkbookSpinCount

setWorkbookSpinCount

getParent

setParent

afterUnmarshal