com.compdfkit.core.document

Class CPDFOutline

java.lang.Object

com.compdfkit.core.document.CPDFOutline

public class CPDFOutline
extends java.lang.Object

A document outline (or "table of contents entry"), usually the header of a chapter. Outline objects can be retrieved via getChildList(). They can carry an Action and thus allow quick navigation to document pages, or even external resources.

Method Summary

Modifier and Type	Method and Description
CPDFAction	getAction() Gets the action performed when users click the outline, more: CPDFAction
CPDFOutline	getChildAt(int index) Gets the TPDFOutline object at the specified index.
CPDFOutline[]	getChildList() Gets all the items within an outline hierarchy, more:CPDFOutline
CPDFDestination	getDestination() Gets the destination associated with the outline, more: CPDFDestination
int	getLevel() Gets outline level.
CPDFOutline	getParent() Gets the parent outline object of the outline.
java.lang.String	getTag() Gets outline tag, which will not be saved in file and just for temporary use
java.lang.String	getTitle() Gets outline title.
CPDFOutline	insertChildAtIndex(int index) Create an outline object and inserts the outline object at the specified index.
boolean	moveOutline(CPDFOutline move, int index) Move an outline object and inserts the outline object to this outline object at the specified index.
boolean	moveTo(CPDFOutline newParent, int index) Move outline to other place.
boolean	removeFromParent() Removes the outline object from its parent.
boolean	setAction(CPDFAction action) Sets the action performed when users click the outline, more: CPDFAction
boolean	setDestination(CPDFDestination destination) Sets the destination associated with the outline, more: CPDFDestination
void	setTag(java.lang.String tag) Sets outline tag, which will not be saved in file and just for temporary use
boolean	setTitle(java.lang.String title) Sets outline title.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getChildList

public CPDFOutline[] getChildList()

Gets all the items within an outline hierarchy, more:CPDFOutline

Returns:

Returns all the items within an outline hierarchy.

getChildAt

public CPDFOutline getChildAt(int index)

Gets the TPDFOutline object at the specified index.

Parameters:

index - the index of specified

Returns:

Returns the TPDFOutline object at the specified index.

getLevel

public int getLevel()

Gets outline level.

Returns:

Returns outline level.

getTitle

public java.lang.String getTitle()

Gets outline title.

Returns:

Returns outline title.

setTitle

public boolean setTitle(java.lang.String title)

Sets outline title.

Parameters:

title - Outline title.

Returns:

Returns whether to successfully set outline title.

getDestination

public CPDFDestination getDestination()

Gets the destination associated with the outline, more: CPDFDestination

Returns:

Returns the destination associated with the outline.

setDestination

public boolean setDestination(CPDFDestination destination)

Sets the destination associated with the outline, more: CPDFDestination

Parameters:

destination - Destination associated with the outline

Returns:

Returns whether to successfully set the destination associated with the outline.

getAction

public CPDFAction getAction()

Gets the action performed when users click the outline, more: CPDFAction

Returns:

Returns the action performed when users click the outline.

setAction

public boolean setAction(CPDFAction action)

Sets the action performed when users click the outline, more: CPDFAction

Parameters:

action - The action performed when users click the outline.

Returns:

Returns whether to successfully set the action performed when users click the outline.

getParent

public CPDFOutline getParent()

Gets the parent outline object of the outline.

Returns:

Returns the parent outline object of the outline.

removeFromParent

public boolean removeFromParent()

Removes the outline object from its parent.

Returns:

Whether to successfully remove the outline object from its parent.

insertChildAtIndex

public CPDFOutline insertChildAtIndex(int index)

Create an outline object and inserts the outline object at the specified index.

Parameters:

index - Child item index of outline

Returns:

Returns the newly inserted outline object

moveOutline

public boolean moveOutline(CPDFOutline move,
                           int index)

Move an outline object and inserts the outline object to this outline object at the specified index.

Parameters:

move - The outline object to move.

index - The index to insert at.

Returns:

Returns whether succeed to move the outline.

moveTo

public boolean moveTo(CPDFOutline newParent,
                      int index)

Move outline to other place.

Parameters:

newParent - The new parent of the outline after moved.

index - The index of the outline in new parent.

Returns:

Returns whether succeed to move.

getTag

public java.lang.String getTag()

Gets outline tag, which will not be saved in file and just for temporary use

Returns:

Returns tag

setTag

public void setTag(java.lang.String tag)

Sets outline tag, which will not be saved in file and just for temporary use

Parameters:

tag - Outline tag

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object