Package org.xlsx4j.sml

Class CTPivotArea

java.lang.Object
org.xlsx4j.sml.CTPivotArea
All Implemented Interfaces:
Child
public class CTPivotArea
extends java.lang.Object
implements Child

Java class for CT_PivotArea complex type.

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

 <complexType name="CT_PivotArea">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="references" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_PivotAreaReferences" 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}int" />
       <attribute name="type" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}ST_PivotAreaType" default="normal" />
       <attribute name="dataOnly" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="labelOnly" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="grandRow" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="grandCol" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="cacheIndex" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="outline" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="offset" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}ST_Ref" />
       <attribute name="collapsedLevelsAreSubtotals" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="axis" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}ST_Axis" />
       <attribute name="fieldPosition" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" />
     </restriction>
   </complexContent>
 </complexType>

  • Field Summary

    Fields
    Modifier and Type Field Description
    protected STAxis axis  
    protected java.lang.Boolean cacheIndex  
    protected java.lang.Boolean collapsedLevelsAreSubtotals  
    protected java.lang.Boolean dataOnly  
    protected CTExtensionList extLst  
    protected java.lang.Integer field  
    protected java.lang.Long fieldPosition  
    protected java.lang.Boolean grandCol  
    protected java.lang.Boolean grandRow  
    protected java.lang.Boolean labelOnly  
    protected java.lang.String offset  
    protected java.lang.Boolean outline  
    protected CTPivotAreaReferences references  
    protected STPivotAreaType type  

  • Constructor Summary

    Constructors
    Constructor Description
    CTPivotArea()  

  • 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.
    STAxis getAxis()
    Gets the value of the axis property.
    CTExtensionList getExtLst()
    Gets the value of the extLst property.
    java.lang.Integer getField()
    Gets the value of the field property.
    java.lang.Long getFieldPosition()
    Gets the value of the fieldPosition property.
    java.lang.String getOffset()
    Gets the value of the offset property.
    java.lang.Object getParent()
    Gets the parent object in the object tree representing the unmarshalled xml document.
    CTPivotAreaReferences getReferences()
    Gets the value of the references property.
    STPivotAreaType getType()
    Gets the value of the type property.
    boolean isCacheIndex()
    Gets the value of the cacheIndex property.
    boolean isCollapsedLevelsAreSubtotals()
    Gets the value of the collapsedLevelsAreSubtotals property.
    boolean isDataOnly()
    Gets the value of the dataOnly property.
    boolean isGrandCol()
    Gets the value of the grandCol property.
    boolean isGrandRow()
    Gets the value of the grandRow property.
    boolean isLabelOnly()
    Gets the value of the labelOnly property.
    boolean isOutline()
    Gets the value of the outline property.
    void setAxis​(STAxis value)
    Sets the value of the axis property.
    void setCacheIndex​(java.lang.Boolean value)
    Sets the value of the cacheIndex property.
    void setCollapsedLevelsAreSubtotals​(java.lang.Boolean value)
    Sets the value of the collapsedLevelsAreSubtotals property.
    void setDataOnly​(java.lang.Boolean value)
    Sets the value of the dataOnly property.
    void setExtLst​(CTExtensionList value)
    Sets the value of the extLst property.
    void setField​(java.lang.Integer value)
    Sets the value of the field property.
    void setFieldPosition​(java.lang.Long value)
    Sets the value of the fieldPosition property.
    void setGrandCol​(java.lang.Boolean value)
    Sets the value of the grandCol property.
    void setGrandRow​(java.lang.Boolean value)
    Sets the value of the grandRow property.
    void setLabelOnly​(java.lang.Boolean value)
    Sets the value of the labelOnly property.
    void setOffset​(java.lang.String value)
    Sets the value of the offset property.
    void setOutline​(java.lang.Boolean value)
    Sets the value of the outline property.
    void setParent​(java.lang.Object parent)  
    void setReferences​(CTPivotAreaReferences value)
    Sets the value of the references property.
    void setType​(STPivotAreaType value)
    Sets the value of the type property.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • references

      protected CTPivotAreaReferences references

    • extLst

      protected CTExtensionList extLst

    • field

      protected java.lang.Integer field

    • type

      protected STPivotAreaType type

    • dataOnly

      protected java.lang.Boolean dataOnly

    • labelOnly

      protected java.lang.Boolean labelOnly

    • grandRow

      protected java.lang.Boolean grandRow

    • grandCol

      protected java.lang.Boolean grandCol

    • cacheIndex

      protected java.lang.Boolean cacheIndex

    • outline

      protected java.lang.Boolean outline

    • offset

      protected java.lang.String offset

    • collapsedLevelsAreSubtotals

      protected java.lang.Boolean collapsedLevelsAreSubtotals

    • axis

      protected STAxis axis

    • fieldPosition

      protected java.lang.Long fieldPosition

  • Constructor Details

    • CTPivotArea

      public CTPivotArea()

  • Method Details

    • getReferences

      public CTPivotAreaReferences getReferences()
      Gets the value of the references property.
      Returns:
      possible object is CTPivotAreaReferences

    • setReferences

      public void setReferences​(CTPivotAreaReferences value)
      Sets the value of the references property.
      Parameters:
      value - allowed object is CTPivotAreaReferences

    • 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 java.lang.Integer getField()
      Gets the value of the field property.
      Returns:
      possible object is Integer

    • setField

      public void setField​(java.lang.Integer value)
      Sets the value of the field property.
      Parameters:
      value - allowed object is Integer

    • getType

      public STPivotAreaType getType()
      Gets the value of the type property.
      Returns:
      possible object is STPivotAreaType

    • setType

      public void setType​(STPivotAreaType value)
      Sets the value of the type property.
      Parameters:
      value - allowed object is STPivotAreaType

    • isDataOnly

      public boolean isDataOnly()
      Gets the value of the dataOnly property.
      Returns:
      possible object is Boolean

    • setDataOnly

      public void setDataOnly​(java.lang.Boolean value)
      Sets the value of the dataOnly property.
      Parameters:
      value - allowed object is Boolean

    • isLabelOnly

      public boolean isLabelOnly()
      Gets the value of the labelOnly property.
      Returns:
      possible object is Boolean

    • setLabelOnly

      public void setLabelOnly​(java.lang.Boolean value)
      Sets the value of the labelOnly property.
      Parameters:
      value - allowed object is Boolean

    • isGrandRow

      public boolean isGrandRow()
      Gets the value of the grandRow property.
      Returns:
      possible object is Boolean

    • setGrandRow

      public void setGrandRow​(java.lang.Boolean value)
      Sets the value of the grandRow property.
      Parameters:
      value - allowed object is Boolean

    • isGrandCol

      public boolean isGrandCol()
      Gets the value of the grandCol property.
      Returns:
      possible object is Boolean

    • setGrandCol

      public void setGrandCol​(java.lang.Boolean value)
      Sets the value of the grandCol property.
      Parameters:
      value - allowed object is Boolean

    • isCacheIndex

      public boolean isCacheIndex()
      Gets the value of the cacheIndex property.
      Returns:
      possible object is Boolean

    • setCacheIndex

      public void setCacheIndex​(java.lang.Boolean value)
      Sets the value of the cacheIndex property.
      Parameters:
      value - allowed object is Boolean

    • isOutline

      public boolean isOutline()
      Gets the value of the outline property.
      Returns:
      possible object is Boolean

    • setOutline

      public void setOutline​(java.lang.Boolean value)
      Sets the value of the outline property.
      Parameters:
      value - allowed object is Boolean

    • getOffset

      public java.lang.String getOffset()
      Gets the value of the offset property.
      Returns:
      possible object is String

    • setOffset

      public void setOffset​(java.lang.String value)
      Sets the value of the offset property.
      Parameters:
      value - allowed object is String

    • isCollapsedLevelsAreSubtotals

      public boolean isCollapsedLevelsAreSubtotals()
      Gets the value of the collapsedLevelsAreSubtotals property.
      Returns:
      possible object is Boolean

    • setCollapsedLevelsAreSubtotals

      public void setCollapsedLevelsAreSubtotals​(java.lang.Boolean value)
      Sets the value of the collapsedLevelsAreSubtotals property.
      Parameters:
      value - allowed object is Boolean

    • getAxis

      public STAxis getAxis()
      Gets the value of the axis property.
      Returns:
      possible object is STAxis

    • setAxis

      public void setAxis​(STAxis value)
      Sets the value of the axis property.
      Parameters:
      value - allowed object is STAxis

    • getFieldPosition

      public java.lang.Long getFieldPosition()
      Gets the value of the fieldPosition property.
      Returns:
      possible object is Long

    • setFieldPosition

      public void setFieldPosition​(java.lang.Long value)
      Sets the value of the fieldPosition property.
      Parameters:
      value - allowed object is Long

    • 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.