com.aspose.cells

Class PivotFieldCollection

java.lang.Object

com.aspose.cells.PivotFieldCollection

All Implemented Interfaces:

java.lang.Iterable

public class PivotFieldCollection
extends java.lang.Object
implements java.lang.Iterable

Represents a collection of all the PivotField objects in the PivotTable's specific PivotFields type.

Method Summary

Methods

Modifier and Type	Method and Description
int	add(PivotField pivotField) Adds a PivotField Object to the specific type PivotFields.
int	addByBaseIndex(int baseFieldIndex) Adds a PivotField Object to the specific type PivotFields.
void	clear() clear all fields of PivotFieldCollection
PivotField	get(int index) Gets the PivotField Object at the specific index.
PivotField	get(java.lang.String name) Gets the PivotField Object of the specific name.
int	getCount() Gets the count of the pivotFields.
int	getType() Gets the PivotFields type.
java.util.Iterator	iterator() Gets an enumerator over the elements in this collection in proper sequence.
void	move(int currPos, int destPos) Moves the PivotField from current position to destination position

Methods inherited from class java.lang.Object

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

Method Detail

getType

public int getType()

Gets the PivotFields type.

See PivotFieldType.

getCount

public int getCount()

Gets the count of the pivotFields.

iterator

public java.util.Iterator iterator()

Gets an enumerator over the elements in this collection in proper sequence.

Specified by:

iterator in interface java.lang.Iterable

Returns:

enumerator

get

public PivotField get(int index)

Gets the PivotField Object at the specific index.

get

public PivotField get(java.lang.String name)

Gets the PivotField Object of the specific name.

addByBaseIndex

public int addByBaseIndex(int baseFieldIndex)

Adds a PivotField Object to the specific type PivotFields.

Parameters:

baseFieldIndex - field index in the base PivotFields.

Returns:

the index of the PivotField Object in this PivotFields.

add

public int add(PivotField pivotField)

Adds a PivotField Object to the specific type PivotFields.

Parameters:

pivotField - a PivotField Object.

Returns:

the index of the PivotField Object in this PivotFields.

clear

public void clear()

clear all fields of PivotFieldCollection

move

public void move(int currPos,
        int destPos)

Moves the PivotField from current position to destination position

Parameters:

currPos - Current position of PivotField based on zero

destPos - Destination position of PivotField based on zero