com.aspose.slides
Class SlideExCollection

java.lang.Object
  extended by com.aspose.slides.SlidesEx
      extended by com.aspose.slides.SlideExCollection
All Implemented Interfaces:
com.aspose.ms.System.Collections.ICollection<SlideEx>, com.aspose.ms.System.Collections.IEnumerable<SlideEx>, java.lang.Iterable<SlideEx>

public final class SlideExCollection
extends SlidesEx
implements com.aspose.ms.System.Collections.ICollection<SlideEx>

Represents a collection of a slides.


Method Summary
 int addClone(SlideEx slide)
           Adds a copy of a specified slide to the end of the collection.
 int addClone(SlideEx slide, LayoutSlideEx layout)
           Adds a copy of a specified slide to the end of the collection.
 int addClone(SlideEx slide, MasterSlideEx master)
           Adds a copy of a specified slide to the end of the collection.
 int addEmptySlide(LayoutSlideEx layout)
           Adds a new empty slide to the end of the collection.
 SlideEx[] addFromHtml(java.io.InputStream htmlStream)
           
 SlideEx[] addFromHtml(java.io.InputStream htmlStream, HtmlExternalResolver resolver, java.lang.String uri)
           
 SlideEx[] addFromHtml(java.lang.String htmlText)
           Creates slides from HTML text and adds them to the end of the collection.
 SlideEx[] addFromHtml(java.lang.String htmlText, HtmlExternalResolver resolver, java.lang.String uri)
           Creates slides from HTML text and adds them to the end of the collection.
 SlideEx[] addFromHtml(com.aspose.ms.System.IO.TextReader htmlReader)
           Creates slides from HTML text and adds them to the end of the collection.
 SlideEx[] addFromHtml(com.aspose.ms.System.IO.TextReader htmlReader, HtmlExternalResolver resolver, java.lang.String uri)
           Creates slides from HTML text and adds them to the end of the collection.
 void copyTo(com.aspose.ms.System.Array array, int index)
           Copies all elements from the collection to the specified array.
 SlideEx get_Item(int index)
           Gets the element at the specified index.
 int getCount()
           Gets the number of elements actually contained in the collection.
 java.lang.Object getSyncRoot()
           Returns a synchronization root.
 int indexOf(SlideEx slide)
           Returns an index of the specified slide in the collection.
 void insertClone(int index, SlideEx slide)
           Inserts a copy of a specified slide to specified position of the collection.
 void insertClone(int index, SlideEx slide, LayoutSlideEx layout)
           Inserts a copy of a specified slide to specified position of the collection.
 void insertClone(int index, SlideEx slide, MasterSlideEx master)
           Inserts a copy of a specified slide to specified position of the collection.
 void insertEmptySlide(int index, LayoutSlideEx layout)
           Inserts a copy of a specified slide to specified position of the collection.
 SlideEx[] insertFromHtml(int index, java.io.InputStream htmlStream)
           
 SlideEx[] insertFromHtml(int index, java.io.InputStream htmlStream, HtmlExternalResolver resolver, java.lang.String uri)
           
 SlideEx[] insertFromHtml(int index, java.lang.String htmlText)
           Creates slides from HTML text and inserts them to the collection at the specified position.
 SlideEx[] insertFromHtml(int index, java.lang.String htmlText, HtmlExternalResolver resolver, java.lang.String uri)
           Creates slides from HTML text and inserts them to the collection at the specified position.
 SlideEx[] insertFromHtml(int index, com.aspose.ms.System.IO.TextReader htmlReader)
           Creates slides from HTML text and inserts them to the collection at the specified position.
 SlideEx[] insertFromHtml(int index, com.aspose.ms.System.IO.TextReader htmlReader, HtmlExternalResolver resolver, java.lang.String uri)
           Creates slides from HTML text and inserts them to the collection at the specified position.
 boolean isSynchronized()
           Returns a value indicating whether access to the collection is synchronized (thread-safe).
 com.aspose.ms.System.Collections.IEnumerator<SlideEx> iterator()
           Returns an enumerator for the entire collection.
 void remove(SlideEx value)
           Removes the first occurrence of a specific object from the collection.
 void removeAt(int index)
           Removes the element at the specified index of the collection.
 void reorder(int index, SlideEx... slides)
           Moves slides from the collection to the specified position.
 void reorder(int index, SlideEx slide)
           Moves slide from the collection to the specified position.
 int size()
           
 SlideEx[] toArray()
           Creates and returns an array with all slides in it.
 SlideEx[] toArray(int startIndex, int count)
           Creates and returns an array with all slides from the specified range in it.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

addFromHtml

public SlideEx[] addFromHtml(java.lang.String htmlText,
                             HtmlExternalResolver resolver,
                             java.lang.String uri)

Creates slides from HTML text and adds them to the end of the collection.

Parameters:
htmlText - Html to add.
resolver - A callback object used to fetch external objects. If this parameter is null all external objects will be ignored.
uri - An URI of the specified HTML. Used to resolve relative links.
Returns:
Added slides.

