SheetView (docx4j-openxml-objects-sml 8.3.15 API)

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

All Implemented Interfaces:: Child

public class SheetView
extends java.lang.Object
implements Child

Java class for CT_SheetView complex type.

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

 <complexType name="CT_SheetView">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="pane" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_Pane" minOccurs="0"/>
         <element name="selection" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_Selection" maxOccurs="4" minOccurs="0"/>
         <element name="pivotSelection" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_PivotSelection" maxOccurs="4" minOccurs="0"/>
         <element name="extLst" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_ExtensionList" minOccurs="0"/>
       </sequence>
       <attribute name="windowProtection" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="showFormulas" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="showGridLines" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="showRowColHeaders" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="showZeros" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="rightToLeft" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="tabSelected" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="showRuler" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="showOutlineSymbols" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="defaultGridColor" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="showWhiteSpace" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="view" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}ST_SheetViewType" default="normal" />
       <attribute name="topLeftCell" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}ST_CellRef" />
       <attribute name="colorId" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" default="64" />
       <attribute name="zoomScale" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" default="100" />
       <attribute name="zoomScaleNormal" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" default="0" />
       <attribute name="zoomScaleSheetLayoutView" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" default="0" />
       <attribute name="zoomScalePageLayoutView" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" default="0" />
       <attribute name="workbookViewId" use="required" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.Long`	`colorId`
`protected java.lang.Boolean`	`defaultGridColor`
`protected CTExtensionList`	`extLst`
`protected CTPane`	`pane`
`protected java.util.List<CTPivotSelection>`	`pivotSelection`
`protected java.lang.Boolean`	`rightToLeft`
`protected java.util.List<CTSelection>`	`selection`
`protected java.lang.Boolean`	`showFormulas`
`protected java.lang.Boolean`	`showGridLines`
`protected java.lang.Boolean`	`showOutlineSymbols`
`protected java.lang.Boolean`	`showRowColHeaders`
`protected java.lang.Boolean`	`showRuler`
`protected java.lang.Boolean`	`showWhiteSpace`
`protected java.lang.Boolean`	`showZeros`
`protected java.lang.Boolean`	`tabSelected`
`protected java.lang.String`	`topLeftCell`
`protected STSheetViewType`	`view`
`protected java.lang.Boolean`	`windowProtection`
`protected long`	`workbookViewId`
`protected java.lang.Long`	`zoomScale`
`protected java.lang.Long`	`zoomScaleNormal`
`protected java.lang.Long`	`zoomScalePageLayoutView`
`protected java.lang.Long`	`zoomScaleSheetLayoutView`

Constructor Summary

Constructors
Constructor and Description

SheetView()

Constructors
Constructor and Description
`SheetView()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterUnmarshal(javax.xml.bind.Unmarshaller unmarshaller, java.lang.Object parent)` This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
`long`	`getColorId()` Gets the value of the colorId property.
`CTExtensionList`	`getExtLst()` Gets the value of the extLst property.
`CTPane`	`getPane()` Gets the value of the pane property.
`java.lang.Object`	`getParent()` Gets the parent object in the object tree representing the unmarshalled xml document.
`java.util.List<CTPivotSelection>`	`getPivotSelection()` Gets the value of the pivotSelection property.
`java.util.List<CTSelection>`	`getSelection()` Gets the value of the selection property.
`java.lang.String`	`getTopLeftCell()` Gets the value of the topLeftCell property.
`STSheetViewType`	`getView()` Gets the value of the view property.
`long`	`getWorkbookViewId()` Gets the value of the workbookViewId property.
`long`	`getZoomScale()` Gets the value of the zoomScale property.
`long`	`getZoomScaleNormal()` Gets the value of the zoomScaleNormal property.
`long`	`getZoomScalePageLayoutView()` Gets the value of the zoomScalePageLayoutView property.
`long`	`getZoomScaleSheetLayoutView()` Gets the value of the zoomScaleSheetLayoutView property.
`boolean`	`isDefaultGridColor()` Gets the value of the defaultGridColor property.
`boolean`	`isRightToLeft()` Gets the value of the rightToLeft property.
`boolean`	`isShowFormulas()` Gets the value of the showFormulas property.
`boolean`	`isShowGridLines()` Gets the value of the showGridLines property.
`boolean`	`isShowOutlineSymbols()` Gets the value of the showOutlineSymbols property.
`boolean`	`isShowRowColHeaders()` Gets the value of the showRowColHeaders property.
`boolean`	`isShowRuler()` Gets the value of the showRuler property.
`boolean`	`isShowWhiteSpace()` Gets the value of the showWhiteSpace property.
`boolean`	`isShowZeros()` Gets the value of the showZeros property.
`boolean`	`isTabSelected()` Gets the value of the tabSelected property.
`boolean`	`isWindowProtection()` Gets the value of the windowProtection property.
`void`	`setColorId(java.lang.Long value)` Sets the value of the colorId property.
`void`	`setDefaultGridColor(java.lang.Boolean value)` Sets the value of the defaultGridColor property.
`void`	`setExtLst(CTExtensionList value)` Sets the value of the extLst property.
`void`	`setPane(CTPane value)` Sets the value of the pane property.
`void`	`setParent(java.lang.Object parent)`
`void`	`setRightToLeft(java.lang.Boolean value)` Sets the value of the rightToLeft property.
`void`	`setShowFormulas(java.lang.Boolean value)` Sets the value of the showFormulas property.
`void`	`setShowGridLines(java.lang.Boolean value)` Sets the value of the showGridLines property.
`void`	`setShowOutlineSymbols(java.lang.Boolean value)` Sets the value of the showOutlineSymbols property.
`void`	`setShowRowColHeaders(java.lang.Boolean value)` Sets the value of the showRowColHeaders property.
`void`	`setShowRuler(java.lang.Boolean value)` Sets the value of the showRuler property.
`void`	`setShowWhiteSpace(java.lang.Boolean value)` Sets the value of the showWhiteSpace property.
`void`	`setShowZeros(java.lang.Boolean value)` Sets the value of the showZeros property.
`void`	`setTabSelected(java.lang.Boolean value)` Sets the value of the tabSelected property.
`void`	`setTopLeftCell(java.lang.String value)` Sets the value of the topLeftCell property.
`void`	`setView(STSheetViewType value)` Sets the value of the view property.
`void`	`setWindowProtection(java.lang.Boolean value)` Sets the value of the windowProtection property.
`void`	`setWorkbookViewId(long value)` Sets the value of the workbookViewId property.
`void`	`setZoomScale(java.lang.Long value)` Sets the value of the zoomScale property.
`void`	`setZoomScaleNormal(java.lang.Long value)` Sets the value of the zoomScaleNormal property.
`void`	`setZoomScalePageLayoutView(java.lang.Long value)` Sets the value of the zoomScalePageLayoutView property.
`void`	`setZoomScaleSheetLayoutView(java.lang.Long value)` Sets the value of the zoomScaleSheetLayoutView property.

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

- Field Detail
  - pane
```
protected CTPane pane
```
  - selection
```
protected java.util.List<CTSelection> selection
```
  - pivotSelection
```
protected java.util.List<CTPivotSelection> pivotSelection
```
  - extLst
```
protected CTExtensionList extLst
```
  - windowProtection
```
protected java.lang.Boolean windowProtection
```
  - showFormulas
```
protected java.lang.Boolean showFormulas
```
  - showGridLines
```
protected java.lang.Boolean showGridLines
```
  - showRowColHeaders
```
protected java.lang.Boolean showRowColHeaders
```
  - showZeros
```
protected java.lang.Boolean showZeros
```
  - rightToLeft
```
protected java.lang.Boolean rightToLeft
```
  - tabSelected
```
protected java.lang.Boolean tabSelected
```
  - showRuler
```
protected java.lang.Boolean showRuler
```
  - showOutlineSymbols
```
protected java.lang.Boolean showOutlineSymbols
```
  - defaultGridColor
```
protected java.lang.Boolean defaultGridColor
```
  - showWhiteSpace
```
protected java.lang.Boolean showWhiteSpace
```
  - view
```
protected STSheetViewType view
```
  - topLeftCell
```
protected java.lang.String topLeftCell
```
  - colorId
```
protected java.lang.Long colorId
```
  - zoomScale
```
protected java.lang.Long zoomScale
```
  - zoomScaleNormal
```
protected java.lang.Long zoomScaleNormal
```
  - zoomScaleSheetLayoutView
```
protected java.lang.Long zoomScaleSheetLayoutView
```
  - zoomScalePageLayoutView
```
protected java.lang.Long zoomScalePageLayoutView
```
  - workbookViewId
```
protected long workbookViewId
```
- Constructor Detail
  - SheetView
```
public SheetView()
```
- Method Detail
  - getPane
```
public CTPane getPane()
```
    Gets the value of the pane property.
    
    Returns:
    
    possible object is CTPane
  - setPane
```
public void setPane(CTPane value)
```
    Sets the value of the pane property.
    
    Parameters:
    
    value - allowed object is CTPane
  - getSelection
```
public java.util.List<CTSelection> getSelection()
```
    Gets the value of the selection 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 selection property.
    For example, to add a new item, do as follows:
```
    getSelection().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list CTSelection
  - getPivotSelection
