Outlines
Inheritance: java.lang.Object
All Implemented Interfaces: java.lang.Iterable
public abstract class Outlines implements Iterable<OutlineItemCollection>
Class describes collection of outlines.
Constructors
| Constructor | Description |
|---|---|
| Outlines() |
Methods
| Method | Description |
|---|---|
| size() | Gets count. |
| isReadOnly() | Gets a value indicating whether the collection is read-only. |
| getVisibleCount() | Gets the total number of outline items at all levels in the document outline hierarchy. |
| add(OutlineItemCollection item) | Adds outline item to collection. |
| clear() | Clears all items from the collection. |
| contains(OutlineItemCollection item) | Always throws NotImplementedException. |
| copyTo(OutlineItemCollection[] array, int arrayIndex) | Copies the outline entries to an System.Array, starting at a particular System.Array index. |
| iterator() | Returns an enumerator that iterates through the collection. |
| remove(OutlineItemCollection item) | Remove outline collection item. |
| iterator_Rename_Namesake() |
Outlines()
public Outlines()
size()
public abstract int size()
Gets count.
Returns: int - int value
isReadOnly()
public abstract boolean isReadOnly()
Gets a value indicating whether the collection is read-only.
Returns: boolean - boolean value
getVisibleCount()
public abstract int getVisibleCount()
Gets the total number of outline items at all levels in the document outline hierarchy.
Returns: int - int value
add(OutlineItemCollection item)
public abstract void add(OutlineItemCollection item)
Adds outline item to collection.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| item | OutlineItemCollection | The outline item to be added. |
clear()
public abstract void clear()
Clears all items from the collection.
contains(OutlineItemCollection item)
public abstract boolean contains(OutlineItemCollection item)
Always throws NotImplementedException.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| item | OutlineItemCollection | The object to locate in the collection |
Returns: boolean - boolean value True - if item found; otherwise, false.
copyTo(OutlineItemCollection[] array, int arrayIndex)
public abstract void copyTo(OutlineItemCollection[] array, int arrayIndex)
Copies the outline entries to an System.Array, starting at a particular System.Array index.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| array | OutlineItemCollection[] | The one-dimensional System.Array that is the destination. Must have zero-based indexing. |
| arrayIndex | int | The zero-based index in array at which copying begins. |
iterator()
public abstract Iterator<OutlineItemCollection> iterator()
Returns an enumerator that iterates through the collection.
Returns: java.util.Iterator<com.aspose.pdf.OutlineItemCollection> - An System.Collections.IEnumerator object that can be used to iterate through the collection.
remove(OutlineItemCollection item)
public abstract boolean remove(OutlineItemCollection item)
Remove outline collection item.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| item | OutlineItemCollection | Item to delete. |
Returns: boolean - boolean value True - if item removed; otherwise, false.
iterator_Rename_Namesake()
public final System.Collections.IEnumerator iterator_Rename_Namesake()
Returns: com.aspose.ms.System.Collections.IEnumerator
