CTPivotAreaReference (docx4j-openxml-objects-sml 8.3.1 API)

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

All Implemented Interfaces:: Child

public class CTPivotAreaReference
extends Object
implements Child

Java class for CT_PivotAreaReference complex type.

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

 <complexType name="CT_PivotAreaReference">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="x" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_Index" maxOccurs="unbounded" minOccurs="0"/>
         <element name="extLst" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_ExtensionList" minOccurs="0"/>
       </sequence>
       <attribute name="field" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" />
       <attribute name="count" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" />
       <attribute name="selected" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="byPosition" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="relative" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="defaultSubtotal" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="sumSubtotal" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="countASubtotal" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="avgSubtotal" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="maxSubtotal" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="minSubtotal" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="productSubtotal" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="countSubtotal" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="stdDevSubtotal" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="stdDevPSubtotal" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="varSubtotal" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="varPSubtotal" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`avgSubtotal`
`protected Boolean`	`byPosition`
`protected Long`	`count`
`protected Boolean`	`countASubtotal`
`protected Boolean`	`countSubtotal`
`protected Boolean`	`defaultSubtotal`
`protected CTExtensionList`	`extLst`
`protected Long`	`field`
`protected Boolean`	`maxSubtotal`
`protected Boolean`	`minSubtotal`
`protected Boolean`	`productSubtotal`
`protected Boolean`	`relative`
`protected Boolean`	`selected`
`protected Boolean`	`stdDevPSubtotal`
`protected Boolean`	`stdDevSubtotal`
`protected Boolean`	`sumSubtotal`
`protected Boolean`	`varPSubtotal`
`protected Boolean`	`varSubtotal`
`protected List<CTIndex>`	`x`

Constructor Summary

Constructors
Constructor and Description

CTPivotAreaReference()

Constructors
Constructor and Description
`CTPivotAreaReference()`

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.
`Long`	`getCount()` Gets the value of the count property.
`CTExtensionList`	`getExtLst()` Gets the value of the extLst property.
`Long`	`getField()` Gets the value of the field property.
`Object`	`getParent()` Gets the parent object in the object tree representing the unmarshalled xml document.
`List<CTIndex>`	`getX()` Gets the value of the x property.
`boolean`	`isAvgSubtotal()` Gets the value of the avgSubtotal property.
`boolean`	`isByPosition()` Gets the value of the byPosition property.
`boolean`	`isCountASubtotal()` Gets the value of the countASubtotal property.
`boolean`	`isCountSubtotal()` Gets the value of the countSubtotal property.
`boolean`	`isDefaultSubtotal()` Gets the value of the defaultSubtotal property.
`boolean`	`isMaxSubtotal()` Gets the value of the maxSubtotal property.
`boolean`	`isMinSubtotal()` Gets the value of the minSubtotal property.
`boolean`	`isProductSubtotal()` Gets the value of the productSubtotal property.
`boolean`	`isRelative()` Gets the value of the relative property.
`boolean`	`isSelected()` Gets the value of the selected property.
`boolean`	`isStdDevPSubtotal()` Gets the value of the stdDevPSubtotal property.
`boolean`	`isStdDevSubtotal()` Gets the value of the stdDevSubtotal property.
`boolean`	`isSumSubtotal()` Gets the value of the sumSubtotal property.
`boolean`	`isVarPSubtotal()` Gets the value of the varPSubtotal property.
`boolean`	`isVarSubtotal()` Gets the value of the varSubtotal property.
`void`	`setAvgSubtotal(Boolean value)` Sets the value of the avgSubtotal property.
`void`	`setByPosition(Boolean value)` Sets the value of the byPosition property.
`void`	`setCount(Long value)` Sets the value of the count property.
`void`	`setCountASubtotal(Boolean value)` Sets the value of the countASubtotal property.
`void`	`setCountSubtotal(Boolean value)` Sets the value of the countSubtotal property.
`void`	`setDefaultSubtotal(Boolean value)` Sets the value of the defaultSubtotal property.
`void`	`setExtLst(CTExtensionList value)` Sets the value of the extLst property.
`void`	`setField(Long value)` Sets the value of the field property.
`void`	`setMaxSubtotal(Boolean value)` Sets the value of the maxSubtotal property.
`void`	`setMinSubtotal(Boolean value)` Sets the value of the minSubtotal property.
`void`	`setParent(Object parent)`
`void`	`setProductSubtotal(Boolean value)` Sets the value of the productSubtotal property.
`void`	`setRelative(Boolean value)` Sets the value of the relative property.
`void`	`setSelected(Boolean value)` Sets the value of the selected property.
`void`	`setStdDevPSubtotal(Boolean value)` Sets the value of the stdDevPSubtotal property.
`void`	`setStdDevSubtotal(Boolean value)` Sets the value of the stdDevSubtotal property.
`void`	`setSumSubtotal(Boolean value)` Sets the value of the sumSubtotal property.
`void`	`setVarPSubtotal(Boolean value)` Sets the value of the varPSubtotal property.
`void`	`setVarSubtotal(Boolean value)` Sets the value of the varSubtotal property.

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

