PivotFieldCollection

Inheritance: java.lang.Object, com.aspose.cells.CollectionBase

public class PivotFieldCollection extends CollectionBase

Represents a collection of all the PivotField objects in the different regions of the pivot table.

Methods

Method	Description
add(PivotField pivotField)	Adds a PivotField Object to the specific type PivotFields.
add(Object o)	Adds an item to the CollectionBase instance.
addByBaseIndex(int baseFieldIndex)	Adds a PivotField Object to the specific type PivotFields.
clear()	clear all fields of PivotFieldCollection
contains(Object o)	Return whether instance contains this object
equals(Object arg0)
get(int index)	Gets the PivotField Object at the specific index.
get(String name)	Gets the PivotField Object of the specific name.
getClass()
getCount()	Gets the number of elements contained in the CollectionBase instance.
getType()	Gets the PivotFields type.
hashCode()
indexOf(Object o)	Determines the index of a specific item in the CollectionBase instance.
insert(int index, PivotField pivotField)	Insert a pivot field at specific index.
iterator()	Returns an enumerator that iterates through the CollectionBase instance.
move(int currPos, int destPos)	Moves the PivotField from current position to destination position
notify()
notifyAll()
remove(PivotField pivotField)	Removes field from the current region.
removeAt(int index)	Removes field by the index.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

add(PivotField pivotField)

public int add(PivotField pivotField)

Adds a PivotField Object to the specific type PivotFields.

Parameters:

Parameter	Type	Description
pivotField	PivotField	a PivotField Object.

Returns: int - the index of the PivotField Object in this PivotFields.

add(Object o)

public int add(Object o)

Adds an item to the CollectionBase instance.

Parameters:

Parameter	Type	Description
o	java.lang.Object	The Object to add to the CollectionBase instance.

Returns: int - The position into which the new element was inserted.

addByBaseIndex(int baseFieldIndex)

public int addByBaseIndex(int baseFieldIndex)

Adds a PivotField Object to the specific type PivotFields.

Parameters:

Parameter	Type	Description
baseFieldIndex	int	field index in the base PivotFields.

Returns: int - the index of the PivotField Object in this PivotFields.

clear()

public void clear()

clear all fields of PivotFieldCollection

contains(Object o)

public boolean contains(Object o)

Return whether instance contains this object

Parameters:

Parameter	Type	Description
o	java.lang.Object	test object

Returns: boolean - Whether instance contains this object

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

get(int index)

public PivotField get(int index)

Gets the PivotField Object at the specific index.

Parameters:

Parameter	Type	Description
index	int

Returns: PivotField

get(String name)

public PivotField get(String name)

Gets the PivotField Object of the specific name.

Parameters:

Parameter	Type	Description
name	java.lang.String

Returns: PivotField

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getCount()

public int getCount()

Gets the number of elements contained in the CollectionBase instance.

Returns: int - The number of elements contained in the CollectionBase instance.

getType()

public int getType()

Gets the PivotFields type.

See PivotFieldType.

Returns: int

hashCode()

public native int hashCode()

Returns: int

indexOf(Object o)

public int indexOf(Object o)

Determines the index of a specific item in the CollectionBase instance.

Parameters:

Parameter	Type	Description
o	java.lang.Object	Determines the index of a specific item in the CollectionBase instance.

Returns: int - The index of value if found in the list; otherwise, -1.

insert(int index, PivotField pivotField)

public void insert(int index, PivotField pivotField)

Insert a pivot field at specific index.

Parameters:

Parameter	Type	Description
index	int	The index.
pivotField	PivotField	The field.

iterator()

public Iterator iterator()

Returns an enumerator that iterates through the CollectionBase instance.

Returns: java.util.Iterator - An iterator for the CollectionBase instance.

move(int currPos, int destPos)

public void move(int currPos, int destPos)

Moves the PivotField from current position to destination position

Parameters:

Parameter	Type	Description
currPos	int	Current position of PivotField based on zero
destPos	int	Destination position of PivotField based on zero

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

remove(PivotField pivotField)

public void remove(PivotField pivotField)

Removes field from the current region.

Parameters:

Parameter	Type	Description
pivotField	PivotField

removeAt(int index)

public void removeAt(int index)

Removes field by the index. Only for filter,row,column,data region.

Parameters:

Parameter	Type	Description
index	int

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int