```
public java.util.List<CTPivotSelection> getPivotSelection()
```
    Gets the value of the pivotSelection 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 pivotSelection property.
    For example, to add a new item, do as follows:
```
    getPivotSelection().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list CTPivotSelection
  - 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
  - isWindowProtection
```
public boolean isWindowProtection()
```
    Gets the value of the windowProtection property.
    
    Returns:
    
    possible object is Boolean
  - setWindowProtection
```
public void setWindowProtection(java.lang.Boolean value)
```
    Sets the value of the windowProtection property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isShowFormulas
```
public boolean isShowFormulas()
```
    Gets the value of the showFormulas property.
    
    Returns:
    
    possible object is Boolean
  - setShowFormulas
```
public void setShowFormulas(java.lang.Boolean value)
```
    Sets the value of the showFormulas property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isShowGridLines
```
public boolean isShowGridLines()
```
    Gets the value of the showGridLines property.
    
    Returns:
    
    possible object is Boolean
  - setShowGridLines
```
public void setShowGridLines(java.lang.Boolean value)
```
    Sets the value of the showGridLines property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isShowRowColHeaders
```
public boolean isShowRowColHeaders()
```
    Gets the value of the showRowColHeaders property.
    
    Returns:
    
    possible object is Boolean
  - setShowRowColHeaders
```
public void setShowRowColHeaders(java.lang.Boolean value)
```
    Sets the value of the showRowColHeaders property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isShowZeros
```
public boolean isShowZeros()
```
    Gets the value of the showZeros property.
    
    Returns:
    
    possible object is Boolean
  - setShowZeros
```
public void setShowZeros(java.lang.Boolean value)
```
    Sets the value of the showZeros property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isRightToLeft
```
public boolean isRightToLeft()
```
    Gets the value of the rightToLeft property.
    
    Returns:
    
    possible object is Boolean
  - setRightToLeft
```
public void setRightToLeft(java.lang.Boolean value)
```
    Sets the value of the rightToLeft property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isTabSelected
```
public boolean isTabSelected()
```
    Gets the value of the tabSelected property.
    
    Returns:
    
    possible object is Boolean
  - setTabSelected
```
public void setTabSelected(java.lang.Boolean value)
```
    Sets the value of the tabSelected property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isShowRuler
```
public boolean isShowRuler()
```
    Gets the value of the showRuler property.
    
    Returns:
    
    possible object is Boolean
  - setShowRuler
```
public void setShowRuler(java.lang.Boolean value)
```
    Sets the value of the showRuler property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isShowOutlineSymbols
```
public boolean isShowOutlineSymbols()
```
    Gets the value of the showOutlineSymbols property.
    
    Returns:
    
    possible object is Boolean
  - setShowOutlineSymbols
```
public void setShowOutlineSymbols(java.lang.Boolean value)
```
    Sets the value of the showOutlineSymbols property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isDefaultGridColor
```
public boolean isDefaultGridColor()
```
    Gets the value of the defaultGridColor property.
    
    Returns:
    
    possible object is Boolean
  - setDefaultGridColor
```
public void setDefaultGridColor(java.lang.Boolean value)
```
    Sets the value of the defaultGridColor property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isShowWhiteSpace
```
public boolean isShowWhiteSpace()
```
    Gets the value of the showWhiteSpace property.
    
    Returns:
    
    possible object is Boolean
  - setShowWhiteSpace
```
public void setShowWhiteSpace(java.lang.Boolean value)
```
    Sets the value of the showWhiteSpace property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getView
```
public STSheetViewType getView()
```
    Gets the value of the view property.
    
    Returns:
    
    possible object is STSheetViewType
  - setView
```
public void setView(STSheetViewType value)
```
    Sets the value of the view property.
    
    Parameters:
    
    value - allowed object is STSheetViewType
  - getTopLeftCell
```
public java.lang.String getTopLeftCell()
```
    Gets the value of the topLeftCell property.
    
    Returns:
    
    possible object is String
  - setTopLeftCell
```
public void setTopLeftCell(java.lang.String value)
```
    Sets the value of the topLeftCell property.
    
    Parameters:
    
    value - allowed object is String
  - getColorId
```
public long getColorId()
```
    Gets the value of the colorId property.
    
    Returns:
    
    possible object is Long
  - setColorId
```
public void setColorId(java.lang.Long value)
```
    Sets the value of the colorId property.
    
    Parameters:
    
    value - allowed object is Long
  - getZoomScale
```
public long getZoomScale()
```
    Gets the value of the zoomScale property.
    
    Returns:
    
    possible object is Long
  - setZoomScale
```
public void setZoomScale(java.lang.Long value)
```
    Sets the value of the zoomScale property.
    
    Parameters:
    
    value - allowed object is Long
  - getZoomScaleNormal
```
public long getZoomScaleNormal()
```
    Gets the value of the zoomScaleNormal property.
    
    Returns:
    
    possible object is Long
  - setZoomScaleNormal
```
public void setZoomScaleNormal(java.lang.Long value)
```
    Sets the value of the zoomScaleNormal property.
    
    Parameters:
    
    value - allowed object is Long
  - getZoomScaleSheetLayoutView
```
public long getZoomScaleSheetLayoutView()
```
    Gets the value of the zoomScaleSheetLayoutView property.
    
    Returns:
    
    possible object is Long
  - setZoomScaleSheetLayoutView
```
public void setZoomScaleSheetLayoutView(java.lang.Long value)
```
    Sets the value of the zoomScaleSheetLayoutView property.
    
    Parameters:
    
    value - allowed object is Long
  - getZoomScalePageLayoutView
```
public long getZoomScalePageLayoutView()
```
    Gets the value of the zoomScalePageLayoutView property.
    
    Returns:
    
    possible object is Long
  - setZoomScalePageLayoutView
```
public void setZoomScalePageLayoutView(java.lang.Long value)
```
    Sets the value of the zoomScalePageLayoutView property.
    
    Parameters:
    
    value - allowed object is Long
  - getWorkbookViewId
```
public long getWorkbookViewId()
```
    Gets the value of the workbookViewId property.
  - setWorkbookViewId
```
public void setWorkbookViewId(long value)
```
    Sets the value of the workbookViewId property.
  - 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(javax.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.

Class SheetView

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

pane

selection

pivotSelection

extLst

windowProtection

showFormulas

showGridLines

showRowColHeaders

showZeros

rightToLeft

tabSelected

showRuler

showOutlineSymbols

defaultGridColor

showWhiteSpace

view

topLeftCell

colorId

zoomScale

zoomScaleNormal

zoomScaleSheetLayoutView

zoomScalePageLayoutView

workbookViewId

Constructor Detail

SheetView

Method Detail

getPane

setPane

getSelection

getPivotSelection

getExtLst

setExtLst

isWindowProtection

setWindowProtection

isShowFormulas

setShowFormulas

isShowGridLines

setShowGridLines

isShowRowColHeaders

setShowRowColHeaders

isShowZeros

setShowZeros

isRightToLeft

setRightToLeft

isTabSelected

setTabSelected

isShowRuler

setShowRuler

isShowOutlineSymbols

setShowOutlineSymbols

isDefaultGridColor

setDefaultGridColor

isShowWhiteSpace

setShowWhiteSpace

getView

setView

getTopLeftCell

setTopLeftCell

getColorId

setColorId

getZoomScale

setZoomScale

getZoomScaleNormal

setZoomScaleNormal

getZoomScaleSheetLayoutView

setZoomScaleSheetLayoutView

getZoomScalePageLayoutView

setZoomScalePageLayoutView

getWorkbookViewId

setWorkbookViewId

getParent

setParent

afterUnmarshal