public final class OutlineItemCollection extends Object implements com.aspose.ms.System.Collections.ICollection
Represents outline entry in outline hierarchy of PDF document.
Modifier and Type | Field and Description |
---|---|
com.aspose.pdf.engine.IPdfDocument |
document |
Constructor and Description |
---|
OutlineItemCollection(com.aspose.pdf.engine.data.IPdfObject outline)
Initializes new instance of this class using internal engine outline entry object.
|
OutlineItemCollection(OutlineCollection outlines)
Initializes outline item instance using root hierarchy object.
|
Modifier and Type | Method and Description |
---|---|
void |
add(OutlineItemCollection outline)
Adds outline item to collection.
|
void |
copyTo(com.aspose.ms.System.Array array,
int index)
Copies the outline entries to an System.Array, starting at a particular System.Array index.
|
void |
delete()
Deletes this outline item from the document outline hierarchy.
|
void |
delete(String name)
Deletes outline entry with specified name from the document outline hierarchy.
|
OutlineItemCollection |
get_Item(int index)
Gets outline item from the collection using index.
|
PdfAction |
getAction()
Gets the action for this outline item.
|
boolean |
getBold()
Gets bold flag for the title text of this outline item
|
com.aspose.java.awt.Color |
getColor()
Gets the color for the title text of this outline item.
|
IAppointment |
getDestination()
Gets the destination for this outline item.
|
com.aspose.pdf.engine.data.IPdfDictionary |
getEngineDict() |
com.aspose.pdf.engine.data.IPdfObject |
getEngineObj() |
OutlineItemCollection |
getFirst()
Gets the outline item representing the first top-level item in the outline hierarchy.
|
boolean |
getItalic()
Gets italic flag for the title text of this outline item
|
OutlineItemCollection |
getLast()
Gets the outline item representing the last top-level item in the outline hierarchy.
|
int |
getLevel()
Gets hierarchy level of outline item.
|
OutlineItemCollection |
getNext()
Gets the outline item representing next item relatively this item in the outline hierarchy.
|
boolean |
getOpen()
Get open status (true/false) for outline item.
|
Object |
getParent()
Gets the parent object of this outline item in the outline hierarchy.
|
OutlineItemCollection |
getPrev()
Gets the outline item representing previous item relatively this item in the outline hierarchy.
|
Object |
getSyncRoot()
Gets the object that can be used to synchronize access to this collection.
|
String |
getTitle()
Gets the title for this outline item.
|
void |
insert(int index,
OutlineItemCollection outline)
Inserts the outline item into collection at the specified place.
|
boolean |
isSynchronized()
Gets the value indicating whether access to this collection is synchronized (thread safe).
|
com.aspose.ms.System.Collections.IEnumerator |
iterator()
Returns an enumerator that iterates through the collection.
|
void |
setAction(PdfAction value)
Sets the action for this outline item.
|
void |
setBold(boolean value)
Sets bold flag for the title text of this outline item
|
void |
setColor(com.aspose.java.awt.Color value)
Sets the color for the title text of this outline item.
|
void |
setDestination(IAppointment value)
Sets the destination for this outline item.
|
void |
setItalic(boolean value)
Sets italic flag for the title text of this outline item
|
void |
setOpen(boolean value)
Sets open status (true/false) for outline item.
|
void |
setTitle(String value)
Sets the title for this outline item.
|
int |
size()
Gets the total number of outline items at all levels in the document outline hierarchy.
|
public OutlineItemCollection(com.aspose.pdf.engine.data.IPdfObject outline)
Initializes new instance of this class using internal engine outline entry object.
outline
- Internal engine object of outline entry.public OutlineItemCollection(OutlineCollection outlines)
Initializes outline item instance using root hierarchy object.
outlines
- public com.aspose.pdf.engine.data.IPdfDictionary getEngineDict()
public com.aspose.pdf.engine.data.IPdfObject getEngineObj()
public String getTitle()
Gets the title for this outline item.
public void setTitle(String value)
Sets the title for this outline item.
public IAppointment getDestination()
Gets the destination for this outline item.
public void setDestination(IAppointment value)
Sets the destination for this outline item.
public PdfAction getAction()
Gets the action for this outline item.
public void setAction(PdfAction value)
Sets the action for this outline item.
public com.aspose.java.awt.Color getColor()
Gets the color for the title text of this outline item.
public void setColor(com.aspose.java.awt.Color value)
Sets the color for the title text of this outline item.
public boolean getItalic()
Gets italic flag for the title text of this outline item
public void setItalic(boolean value)
Sets italic flag for the title text of this outline item
public boolean getBold()
Gets bold flag for the title text of this outline item
public void setBold(boolean value)
Sets bold flag for the title text of this outline item
public OutlineItemCollection getFirst()
Gets the outline item representing the first top-level item in the outline hierarchy.
public OutlineItemCollection getLast()
Gets the outline item representing the last top-level item in the outline hierarchy.
public OutlineItemCollection getPrev()
Gets the outline item representing previous item relatively this item in the outline hierarchy.
public OutlineItemCollection getNext()
Gets the outline item representing next item relatively this item in the outline hierarchy.
public Object getParent()
Gets the parent object of this outline item in the outline hierarchy.
public int size()
Gets the total number of outline items at all levels in the document outline hierarchy.
size
in interface com.aspose.ms.System.Collections.ICollection
public boolean isSynchronized()
Gets the value indicating whether access to this collection is synchronized (thread safe).
isSynchronized
in interface com.aspose.ms.System.Collections.ICollection
public Object getSyncRoot()
Gets the object that can be used to synchronize access to this collection.
getSyncRoot
in interface com.aspose.ms.System.Collections.ICollection
public boolean getOpen()
Get open status (true/false) for outline item.
public void setOpen(boolean value)
Sets open status (true/false) for outline item.
public void delete()
Deletes this outline item from the document outline hierarchy.
public void delete(String name)
Deletes outline entry with specified name from the document outline hierarchy.
name
- Title of outline entry will be deleted.public void copyTo(com.aspose.ms.System.Array array, int index)
Copies the outline entries to an System.Array, starting at a particular System.Array index.
copyTo
in interface com.aspose.ms.System.Collections.ICollection
array
- The one-dimensional System.Array that is the destination. Must have zero-based indexing.index
- The zero-based index in array at which copying begins.public com.aspose.ms.System.Collections.IEnumerator iterator()
Returns an enumerator that iterates through the collection.
public void add(OutlineItemCollection outline)
Adds outline item to collection.
outline
- The outline item to be added.public void insert(int index, OutlineItemCollection outline)
Inserts the outline item into collection at the specified place.
index
- The index specifying place for inserting.outline
- The outline item should be inserted.public OutlineItemCollection get_Item(int index)
Gets outline item from the collection using index.
index
- public int getLevel()
Gets hierarchy level of outline item.
Copyright © 2017 Aspose. All Rights Reserved.