- Field Detail
  - x
```
protected List<CTIndex> x
```
  - extLst
```
protected CTExtensionList extLst
```
  - field
```
protected Long field
```
  - count
```
protected Long count
```
  - selected
```
protected Boolean selected
```
  - byPosition
```
protected Boolean byPosition
```
  - relative
```
protected Boolean relative
```
  - defaultSubtotal
```
protected Boolean defaultSubtotal
```
  - sumSubtotal
```
protected Boolean sumSubtotal
```
  - countASubtotal
```
protected Boolean countASubtotal
```
  - avgSubtotal
```
protected Boolean avgSubtotal
```
  - maxSubtotal
```
protected Boolean maxSubtotal
```
  - minSubtotal
```
protected Boolean minSubtotal
```
  - productSubtotal
```
protected Boolean productSubtotal
```
  - countSubtotal
```
protected Boolean countSubtotal
```
  - stdDevSubtotal
```
protected Boolean stdDevSubtotal
```
  - stdDevPSubtotal
```
protected Boolean stdDevPSubtotal
```
  - varSubtotal
```
protected Boolean varSubtotal
```
  - varPSubtotal
```
protected Boolean varPSubtotal
```
- Constructor Detail
  - CTPivotAreaReference
```
public CTPivotAreaReference()
```
- Method Detail
  - getX
```
public List<CTIndex> getX()
```
    Gets the value of the x 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 x property.
    For example, to add a new item, do as follows:
