com.aspose.pdf

Class DestinationCollection

java.lang.Object

com.aspose.pdf.DestinationCollection

All Implemented Interfaces:

Iterable<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,Object>>

public final class DestinationCollection
extends Object
implements Iterable<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,Object>>

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

Modifier and Type	Method and Description
void	add(com.aspose.ms.System.Collections.Generic.KeyValuePair<String,Object> item) Collection is read-only.
void	clear() Collection is read-only.
boolean	contains(com.aspose.ms.System.Collections.Generic.KeyValuePair<String,Object> value) Determines whether a destination is in collection or not.
void	copyTo(com.aspose.ms.System.Collections.Generic.KeyValuePair<String,Object> array, int arrayIndex) Copies the elements of the collection to an Array, starting at a particular Array index.
com.aspose.ms.System.Collections.Generic.KeyValuePair<String,Object>	get_Item(int index) Gets the destination object by index.
ExplicitDestination	getExplicitDestination(String destinameName, boolean useCache) Returns the explicit destination by the name.
int	getPageNumber(String destinameName, boolean useCache) Returns the page number of destination by the name.
int	indexOf(com.aspose.ms.System.Collections.Generic.KeyValuePair<String,Object> value) Returns the index of destination in collection.
boolean	isReadOnly() Gets a value indicating whether the collection is read-only.
com.aspose.ms.System.Collections.IEnumerator<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,Object>>	iterator() Returns the enumerator.
boolean	remove(com.aspose.ms.System.Collections.Generic.KeyValuePair<String,Object> item) Collection is read-only.
int	size() Gets the number of elements contained in the collection.

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

size

public int size()

Gets the number of elements contained in the collection.

Returns:

int value

isReadOnly

public boolean isReadOnly()

Gets a value indicating whether the collection is read-only.

Returns:

boolean value

get_Item

public com.aspose.ms.System.Collections.Generic.KeyValuePair<String,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.

getExplicitDestination

public ExplicitDestination getExplicitDestination(String destinameName,
                                                  boolean useCache)

Returns the explicit destination by the name.

Parameters:

destinameName - The name of destination.

useCache - Determines whether cached version of collection is used or not.

Returns:

The ExplicitDestination object for destination found; otherwise, null.

iterator

public com.aspose.ms.System.Collections.IEnumerator<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,Object>> iterator()

Returns the enumerator.

Specified by:

iterator in interface Iterable<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,Object>>

Returns:

The enumerator.

indexOf

public int indexOf(com.aspose.ms.System.Collections.Generic.KeyValuePair<String,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(com.aspose.ms.System.Collections.Generic.KeyValuePair<String,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.

copyTo

public void copyTo(com.aspose.ms.System.Collections.Generic.KeyValuePair<String,Object> array,
                   int arrayIndex)

Copies the elements of the collection to an Array, starting at a particular Array index.

Parameters:

array - The one-dimensional Array that is the destination of the elements copied from collection

arrayIndex - The zero-based index in array at which copying begins.

add

public void add(com.aspose.ms.System.Collections.Generic.KeyValuePair<String,Object> item)

Collection is read-only. Always throws NotSupportedException exception.

Parameters:

item - not supported yet.

clear

public void clear()

Collection is read-only. Always throws NotSupportedException exception.

remove

public boolean remove(com.aspose.ms.System.Collections.Generic.KeyValuePair<String,Object> item)

Collection is read-only. Always throws NotSupportedException exception.

Parameters:

item - not supportd yet.

Returns:

boolean value