CTPivotHierarchy (docx4j 6.0.1 API)

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

All Implemented Interfaces:: Child

public class CTPivotHierarchy
extends Object
implements Child

Java class for CT_PivotHierarchy complex type.

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

 <complexType name="CT_PivotHierarchy">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="mps" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_MemberProperties" minOccurs="0"/>
         <element name="members" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_Members" maxOccurs="unbounded" minOccurs="0"/>
         <element name="extLst" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_ExtensionList" minOccurs="0"/>
       </sequence>
       <attribute name="outline" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="multipleItemSelectionAllowed" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="subtotalTop" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="showInFieldList" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="dragToRow" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="dragToCol" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="dragToPage" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="dragToData" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="dragOff" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="includeNewItemsInFilter" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="caption" type="{http://schemas.openxmlformats.org/officeDocument/2006/sharedTypes}ST_Xstring" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`caption`
`protected Boolean`	`dragOff`
`protected Boolean`	`dragToCol`
`protected Boolean`	`dragToData`
`protected Boolean`	`dragToPage`
`protected Boolean`	`dragToRow`
`protected CTExtensionList`	`extLst`
`protected Boolean`	`includeNewItemsInFilter`
`protected List<CTMembers>`	`members`
`protected CTMemberProperties`	`mps`
`protected Boolean`	`multipleItemSelectionAllowed`
`protected Boolean`	`outline`
`protected Boolean`	`showInFieldList`
`protected Boolean`	`subtotalTop`

Constructor Summary

Constructors
Constructor and Description

CTPivotHierarchy()

Constructors
Constructor and Description
`CTPivotHierarchy()`

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.
`String`	`getCaption()` Gets the value of the caption property.
`CTExtensionList`	`getExtLst()` Gets the value of the extLst property.
`List<CTMembers>`	`getMembers()` Gets the value of the members property.
`CTMemberProperties`	`getMps()` Gets the value of the mps property.
`Object`	`getParent()` Gets the parent object in the object tree representing the unmarshalled xml document.
`boolean`	`isDragOff()` Gets the value of the dragOff property.
`boolean`	`isDragToCol()` Gets the value of the dragToCol property.
`boolean`	`isDragToData()` Gets the value of the dragToData property.
`boolean`	`isDragToPage()` Gets the value of the dragToPage property.
`boolean`	`isDragToRow()` Gets the value of the dragToRow property.
`boolean`	`isIncludeNewItemsInFilter()` Gets the value of the includeNewItemsInFilter property.
`boolean`	`isMultipleItemSelectionAllowed()` Gets the value of the multipleItemSelectionAllowed property.
`boolean`	`isOutline()` Gets the value of the outline property.
`boolean`	`isShowInFieldList()` Gets the value of the showInFieldList property.
`boolean`	`isSubtotalTop()` Gets the value of the subtotalTop property.
`void`	`setCaption(String value)` Sets the value of the caption property.
`void`	`setDragOff(Boolean value)` Sets the value of the dragOff property.
`void`	`setDragToCol(Boolean value)` Sets the value of the dragToCol property.
`void`	`setDragToData(Boolean value)` Sets the value of the dragToData property.
`void`	`setDragToPage(Boolean value)` Sets the value of the dragToPage property.
`void`	`setDragToRow(Boolean value)` Sets the value of the dragToRow property.
`void`	`setExtLst(CTExtensionList value)` Sets the value of the extLst property.
`void`	`setIncludeNewItemsInFilter(Boolean value)` Sets the value of the includeNewItemsInFilter property.
`void`	`setMps(CTMemberProperties value)` Sets the value of the mps property.
`void`	`setMultipleItemSelectionAllowed(Boolean value)` Sets the value of the multipleItemSelectionAllowed property.
`void`	`setOutline(Boolean value)` Sets the value of the outline property.
`void`	`setParent(Object parent)`
`void`	`setShowInFieldList(Boolean value)` Sets the value of the showInFieldList property.
`void`	`setSubtotalTop(Boolean value)` Sets the value of the subtotalTop property.

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

- Field Detail
  - mps
```
protected CTMemberProperties mps
```
  - members
```
protected List<CTMembers> members
```
  - extLst
```
protected CTExtensionList extLst
```
  - outline
```
protected Boolean outline
```
  - multipleItemSelectionAllowed
```
protected Boolean multipleItemSelectionAllowed
```
  - subtotalTop
```
protected Boolean subtotalTop
```
  - showInFieldList
```
protected Boolean showInFieldList
```
  - dragToRow
```
protected Boolean dragToRow
```
  - dragToCol
```
protected Boolean dragToCol
```
  - dragToPage
```
protected Boolean dragToPage
```
  - dragToData
```
protected Boolean dragToData
```
  - dragOff
