com.aspose.slides

Class SummaryZoomSectionCollection

java.lang.Object

com.aspose.slides.DomObject<SummaryZoomFrame>

com.aspose.slides.SummaryZoomSectionCollection

All Implemented Interfaces:

com.aspose.ms.System.Collections.Generic.IGenericEnumerable<ISummaryZoomSection>, com.aspose.ms.System.Collections.ICollection<ISummaryZoomSection>, com.aspose.ms.System.Collections.IEnumerable<ISummaryZoomSection>, IGenericCollection<ISummaryZoomSection>, ISummaryZoomSectionCollection, java.lang.Iterable<ISummaryZoomSection>

public final class SummaryZoomSectionCollection
extends DomObject<SummaryZoomFrame>
implements ISummaryZoomSectionCollection

Represents a collection of Summary Zoom Section objects.

Method Summary

Modifier and Type	Method and Description
ISummaryZoomSection	addSummaryZoomSection(ISection section) Creates new Summary Zoom Section object and add it to the collection
void	clear() Removes all SummaryZoomSection objects from the collection.
void	copyTo(com.aspose.ms.System.Array array, int index) Copies the entire collection to the specified array.
ISummaryZoomSection	get_Item(int index) Gets the element at the specified index.
ISummaryZoomSection	getSummarySection(ISection section) Returns Summary Zoom Section element for the given section.
java.lang.Object	getSyncRoot() Returns a synchronization root.
int	indexOf(ISummaryZoomSection summaryZoomSection) Returns an index of the specified SummaryZoomSection object.
boolean	isSynchronized() Returns a value indicating whether access to the collection is synchronized (thread-safe).
com.aspose.ms.System.Collections.Generic.IGenericEnumerator<ISummaryZoomSection>	iterator() Returns an enumerator that iterates through the collection.
com.aspose.ms.System.Collections.Generic.IGenericEnumerator<ISummaryZoomSection>	iteratorJava() Returns a java iterator for the entire collection.
void	removeSummaryZoomSection(ISection section) Remove Summary Zoom Section object from the collection.
int	size() Gets the number of elements actually contained in the collection.

Methods inherited from class com.aspose.slides.DomObject

getParent_Immediate

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

get_Item

public final ISummaryZoomSection get_Item(int index)

Gets the element at the specified index. Read-only ISummaryZoomSection.

The example demonstrates getting Summary Zoom Section element by index:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
      ISummaryZoomFrame zoomFrame = (ISummaryZoomFrame)pres.getSlides().get_Item(1).getShapes().get_Item(0);
      ISummaryZoomSectionCollection collection = zoomFrame.getSummaryZoomCollection();
      ISummaryZoomSection zoomSection = collection.get_Item(1);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

get_Item in interface ISummaryZoomSectionCollection

addSummaryZoomSection

public final ISummaryZoomSection addSummaryZoomSection(ISection section)

Creates new Summary Zoom Section object and add it to the collection

The example demonstrates getting Summary Zoom Section element by index:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
      ISummaryZoomFrame zoomFrame = (ISummaryZoomFrame)pres.getSlides().get_Item(1).getShapes().get_Item(0);
      ISummaryZoomSectionCollection collection = zoomFrame.getSummaryZoomCollection();
      ISummaryZoomSection newZoomSection = collection.addSummaryZoomSection(pres.getSections().get_Item(3));
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

addSummaryZoomSection in interface ISummaryZoomSectionCollection

Parameters:

section - Section for a new Summary Zoom Section element ISection

If an element for this section already exists in the collection, the existing element is returned.

Returns:

Added ISummaryZoomFrame element

Throws:

com.aspose.ms.System.ArgumentException - Referenced section does not belong to the current presentation or does not contains any slides.

size

public final int size()

Gets the number of elements actually contained in the collection. Read-only int.

Specified by:

size in interface com.aspose.ms.System.Collections.ICollection<ISummaryZoomSection>

indexOf

public final int indexOf(ISummaryZoomSection summaryZoomSection)

Returns an index of the specified SummaryZoomSection object.

