Workbook (docx4j 6.1.2 API)

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

All Implemented Interfaces:: Child

public class Workbook
extends Object
implements Child

Java class for CT_Workbook complex type.

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

 <complexType name="CT_Workbook">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="fileVersion" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_FileVersion" minOccurs="0"/>
         <element name="fileSharing" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_FileSharing" minOccurs="0"/>
         <element name="workbookPr" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_WorkbookPr" minOccurs="0"/>
         <element name="workbookProtection" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_WorkbookProtection" minOccurs="0"/>
         <element name="bookViews" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_BookViews" minOccurs="0"/>
         <element name="sheets" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_Sheets"/>
         <element name="functionGroups" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_FunctionGroups" minOccurs="0"/>
         <element name="externalReferences" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_ExternalReferences" minOccurs="0"/>
         <element name="definedNames" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_DefinedNames" minOccurs="0"/>
         <element name="calcPr" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_CalcPr" minOccurs="0"/>
         <element name="oleSize" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_OleSize" minOccurs="0"/>
         <element name="customWorkbookViews" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_CustomWorkbookViews" minOccurs="0"/>
         <element name="pivotCaches" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_PivotCaches" minOccurs="0"/>
         <element name="smartTagPr" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_SmartTagPr" minOccurs="0"/>
         <element name="smartTagTypes" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_SmartTagTypes" minOccurs="0"/>
         <element name="webPublishing" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_WebPublishing" minOccurs="0"/>
         <element name="fileRecoveryPr" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_FileRecoveryPr" maxOccurs="unbounded" minOccurs="0"/>
         <element name="webPublishObjects" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_WebPublishObjects" minOccurs="0"/>
         <element name="extLst" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_ExtensionList" minOccurs="0"/>
       </sequence>
       <attribute name="conformance" type="{http://schemas.openxmlformats.org/officeDocument/2006/sharedTypes}ST_ConformanceClass" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected BookViews`	`bookViews`
`protected CTCalcPr`	`calcPr`
`protected STConformanceClass`	`conformance`
`protected CTCustomWorkbookViews`	`customWorkbookViews`
`protected DefinedNames`	`definedNames`
`protected CTExternalReferences`	`externalReferences`
`protected CTExtensionList`	`extLst`
`protected List<CTFileRecoveryPr>`	`fileRecoveryPr`
`protected CTFileSharing`	`fileSharing`
`protected FileVersion`	`fileVersion`
`protected CTFunctionGroups`	`functionGroups`
`protected CTOleSize`	`oleSize`
`protected CTPivotCaches`	`pivotCaches`
`protected Sheets`	`sheets`
`protected CTSmartTagPr`	`smartTagPr`
`protected CTSmartTagTypes`	`smartTagTypes`
`protected CTWebPublishing`	`webPublishing`
`protected CTWebPublishObjects`	`webPublishObjects`
`protected WorkbookPr`	`workbookPr`
`protected CTWorkbookProtection`	`workbookProtection`

Constructor Summary

Constructors
Constructor and Description

Workbook()

Constructors
Constructor and Description
`Workbook()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterUnmarshal(Unmarshaller unmarshaller, Object parent)` This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
`BookViews`	`getBookViews()` Gets the value of the bookViews property.
`CTCalcPr`	`getCalcPr()` Gets the value of the calcPr property.
`STConformanceClass`	`getConformance()` Gets the value of the conformance property.
`CTCustomWorkbookViews`	`getCustomWorkbookViews()` Gets the value of the customWorkbookViews property.
`DefinedNames`	`getDefinedNames()` Gets the value of the definedNames property.
`CTExternalReferences`	`getExternalReferences()` Gets the value of the externalReferences property.
`CTExtensionList`	`getExtLst()` Gets the value of the extLst property.
`List<CTFileRecoveryPr>`	`getFileRecoveryPr()` Gets the value of the fileRecoveryPr property.
`CTFileSharing`	`getFileSharing()` Gets the value of the fileSharing property.
`FileVersion`	`getFileVersion()` Gets the value of the fileVersion property.
`CTFunctionGroups`	`getFunctionGroups()` Gets the value of the functionGroups property.
`CTOleSize`	`getOleSize()` Gets the value of the oleSize property.
`Object`	`getParent()` Gets the parent object in the object tree representing the unmarshalled xml document.
`CTPivotCaches`	`getPivotCaches()` Gets the value of the pivotCaches property.
`Sheets`	`getSheets()` Gets the value of the sheets property.
`CTSmartTagPr`	`getSmartTagPr()` Gets the value of the smartTagPr property.
`CTSmartTagTypes`	`getSmartTagTypes()` Gets the value of the smartTagTypes property.
`CTWebPublishing`	`getWebPublishing()` Gets the value of the webPublishing property.
`CTWebPublishObjects`	`getWebPublishObjects()` Gets the value of the webPublishObjects property.
`WorkbookPr`	`getWorkbookPr()` Gets the value of the workbookPr property.
`CTWorkbookProtection`	`getWorkbookProtection()` Gets the value of the workbookProtection property.
`void`	`setBookViews(BookViews value)` Sets the value of the bookViews property.
`void`	`setCalcPr(CTCalcPr value)` Sets the value of the calcPr property.
`void`	`setConformance(STConformanceClass value)` Sets the value of the conformance property.
`void`	`setCustomWorkbookViews(CTCustomWorkbookViews value)` Sets the value of the customWorkbookViews property.
`void`	`setDefinedNames(DefinedNames value)` Sets the value of the definedNames property.
`void`	`setExternalReferences(CTExternalReferences value)` Sets the value of the externalReferences property.
`void`	`setExtLst(CTExtensionList value)` Sets the value of the extLst property.
`void`	`setFileSharing(CTFileSharing value)` Sets the value of the fileSharing property.
`void`	`setFileVersion(FileVersion value)` Sets the value of the fileVersion property.
`void`	`setFunctionGroups(CTFunctionGroups value)` Sets the value of the functionGroups property.
`void`	`setOleSize(CTOleSize value)` Sets the value of the oleSize property.
`void`	`setParent(Object parent)`
`void`	`setPivotCaches(CTPivotCaches value)` Sets the value of the pivotCaches property.
`void`	`setSheets(Sheets value)` Sets the value of the sheets property.
`void`	`setSmartTagPr(CTSmartTagPr value)` Sets the value of the smartTagPr property.
`void`	`setSmartTagTypes(CTSmartTagTypes value)` Sets the value of the smartTagTypes property.
`void`	`setWebPublishing(CTWebPublishing value)` Sets the value of the webPublishing property.
`void`	`setWebPublishObjects(CTWebPublishObjects value)` Sets the value of the webPublishObjects property.
`void`	`setWorkbookPr(WorkbookPr value)` Sets the value of the workbookPr property.
`void`	`setWorkbookProtection(CTWorkbookProtection value)` Sets the value of the workbookProtection property.

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

- Field Detail
  - fileVersion
```
protected FileVersion fileVersion
```
  - fileSharing
```
protected CTFileSharing fileSharing
```
  - workbookPr
```
protected WorkbookPr workbookPr
```
  - workbookProtection
```
protected CTWorkbookProtection workbookProtection
```
  - bookViews
```
protected BookViews bookViews
```
  - sheets
```
protected Sheets sheets
```
  - functionGroups
```
protected CTFunctionGroups functionGroups
```
  - externalReferences
```
protected CTExternalReferences externalReferences
```
  - definedNames
```
protected DefinedNames definedNames
```
  - calcPr
```
protected CTCalcPr calcPr
```
  - oleSize
```
protected CTOleSize oleSize
```
  - customWorkbookViews
```
protected CTCustomWorkbookViews customWorkbookViews
```
  - pivotCaches
```
protected CTPivotCaches pivotCaches
```
  - smartTagPr
```
protected CTSmartTagPr smartTagPr
```
  - smartTagTypes
```
protected CTSmartTagTypes smartTagTypes
```
  - webPublishing
```
protected CTWebPublishing webPublishing
```
  - fileRecoveryPr
```
protected List<CTFileRecoveryPr> fileRecoveryPr
```
  - webPublishObjects
```
protected CTWebPublishObjects webPublishObjects
```
  - extLst
```
protected CTExtensionList extLst
```
  - conformance
```
protected STConformanceClass conformance
```
- Constructor Detail
  - Workbook
```
public Workbook()
```
- Method Detail
  - getFileVersion
```
public FileVersion getFileVersion()
```
    Gets the value of the fileVersion property.
    
    Returns:
    
    possible object is FileVersion
  - setFileVersion
```
public void setFileVersion(FileVersion value)
```
    Sets the value of the fileVersion property.
    
    Parameters:
    
    value - allowed object is FileVersion
  - getFileSharing
```
public CTFileSharing getFileSharing()
```
    Gets the value of the fileSharing property.
    
    Returns:
    
    possible object is CTFileSharing
  - setFileSharing
```
public void setFileSharing(CTFileSharing value)
```
    Sets the value of the fileSharing property.
    
    Parameters:
    
    value - allowed object is CTFileSharing
  - getWorkbookPr
```
public WorkbookPr getWorkbookPr()
```
    Gets the value of the workbookPr property.
    
    Returns:
    
    possible object is WorkbookPr
  - setWorkbookPr
```
public void setWorkbookPr(WorkbookPr value)
```
    Sets the value of the workbookPr property.
    
    Parameters:
    
    value - allowed object is WorkbookPr
  - getWorkbookProtection
```
public CTWorkbookProtection getWorkbookProtection()
```
    Gets the value of the workbookProtection property.
    
    Returns:
    
    possible object is CTWorkbookProtection
  - setWorkbookProtection
```
public void setWorkbookProtection(CTWorkbookProtection value)
```
    Sets the value of the workbookProtection property.
    
    Parameters:
    
    value - allowed object is CTWorkbookProtection
  - getBookViews
```
public BookViews getBookViews()
```
    Gets the value of the bookViews property.
    
    Returns:
    
    possible object is BookViews
  - setBookViews
```
public void setBookViews(BookViews value)
```
    Sets the value of the bookViews property.
    
    Parameters:
    
    value - allowed object is BookViews
  - getSheets
```
public Sheets getSheets()
```
    Gets the value of the sheets property.
    
    Returns:
    
    possible object is Sheets
  - setSheets
```
public void setSheets(Sheets value)
```
    Sets the value of the sheets property.
    
    Parameters:
    
    value - allowed object is Sheets
  - getFunctionGroups
```
public CTFunctionGroups getFunctionGroups()
```
    Gets the value of the functionGroups property.
    
    Returns:
    
    possible object is CTFunctionGroups
  - setFunctionGroups
```
public void setFunctionGroups(CTFunctionGroups value)
```
    Sets the value of the functionGroups property.
    
    Parameters:
    
    value - allowed object is CTFunctionGroups
  - getExternalReferences
```
public CTExternalReferences getExternalReferences()
```
    Gets the value of the externalReferences property.
    
    Returns:
    
    possible object is CTExternalReferences
  - setExternalReferences
```
public void setExternalReferences(CTExternalReferences value)
```
    Sets the value of the externalReferences property.
    
    Parameters:
    
    value - allowed object is CTExternalReferences
  - getDefinedNames
```
public DefinedNames getDefinedNames()
```
    Gets the value of the definedNames property.
    
    Returns:
    
    possible object is DefinedNames
  - setDefinedNames
```
public void setDefinedNames(DefinedNames value)
```
    Sets the value of the definedNames property.
    
    Parameters:
    
    value - allowed object is DefinedNames
  - getCalcPr
```
public CTCalcPr getCalcPr()
```
    Gets the value of the calcPr property.
    
    Returns:
    
    possible object is CTCalcPr
  - setCalcPr
```
public void setCalcPr(CTCalcPr value)
```
    Sets the value of the calcPr property.
    
    Parameters:
    
    value - allowed object is CTCalcPr
  - getOleSize
```
public CTOleSize getOleSize()
```
    Gets the value of the oleSize property.
    
    Returns:
    
    possible object is CTOleSize
  - setOleSize
```
public void setOleSize(CTOleSize value)
```
    Sets the value of the oleSize property.
    
    Parameters:
    
    value - allowed object is CTOleSize
  - getCustomWorkbookViews
```
public CTCustomWorkbookViews getCustomWorkbookViews()
```
    Gets the value of the customWorkbookViews property.
    
    Returns:
    
    possible object is CTCustomWorkbookViews
  - setCustomWorkbookViews
```
public void setCustomWorkbookViews(CTCustomWorkbookViews value)
```
    Sets the value of the customWorkbookViews property.
    
    Parameters:
    
    value - allowed object is CTCustomWorkbookViews
  - getPivotCaches
```
public CTPivotCaches getPivotCaches()
```
    Gets the value of the pivotCaches property.
    
    Returns:
    
    possible object is CTPivotCaches
  - setPivotCaches
```
public void setPivotCaches(CTPivotCaches value)
```
    Sets the value of the pivotCaches property.
    
    Parameters:
    
    value - allowed object is CTPivotCaches
  - getSmartTagPr
```
public CTSmartTagPr getSmartTagPr()
```
    Gets the value of the smartTagPr property.
    
    Returns:
    
    possible object is CTSmartTagPr
  - setSmartTagPr
```
public void setSmartTagPr(CTSmartTagPr value)
```
    Sets the value of the smartTagPr property.
    
    Parameters:
    
    value - allowed object is CTSmartTagPr
  - getSmartTagTypes
```
public CTSmartTagTypes getSmartTagTypes()
```
    Gets the value of the smartTagTypes property.
    
    Returns:
    
    possible object is CTSmartTagTypes
  - setSmartTagTypes
```
public void setSmartTagTypes(CTSmartTagTypes value)
```
    Sets the value of the smartTagTypes property.
    
    Parameters:
    
    value - allowed object is CTSmartTagTypes
  - getWebPublishing
```
public CTWebPublishing getWebPublishing()
```
    Gets the value of the webPublishing property.
    
    Returns:
    
    possible object is CTWebPublishing
  - setWebPublishing
```
public void setWebPublishing(CTWebPublishing value)
```
    Sets the value of the webPublishing property.
    
    Parameters:
    
    value - allowed object is CTWebPublishing
  - getFileRecoveryPr
```
public List<CTFileRecoveryPr> getFileRecoveryPr()
```
    Gets the value of the fileRecoveryPr property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the fileRecoveryPr property.
    For example, to add a new item, do as follows:
```
    getFileRecoveryPr().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list CTFileRecoveryPr
  - getWebPublishObjects