addFromHtml

public SlideEx[] addFromHtml(java.lang.String htmlText)

Creates slides from HTML text and adds them to the end of the collection.

Parameters:
htmlText - Html to add.
Returns:
Added slides

addFromHtml

public SlideEx[] addFromHtml(com.aspose.ms.System.IO.TextReader htmlReader,
                             HtmlExternalResolver resolver,
                             java.lang.String uri)

Creates slides from HTML text and adds them to the end of the collection.

Parameters:
htmlReader - TextReader object which will be used as a source of a HTML file.
resolver - A callback object used to fetch external objects. If this parameter is null all external objects will be ignored.
uri - An URI of the specified HTML. Used to resolve relative links.
Returns:
Added slides.

addFromHtml

public SlideEx[] addFromHtml(com.aspose.ms.System.IO.TextReader htmlReader)

Creates slides from HTML text and adds them to the end of the collection.

Parameters:
htmlReader - TextReader object which will be used as a source of a HTML file.
Returns:
Added slides

addFromHtml

public SlideEx[] addFromHtml(java.io.InputStream htmlStream,
                             HtmlExternalResolver resolver,
                             java.lang.String uri)

addFromHtml

public SlideEx[] addFromHtml(java.io.InputStream htmlStream)

insertFromHtml

public SlideEx[] insertFromHtml(int index,
                                java.lang.String htmlText,
                                HtmlExternalResolver resolver,
                                java.lang.String uri)

Creates slides from HTML text and inserts them to the collection at the specified position.

Parameters:
index - Position to insert.
htmlText - Html to add.
resolver - A callback object used to fetch external objects. If this parameter is null all external objects will be ignored.
uri - An URI of the specified HTML. Used to resolve relative links.
Returns:
Added slides.

insertFromHtml

public SlideEx[] insertFromHtml(int index,
                                java.lang.String htmlText)

Creates slides from HTML text and inserts them to the collection at the specified position.

Parameters:
index - Position to insert.
htmlText - Html to add.
Returns:
Added slides

insertFromHtml

public SlideEx[] insertFromHtml(int index,
                                com.aspose.ms.System.IO.TextReader htmlReader,
                                HtmlExternalResolver resolver,
                                java.lang.String uri)

Creates slides from HTML text and inserts them to the collection at the specified position.

Parameters:
index - Position to insert.
htmlReader - TextReader object which will be used as a source of a HTML file.
resolver - A callback object used to fetch external objects. If this parameter is null all external objects will be ignored.
uri - An URI of the specified HTML. Used to resolve relative links.
Returns:
Added slides.

insertFromHtml

public SlideEx[] insertFromHtml(int index,
                                com.aspose.ms.System.IO.TextReader htmlReader)

Creates slides from HTML text and inserts them to the collection at the specified position.

Parameters:
index - Position to insert.
htmlReader - TextReader object which will be used as a source of a HTML file.
Returns:
Added slides

insertFromHtml

public SlideEx[] insertFromHtml(int index,
                                java.io.InputStream htmlStream,
                                HtmlExternalResolver resolver,
                                java.lang.String uri)

insertFromHtml

public SlideEx[] insertFromHtml(int index,
                                java.io.InputStream htmlStream)

copyTo

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

Copies all elements from the collection to the specified array.

Specified by:
copyTo in interface com.aspose.ms.System.Collections.ICollection<SlideEx>
Parameters:
array - Target array.
index - Starting index in the target array.

isSynchronized

public boolean isSynchronized()

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

Specified by:
isSynchronized in interface com.aspose.ms.System.Collections.ICollection<SlideEx>

getSyncRoot

public java.lang.Object getSyncRoot()

Returns a synchronization root. Readonly object.

Specified by:
getSyncRoot in interface com.aspose.ms.System.Collections.ICollection<SlideEx>

size

public int size()
Specified by:
size in interface com.aspose.ms.System.Collections.ICollection<SlideEx>

getCount

public int getCount()
Description copied from class: SlidesEx

Gets the number of elements actually contained in the collection.

Overrides:
getCount in class SlidesEx

get_Item

public SlideEx get_Item(int index)
Description copied from class: SlidesEx

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

Overrides:
get_Item in class SlidesEx

addClone

public int addClone(SlideEx slide)
Description copied from class: SlidesEx

Adds a copy of a specified slide to the end of the collection.

Overrides:
addClone in class SlidesEx
Parameters:
slide - Slide to clone.


When clonning a slide between different presentations slide's master can be clonned too. Internal registry is used to track automatically clonned masters to prevent creation of multiple clones of the same master slide. Manual cloning of master slides will be neither prevented nor registered. If you need more control over clonning process use AddClone(SlideEx, LayoutSlideEx) or AddClone(SlideEx, MasterSlideEx) for clonning slides and MasterSlidesEx.AddClone(MasterSlideEx) for clonning masters.

Returns:
Index of new slide.

insertClone

