PivotItemCollection

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

public class PivotItemCollection extends CollectionBase

Represents all the PivotItem objects in the PivotField.

Methods

Method	Description
add(Object o)	Adds an item to the CollectionBase instance.
changeitemsOrder(int sourceIndex, int destIndex)	Directly changes the orders of the two items.
clear()	Removes all objects from the CollectionBase instance.
contains(Object o)	Return whether instance contains this object
equals(Object arg0)
get(int index)	Gets the PivotItem Object at the specific index.
get(String itemValue)	Gets the PivotItem by the specific name.
getClass()
getCount()	Gets the number of elements contained in the CollectionBase instance.
hashCode()
hideAllDetail(boolean isHiddenDetail)	Sets whether to hide all detail of all PivotItems in a pivot field.
indexOf(Object o)	Determines the index of a specific item in the CollectionBase instance.
iterator()	Returns an enumerator that iterates through the CollectionBase instance.
notify()
notifyAll()
removeAt(int index)	Removes the item at the specified index.
swapItem(int index1, int index2)	Directly swap two items.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

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.

changeitemsOrder(int sourceIndex, int destIndex)

public void changeitemsOrder(int sourceIndex, int destIndex)

Directly changes the orders of the two items.

Remarks

NOTE: This method is now obsolete. Instead, please use PivotItemCollection.SwapItem() method. This method will be removed 12 months later since July 2024. Aspose apologizes for any inconvenience you may have experienced.

Parameters:

Parameter	Type	Description
sourceIndex	int	The current index
destIndex	int	The dest index

clear()

public void clear()

Removes all objects from the CollectionBase instance.

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 PivotItem get(int index)

Gets the PivotItem Object at the specific index.

Parameters:

Parameter	Type	Description
index	int

Returns: PivotItem

get(String itemValue)

public PivotItem get(String itemValue)

Gets the PivotItem by the specific name.

Parameters:

Parameter	Type	Description
itemValue	java.lang.String

Returns: PivotItem

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.

hashCode()

public native int hashCode()

Returns: int

hideAllDetail(boolean isHiddenDetail)

public void hideAllDetail(boolean isHiddenDetail)

Sets whether to hide all detail of all PivotItems in a pivot field. That is collapse/expand this field.

Parameters:

Parameter	Type	Description
isHiddenDetail	boolean	Whether hide the detail of the pivot field.

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.

iterator()

public Iterator iterator()

Returns an enumerator that iterates through the CollectionBase instance.

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

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

removeAt(int index)

public void removeAt(int index)

Removes the item at the specified index.

Parameters:

Parameter	Type	Description
index	int	The zero-based index of the item to remove.

swapItem(int index1, int index2)

public void swapItem(int index1, int index2)

Directly swap two items.

Parameters:

Parameter	Type	Description
index1	int
index2	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