```
    getX().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list CTIndex
  - 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
  - getField
```
public Long getField()
```
    Gets the value of the field property.
    
    Returns:
    
    possible object is Long
  - setField
```
public void setField(Long value)
```
    Sets the value of the field property.
    
    Parameters:
    
    value - allowed object is Long
  - getCount
```
public Long getCount()
```
    Gets the value of the count property.
    
    Returns:
    
    possible object is Long
  - setCount
```
public void setCount(Long value)
```
    Sets the value of the count property.
    
    Parameters:
    
    value - allowed object is Long
  - isSelected
```
public boolean isSelected()
```
    Gets the value of the selected property.
    
    Returns:
    
    possible object is Boolean
  - setSelected
```
public void setSelected(Boolean value)
```
    Sets the value of the selected property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isByPosition
```
public boolean isByPosition()
```
    Gets the value of the byPosition property.
    
    Returns:
    
    possible object is Boolean
  - setByPosition
```
public void setByPosition(Boolean value)
```
    Sets the value of the byPosition property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isRelative
```
public boolean isRelative()
```
    Gets the value of the relative property.
    
    Returns:
    
    possible object is Boolean
  - setRelative
```
public void setRelative(Boolean value)
```
    Sets the value of the relative property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isDefaultSubtotal
```
public boolean isDefaultSubtotal()
```
    Gets the value of the defaultSubtotal property.
    
    Returns:
    
    possible object is Boolean
  - setDefaultSubtotal
```
public void setDefaultSubtotal(Boolean value)
```
    Sets the value of the defaultSubtotal property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isSumSubtotal
```
public boolean isSumSubtotal()
```
    Gets the value of the sumSubtotal property.
    
    Returns:
    
    possible object is Boolean
  - setSumSubtotal
```
public void setSumSubtotal(Boolean value)
```
    Sets the value of the sumSubtotal property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isCountASubtotal
```
public boolean isCountASubtotal()
```
    Gets the value of the countASubtotal property.
    
    Returns:
    
    possible object is Boolean
  - setCountASubtotal
```
public void setCountASubtotal(Boolean value)
```
    Sets the value of the countASubtotal property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isAvgSubtotal
```
public boolean isAvgSubtotal()
```
    Gets the value of the avgSubtotal property.
    
    Returns:
    
    possible object is Boolean
  - setAvgSubtotal
```
public void setAvgSubtotal(Boolean value)
```
    Sets the value of the avgSubtotal property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isMaxSubtotal
```
public boolean isMaxSubtotal()
```
    Gets the value of the maxSubtotal property.
    
    Returns:
    
    possible object is Boolean
  - setMaxSubtotal
```
public void setMaxSubtotal(Boolean value)
```
    Sets the value of the maxSubtotal property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isMinSubtotal
```
public boolean isMinSubtotal()
```
    Gets the value of the minSubtotal property.
    
    Returns:
    
    possible object is Boolean
  - setMinSubtotal
```
public void setMinSubtotal(Boolean value)
```
    Sets the value of the minSubtotal property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isProductSubtotal
```
public boolean isProductSubtotal()
```
    Gets the value of the productSubtotal property.
    
    Returns:
    
    possible object is Boolean
  - setProductSubtotal
```
public void setProductSubtotal(Boolean value)
```
    Sets the value of the productSubtotal property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isCountSubtotal
```
public boolean isCountSubtotal()
```
    Gets the value of the countSubtotal property.
    
    Returns:
    
    possible object is Boolean
  - setCountSubtotal
```
public void setCountSubtotal(Boolean value)
```
    Sets the value of the countSubtotal property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isStdDevSubtotal
```
public boolean isStdDevSubtotal()
```
    Gets the value of the stdDevSubtotal property.
    
    Returns:
    
    possible object is Boolean
  - setStdDevSubtotal
```
public void setStdDevSubtotal(Boolean value)
```
    Sets the value of the stdDevSubtotal property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isStdDevPSubtotal
```
public boolean isStdDevPSubtotal()
```
    Gets the value of the stdDevPSubtotal property.
    
    Returns:
    
    possible object is Boolean
  - setStdDevPSubtotal
```
public void setStdDevPSubtotal(Boolean value)
```
    Sets the value of the stdDevPSubtotal property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isVarSubtotal
```
public boolean isVarSubtotal()
```
    Gets the value of the varSubtotal property.
    
    Returns:
    
    possible object is Boolean
  - setVarSubtotal
```
public void setVarSubtotal(Boolean value)
```
    Sets the value of the varSubtotal property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isVarPSubtotal
```
public boolean isVarPSubtotal()
```
    Gets the value of the varPSubtotal property.
    
    Returns:
    
    possible object is Boolean
  - setVarPSubtotal
```
public void setVarPSubtotal(Boolean value)
```
    Sets the value of the varPSubtotal 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(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 CTPivotAreaReference

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

x

extLst

field

count

selected

byPosition

relative

defaultSubtotal

sumSubtotal

countASubtotal

avgSubtotal

maxSubtotal

minSubtotal

productSubtotal

countSubtotal

stdDevSubtotal

stdDevPSubtotal

varSubtotal

varPSubtotal

Constructor Detail

CTPivotAreaReference

Method Detail

getX

getExtLst

setExtLst

getField

setField

getCount

setCount

isSelected

setSelected

isByPosition

setByPosition

isRelative

setRelative

isDefaultSubtotal

setDefaultSubtotal

isSumSubtotal

setSumSubtotal

isCountASubtotal

setCountASubtotal

isAvgSubtotal

setAvgSubtotal

isMaxSubtotal

setMaxSubtotal

isMinSubtotal

setMinSubtotal

isProductSubtotal

setProductSubtotal

isCountSubtotal

setCountSubtotal

isStdDevSubtotal

setStdDevSubtotal

isStdDevPSubtotal

setStdDevPSubtotal

isVarSubtotal

setVarSubtotal

isVarPSubtotal

setVarPSubtotal

getParent

setParent

afterUnmarshal