```
public CTWebPublishObjects getWebPublishObjects()
```
    Gets the value of the webPublishObjects property.
    
    Returns:
    
    possible object is CTWebPublishObjects
  - setWebPublishObjects
```
public void setWebPublishObjects(CTWebPublishObjects value)
```
    Sets the value of the webPublishObjects property.
    
    Parameters:
    
    value - allowed object is CTWebPublishObjects
  - getExtLst
```
public CTExtensionList getExtLst()
```
    Gets the value of the extLst property.
    
    Returns:
    
    possible object is CTExtensionList
  - setExtLst
```
public void setExtLst(CTExtensionList value)
```
    Sets the value of the extLst property.
    
    Parameters:
    
    value - allowed object is CTExtensionList
  - getConformance
```
public STConformanceClass getConformance()
```
    Gets the value of the conformance property.
    
    Returns:
    
    possible object is STConformanceClass
  - setConformance
```
public void setConformance(STConformanceClass value)
```
    Sets the value of the conformance property.
    
    Parameters:
    
    value - allowed object is STConformanceClass
  - 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(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 Workbook

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

fileVersion

fileSharing

workbookPr

workbookProtection

bookViews

sheets

functionGroups

externalReferences

definedNames

calcPr

oleSize

customWorkbookViews

pivotCaches

smartTagPr

smartTagTypes

webPublishing

fileRecoveryPr

webPublishObjects

extLst

conformance

Constructor Detail

Workbook

Method Detail

getFileVersion

setFileVersion

getFileSharing

setFileSharing

getWorkbookPr

setWorkbookPr

getWorkbookProtection

setWorkbookProtection

getBookViews

setBookViews

getSheets

setSheets

getFunctionGroups

setFunctionGroups

getExternalReferences

setExternalReferences

getDefinedNames

setDefinedNames

getCalcPr

setCalcPr

getOleSize

setOleSize

getCustomWorkbookViews

setCustomWorkbookViews

getPivotCaches

setPivotCaches

getSmartTagPr

setSmartTagPr

getSmartTagTypes

setSmartTagTypes

getWebPublishing

setWebPublishing

getFileRecoveryPr

getWebPublishObjects

setWebPublishObjects

getExtLst

setExtLst

getConformance

setConformance

getParent

setParent

afterUnmarshal