OutlineItemCollection

Inheritance: java.lang.Object, com.aspose.pdf.Outlines

public final class OutlineItemCollection extends Outlines

Represents outline entry in outline hierarchy of PDF document.

Constructors

Constructor	Description
OutlineItemCollection(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.

Methods

Method	Description
getEngineDict()	Internal only
getEngineObj()	Internal only
getTitle()	Gets the title for this outline item.
setTitle(String value)	Sets the title for this outline item.
getDestination()	Gets the destination for this outline item.
setDestination(IAppointment value)	Sets the destination for this outline item.
getAction()	Gets the action for this outline item.
setAction(PdfAction value)	Sets the action for this outline item.
getColor()	Gets the color for the title text of this outline item.
setColor(Color value)	Sets the color for the title text of this outline item.
getItalic()	Gets italic flag for the title text of this outline item
setItalic(boolean value)	Sets italic flag for the title text of this outline item
getBold()	Gets bold flag for the title text of this outline item
setBold(boolean value)	Sets bold flag for the title text of this outline item
getFirst()	Gets the outline item representing the first top-level item in the outline hierarchy.
getLast()	Gets the outline item representing the last top-level item in the outline hierarchy.
getPrev()	Gets the outline item representing previous item relatively this item in the outline hierarchy.
getNext()	Gets the outline item representing next item relatively this item in the outline hierarchy.
hasNext()	Check if outline item representing next item relatively this item in the outline hierarchy.
next()
getParent()	Gets the parent object of this outline item in the outline hierarchy.
getVisibleCount()	Gets the total number of outline items at all levels in the document outline hierarchy.
isSynchronized()	Gets the value indicating whether access to this collection is synchronized (thread safe).
getSyncRoot()	Gets the object that can be used to synchronize access to this collection.
isReadOnly()	Gets a value indicating whether the collection is read-only.
getOpen()	Get open status (true/false) for outline item.
setOpen(boolean value)	Sets open status (true/false) for outline item.
delete()	Deletes this outline item from the document outline hierarchy.
delete(String name)	Deletes outline entry with specified name from the document outline hierarchy.
copyTo(OutlineItemCollection[] array, int index)	Copies the outline entries to an System.Array, starting at a particular System.Array index.
iterator()	Returns an enumerator that iterates through the collection.
add(OutlineItemCollection outline)	Adds outline item to collection.
insert(int index, OutlineItemCollection outline)	Inserts the outline item into collection at the specified place.
clear()	Clears all items from the collection.
contains(OutlineItemCollection item)	Not supported yet.
remove(OutlineItemCollection item)	Not supported yet.
remove(int index)	Remove item by index.
size()	Count of collection items.
get_Item(int index)	Gets outline item from the collection using index.
getLevel()	Gets hierarchy level of outline item.

OutlineItemCollection(IPdfObject outline)

public OutlineItemCollection(IPdfObject outline)

Initializes new instance of this class using internal engine outline entry object.

Parameters:

Parameter	Type	Description
outline	IPdfObject	Internal engine object of outline entry.

OutlineItemCollection(OutlineCollection outlines)

public OutlineItemCollection(OutlineCollection outlines)

Initializes outline item instance using root hierarchy object.

Parameters:

Parameter	Type	Description
outlines	OutlineCollection	Outlune collection.

getEngineDict()

public IPdfDictionary getEngineDict()

Internal only

Returns: IPdfDictionary - IPdfDictionary object

getEngineObj()

public IPdfObject getEngineObj()

Internal only

Returns: IPdfObject - IPdfObject object

getTitle()

public String getTitle()

Gets the title for this outline item.

Returns: java.lang.String - String value

setTitle(String value)

public void setTitle(String value)

Sets the title for this outline item.

Parameters:

Parameter	Type	Description
value	java.lang.String	String value

getDestination()

public IAppointment getDestination()

Gets the destination for this outline item.

Returns: IAppointment - IAppointment value

setDestination(IAppointment value)

public void setDestination(IAppointment value)

Sets the destination for this outline item.

Parameters:

Parameter	Type	Description
value	IAppointment	IAppointment value

getAction()

public PdfAction getAction()

Gets the action for this outline item.

Returns: PdfAction - PdfAction value

setAction(PdfAction value)

public void setAction(PdfAction value)

Sets the action for this outline item.

Parameters:

Parameter	Type	Description
value	PdfAction	PdfAction value

getColor()

public Color getColor()

Gets the color for the title text of this outline item.

Returns: Color - Color value

setColor(Color value)

public void setColor(Color value)

Sets the color for the title text of this outline item.

Parameters:

Parameter	Type	Description
value	java.awt.Color	Color object

getItalic()

public boolean getItalic()

Gets italic flag for the title text of this outline item

Returns: boolean - boolean value

setItalic(boolean value)

public void setItalic(boolean value)

Sets italic flag for the title text of this outline item

Parameters:

Parameter	Type	Description
value	boolean	boolean value

getBold()

public boolean getBold()

Gets bold flag for the title text of this outline item

Returns: boolean - boolean value

setBold(boolean value)

public void setBold(boolean value)

Sets bold flag for the title text of this outline item

Parameters:

Parameter	Type	Description
value	boolean	boolean value

getFirst()

public OutlineItemCollection getFirst()

Gets the outline item representing the first top-level item in the outline hierarchy.

Returns: OutlineItemCollection - OutlineItemCollection value

getLast()

public OutlineItemCollection getLast()

Gets the outline item representing the last top-level item in the outline hierarchy.

Returns: OutlineItemCollection - OutlineItemCollection value

getPrev()

public OutlineItemCollection getPrev()

Gets the outline item representing previous item relatively this item in the outline hierarchy.

Returns: OutlineItemCollection - OutlineItemCollection value

getNext()

public OutlineItemCollection getNext()

Gets the outline item representing next item relatively this item in the outline hierarchy.

Returns: OutlineItemCollection - OutlineItemCollection value

hasNext()

public final boolean hasNext()

Check if outline item representing next item relatively this item in the outline hierarchy.

Returns: boolean - boolean value

next()

public OutlineItemCollection next()

Returns: OutlineItemCollection

getParent()

public Outlines getParent()

Gets the parent object of this outline item in the outline hierarchy.

Returns: Outlines - Object value

getVisibleCount()

public int getVisibleCount()

Gets the total number of outline items at all levels in the document outline hierarchy.

Returns: int - int value

isSynchronized()

public boolean isSynchronized()

Gets the value indicating whether access to this collection is synchronized (thread safe).

Returns: boolean - boolean value

getSyncRoot()

public Object getSyncRoot()

Gets the object that can be used to synchronize access to this collection.

Returns: java.lang.Object - Object value

isReadOnly()

public boolean isReadOnly()

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

Returns: boolean - boolean value

getOpen()

public boolean getOpen()

Get open status (true/false) for outline item.

Returns: boolean - boolean value

setOpen(boolean value)

public void setOpen(boolean value)

Sets open status (true/false) for outline item.

Parameters:

Parameter	Type	Description
value	boolean	boolean value

delete()

public void delete()

Deletes this outline item from the document outline hierarchy.

delete(String name)

public void delete(String name)

Deletes outline entry with specified name from the document outline hierarchy.

Parameters:

Parameter	Type	Description
name	java.lang.String	Title of outline entry will be deleted.

copyTo(OutlineItemCollection[] array, int index)

public void copyTo(OutlineItemCollection[] array, int index)

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.
index	int	The zero-based index in array at which copying begins.

iterator()

public 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.

add(OutlineItemCollection outline)

public void add(OutlineItemCollection outline)

Adds outline item to collection.

Parameters:

Parameter	Type	Description
outline	OutlineItemCollection	The outline item to be added.

insert(int index, OutlineItemCollection outline)

public void insert(int index, OutlineItemCollection outline)

Inserts the outline item into collection at the specified place.

Parameters:

Parameter	Type	Description
index	int	The index specifying place for inserting.
outline	OutlineItemCollection	The outline item should be inserted.

clear()

public void clear()

Clears all items from the collection.

contains(OutlineItemCollection item)

public boolean contains(OutlineItemCollection item)

Not supported yet.

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.

remove(OutlineItemCollection item)

public boolean remove(OutlineItemCollection item)

Not supported yet.

Always throws NotImplementedException

Parameters:

Parameter	Type	Description
item	OutlineItemCollection	OutlineItemCollection instance

Returns: boolean - boolean value True - if item removed; otherwise, false.

remove(int index)

public final void remove(int index)

Remove item by index.

Parameters:

Parameter	Type	Description
index	int	Index of item to be deleted.

size()

public int size()

Count of collection items. Please dont confuse with VisibleCount: VisibleCount gets number of visible outline item on all levels.

Returns: int

get_Item(int index)

public OutlineItemCollection get_Item(int index)

Gets outline item from the collection using index.

Parameters:

Parameter	Type	Description
index	int	Index within the collection.

Returns: OutlineItemCollection - OutlineItemCollection object.

getLevel()

public int getLevel()

Gets hierarchy level of outline item.

Returns: int - int value