```
protected Boolean dragOff
```
  - includeNewItemsInFilter
```
protected Boolean includeNewItemsInFilter
```
  - caption
```
protected String caption
```
- Constructor Detail
  - CTPivotHierarchy
```
public CTPivotHierarchy()
```
- Method Detail
  - getMps
```
public CTMemberProperties getMps()
```
    Gets the value of the mps property.
    
    Returns:
    
    possible object is CTMemberProperties
  - setMps
```
public void setMps(CTMemberProperties value)
```
    Sets the value of the mps property.
    
    Parameters:
    
    value - allowed object is CTMemberProperties
  - getMembers
```
public List<CTMembers> getMembers()
```
    Gets the value of the members 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 members property.
    For example, to add a new item, do as follows:
```
    getMembers().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list CTMembers
  - 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
  - isOutline
```
public boolean isOutline()
```
    Gets the value of the outline property.
    
    Returns:
    
    possible object is Boolean
  - setOutline
```
public void setOutline(Boolean value)
```
    Sets the value of the outline property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isMultipleItemSelectionAllowed
```
public boolean isMultipleItemSelectionAllowed()
```
    Gets the value of the multipleItemSelectionAllowed property.
    
    Returns:
    
    possible object is Boolean
  - setMultipleItemSelectionAllowed
```
public void setMultipleItemSelectionAllowed(Boolean value)
```
    Sets the value of the multipleItemSelectionAllowed property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isSubtotalTop
```
public boolean isSubtotalTop()
```
    Gets the value of the subtotalTop property.
    
    Returns:
    
    possible object is Boolean
  - setSubtotalTop
```
public void setSubtotalTop(Boolean value)
```
    Sets the value of the subtotalTop property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isShowInFieldList
```
public boolean isShowInFieldList()
```
    Gets the value of the showInFieldList property.
    
    Returns:
    
    possible object is Boolean
  - setShowInFieldList
```
public void setShowInFieldList(Boolean value)
```
    Sets the value of the showInFieldList property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isDragToRow
```
public boolean isDragToRow()
```
    Gets the value of the dragToRow property.
    
    Returns:
    
    possible object is Boolean
  - setDragToRow
```
public void setDragToRow(Boolean value)
```
    Sets the value of the dragToRow property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isDragToCol
```
public boolean isDragToCol()
```
    Gets the value of the dragToCol property.
    
    Returns:
    
    possible object is Boolean
  - setDragToCol
```
public void setDragToCol(Boolean value)
```
    Sets the value of the dragToCol property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isDragToPage
```
public boolean isDragToPage()
```
    Gets the value of the dragToPage property.
    
    Returns:
    
    possible object is Boolean
  - setDragToPage
```
public void setDragToPage(Boolean value)
```
    Sets the value of the dragToPage property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isDragToData
```
public boolean isDragToData()
```
    Gets the value of the dragToData property.
    
    Returns:
    
    possible object is Boolean
  - setDragToData
```
public void setDragToData(Boolean value)
```
    Sets the value of the dragToData property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isDragOff
```
public boolean isDragOff()
```
    Gets the value of the dragOff property.
    
    Returns:
    
    possible object is Boolean
  - setDragOff
```
public void setDragOff(Boolean value)
```
    Sets the value of the dragOff property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isIncludeNewItemsInFilter
```
public boolean isIncludeNewItemsInFilter()
```
    Gets the value of the includeNewItemsInFilter property.
    
    Returns:
    
    possible object is Boolean
  - setIncludeNewItemsInFilter
```
public void setIncludeNewItemsInFilter(Boolean value)
```
    Sets the value of the includeNewItemsInFilter property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getCaption
```
public String getCaption()
```
    Gets the value of the caption property.
    
    Returns:
    
    possible object is String
  - setCaption
```
public void setCaption(String value)
```
    Sets the value of the caption property.
    
    Parameters:
    
    value - allowed object is String
  - 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 CTPivotHierarchy

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mps

members

extLst

outline

multipleItemSelectionAllowed

subtotalTop

showInFieldList

dragToRow

dragToCol

dragToPage

dragToData

dragOff

includeNewItemsInFilter

caption

Constructor Detail

CTPivotHierarchy

Method Detail

getMps

setMps

getMembers

getExtLst

setExtLst

isOutline

setOutline

isMultipleItemSelectionAllowed

setMultipleItemSelectionAllowed

isSubtotalTop

setSubtotalTop

isShowInFieldList

setShowInFieldList

isDragToRow

setDragToRow

isDragToCol

setDragToCol

isDragToPage

setDragToPage

isDragToData

setDragToData

isDragOff

setDragOff

isIncludeNewItemsInFilter

setIncludeNewItemsInFilter

getCaption

setCaption

getParent

setParent

afterUnmarshal