com.aspose.pdf

Interfaces

Classes

Enums

Exceptions

com.aspose.pdf

Class DestinationCollection

  • java.lang.Object
    • com.aspose.ms.System.Collections.ReadOnlyCollectionBase
      • com.aspose.pdf.DestinationCollection
  • All Implemented Interfaces:
    com.aspose.ms.System.Collections.ICollection, com.aspose.ms.System.Collections.IEnumerable, Iterable


    public final class DestinationCollection
    extends com.aspose.ms.System.Collections.ReadOnlyCollectionBase

    Class represents the collection of all destinations (a name tree mapping name strings to destinations (see 12.3.2.3, "Named Destinations") and (see 7.7.4, "Name Dictionary")) in the pdf document.

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      boolean contains(Object value)
      Determines whether a destination is in collection or not.
      Object get_Item(int index)
      Gets the destination object by index.
      int getPageNumber(String destinameName, boolean useCache)
      Returns the page number of destination by the name.
      int indexOf(Object value)
      Returns the index of destination in collection.
      com.aspose.ms.System.Collections.IEnumerator iterator()
      Returns the enumerator.
      int size()
      Destinations count
      • Methods inherited from class com.aspose.ms.System.Collections.ReadOnlyCollectionBase

        copyTo, getSyncRoot, isSynchronized
    • Method Detail

      • get_Item

        public Object get_Item(int index)

        Gets the destination object by index.

        Parameters:
        index - The index of destination to get.
        Returns:
        Destination.
      • getPageNumber

        public int getPageNumber(String destinameName,
                        boolean useCache)

        Returns the page number of destination by the name.

        Parameters:
        destinameName - The name of destination.
        useCache - Determines whether cached version of collection is used or not.
        Returns:
        The page number if destination was found; otherwise, -1.
      • iterator

        public com.aspose.ms.System.Collections.IEnumerator iterator()

        Returns the enumerator.

        Specified by:
        iterator in interface com.aspose.ms.System.Collections.IEnumerable
        Specified by:
        iterator in interface Iterable
        Overrides:
        iterator in class com.aspose.ms.System.Collections.ReadOnlyCollectionBase
        Returns:
        The enumerator.
      • indexOf

        public int indexOf(Object value)

        Returns the index of destination in collection.

        Parameters:
        value - The value to find.
        Returns:
        The index of destination in collection.
      • contains

        public boolean contains(Object value)

        Determines whether a destination is in collection or not.

        Parameters:
        value - The value to find.
        Returns:
        True if a destination is in collection; otherwise, false.
      • size

        public int size()
        Destinations count
        Specified by:
        size in interface com.aspose.ms.System.Collections.ICollection
        Overrides:
        size in class com.aspose.ms.System.Collections.ReadOnlyCollectionBase
        Returns:
        int value