The example demonstrates getting Summary Zoom Section element by index:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
      ISummaryZoomFrame zoomFrame = (ISummaryZoomFrame)pres.getSlides().get_Item(1).getShapes().get_Item(0);
      ISummaryZoomSectionCollection collection = zoomFrame.getSummaryZoomCollection();
      ISummaryZoomSection selectedObject = collection.getSummarySection(pres.getSections().get_Item(2));
      int idx = collection.indexOf(selectedObject);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

indexOf in interface ISummaryZoomSectionCollection

Parameters:

summaryZoomSection - SummaryZoomSection object to find ISummaryZoomSection.

Returns:

Index of a SummaryZoomSection object or -1 if SummaryZoomSection object not from this collection.

removeSummaryZoomSection

public final void removeSummaryZoomSection(ISection section)

Remove Summary Zoom Section object from the collection.

The example demonstrates getting Summary Zoom Section element by index:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
      ISummaryZoomFrame zoomFrame = (ISummaryZoomFrame)pres.getSlides().get_Item(1).getShapes().get_Item(0);
      ISummaryZoomSectionCollection collection = zoomFrame.getSummaryZoomCollection();
      collection.removeSummaryZoomSection(pres.getSections().get_Item(1));
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

removeSummaryZoomSection in interface ISummaryZoomSectionCollection

Parameters:

section - Section for which the Summary Zoom Section element is to be removed ISection.

getSummarySection

public final ISummaryZoomSection getSummarySection(ISection section)

Returns Summary Zoom Section element for the given section.

The example demonstrates getting Summary Zoom Section element by index:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
      ISummaryZoomFrame zoomFrame = (ISummaryZoomFrame)pres.getSlides().get_Item(1).getShapes().get_Item(0);
      ISummaryZoomSectionCollection collection = zoomFrame.getSummaryZoomCollection();
      ISummaryZoomSection selectedObject = collection.getSummarySection(pres.getSections().get_Item(2));
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

getSummarySection in interface ISummaryZoomSectionCollection

Parameters:

section - Section to find ISection

Returns:

ISummaryZoomSection or null if collection does not contains element for the section.

clear

public final void clear()

Removes all SummaryZoomSection objects from the collection.

The example demonstrates getting Summary Zoom Section element by index:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
      ISummaryZoomFrame zoomFrame = (ISummaryZoomFrame)pres.getSlides().get_Item(1).getShapes().get_Item(0);
      ISummaryZoomSectionCollection collection = zoomFrame.getSummaryZoomCollection();
      collection.clear();
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

clear in interface ISummaryZoomSectionCollection

copyTo

public final void copyTo(com.aspose.ms.System.Array array,
                         int index)

Copies the entire collection to the specified array.

Specified by:

copyTo in interface com.aspose.ms.System.Collections.ICollection<ISummaryZoomSection>

Parameters:

array - Target array

index - Index in the target array.

isSynchronized

public final boolean isSynchronized()

Returns a value indicating whether access to the collection is synchronized (thread-safe). Read-only boolean.

Specified by:

isSynchronized in interface com.aspose.ms.System.Collections.ICollection<ISummaryZoomSection>

getSyncRoot

public final java.lang.Object getSyncRoot()

Returns a synchronization root. Read-only Object.

Specified by:

getSyncRoot in interface com.aspose.ms.System.Collections.ICollection<ISummaryZoomSection>

iterator

public final com.aspose.ms.System.Collections.Generic.IGenericEnumerator<ISummaryZoomSection> iterator()

Returns an enumerator that iterates through the collection.

Specified by:

iterator in interface com.aspose.ms.System.Collections.Generic.IGenericEnumerable<ISummaryZoomSection>

Specified by:

iterator in interface com.aspose.ms.System.Collections.IEnumerable<ISummaryZoomSection>

Specified by:

iterator in interface java.lang.Iterable<ISummaryZoomSection>

Returns:

A IGenericEnumerator that can be used to iterate through the collection.

iteratorJava

public final com.aspose.ms.System.Collections.Generic.IGenericEnumerator<ISummaryZoomSection> iteratorJava()

Returns a java iterator for the entire collection.

Specified by:

iteratorJava in interface IGenericCollection<ISummaryZoomSection>

Returns:

An Iterator for the entire collection.