public void insertClone(int index,
                        SlideEx slide)
Description copied from class: SlidesEx

Inserts a copy of a specified slide to specified position of the collection.

Overrides:
insertClone in class SlidesEx
Parameters:
index - Index of new slide.
slide - Slide to clone.


When clonning a slide between different presentations slide's master can be clonned too. Internal registry is used to track automatically clonned masters to prevent creation of multiple clones of the same master slide. Manual cloning of master slides will be neither prevented nor registered. If you need more control over clonning process use InsertClone(int, SlideEx, LayoutSlideEx) or InsertClone(int, SlideEx, MasterSlideEx) for clonning slides and MasterSlidesEx.AddClone(MasterSlideEx) for clonning masters.


addEmptySlide

public int addEmptySlide(LayoutSlideEx layout)
Description copied from class: SlidesEx

Adds a new empty slide to the end of the collection.

Overrides:
addEmptySlide in class SlidesEx
Parameters:
layout - Layout for a slide.
Returns:
Index of a new slide.

insertEmptySlide

public void insertEmptySlide(int index,
                             LayoutSlideEx layout)
Description copied from class: SlidesEx

Inserts a copy of a specified slide to specified position of the collection.

Overrides:
insertEmptySlide in class SlidesEx
Parameters:
index - Index of a new slide.
layout - Layout for a slide.

addClone

public int addClone(SlideEx slide,
                    LayoutSlideEx layout)
Description copied from class: SlidesEx

Adds a copy of a specified slide to the end of the collection.

Overrides:
addClone in class SlidesEx
Parameters:
slide - Slide to clone.
layout - Layout slide for a new slide.
Returns:
Index of new slide.

insertClone

public void insertClone(int index,
                        SlideEx slide,
                        LayoutSlideEx layout)
Description copied from class: SlidesEx

Inserts a copy of a specified slide to specified position of the collection.

Overrides:
insertClone in class SlidesEx
Parameters:
index - Index of new slide.
slide - Slide to clone.
layout - Layout slide for a new slide.

addClone

public int addClone(SlideEx slide,
                    MasterSlideEx master)
Description copied from class: SlidesEx

Adds a copy of a specified slide to the end of the collection. Layout will be selected automatically from the specified master.

Overrides:
addClone in class SlidesEx
Parameters:
slide - Slide to clone.
master - Master slide for a new slide.
Returns:
Index of new slide.

insertClone

public void insertClone(int index,
                        SlideEx slide,
                        MasterSlideEx master)
Description copied from class: SlidesEx

Inserts a copy of a specified slide to specified position of the collection. Layout will be selected automatically from the specified master.

Overrides:
insertClone in class SlidesEx
Parameters:
index - Index of new slide.
slide - Slide to clone.
master - Master slide for a new slide.

remove

public void remove(SlideEx value)
Description copied from class: SlidesEx

Removes the first occurrence of a specific object from the collection.

Overrides:
remove in class SlidesEx
Parameters:
value - The slide to remove from the collection.

removeAt

public void removeAt(int index)
Description copied from class: SlidesEx

Removes the element at the specified index of the collection.

Overrides:
removeAt in class SlidesEx
Parameters:
index - The zero-based index of the element to remove.


Not implemented yet.


iterator

public com.aspose.ms.System.Collections.IEnumerator<SlideEx> iterator()
Description copied from class: SlidesEx

Returns an enumerator for the entire collection.

Specified by:
iterator in interface com.aspose.ms.System.Collections.IEnumerable<SlideEx>
Specified by:
iterator in interface java.lang.Iterable<SlideEx>
Overrides:
iterator in class SlidesEx
Returns:
An IEnumerator for the entire collection.

toArray

public SlideEx[] toArray()
Description copied from class: SlidesEx

Creates and returns an array with all slides in it.

Overrides:
toArray in class SlidesEx
Returns:
Array of SlideEx

toArray

public SlideEx[] toArray(int startIndex,
                         int count)
Description copied from class: SlidesEx

Creates and returns an array with all slides from the specified range in it.

Overrides:
toArray in class SlidesEx
Parameters:
startIndex - An index of a first slide to add.
count - A number of slides to add.
Returns:
Array of SlideEx

reorder

public void reorder(int index,
                    SlideEx slide)
Description copied from class: SlidesEx

Moves slide from the collection to the specified position.

Overrides:
reorder in class SlidesEx
Parameters:
index - Target index.
slide - Slide to move.

reorder

public void reorder(int index,
                    SlideEx... slides)
Description copied from class: SlidesEx

Moves slides from the collection to the specified position. Slides will be placed starting from index in order they appear in list.

Overrides:
reorder in class SlidesEx
Parameters:
index - Target index.
slides - Slides to move.

indexOf

public int indexOf(SlideEx slide)
Description copied from class: SlidesEx

Returns an index of the specified slide in the collection.

Overrides:
indexOf in class SlidesEx
Parameters:
slide - Slide to find.
Returns:
Index of a slide or -1 if slide not from this collection.