aspose.pdf
Class Bookmark

java.lang.Object
  aspose.pdf.Bookmark

public class Bookmark
extends java.lang.Object

Represents a bookmark item in the PDF.

Constructor Summary

Bookmark()
Constructor - initializes a new instance of the Bookmark class.

Method Summary

void	addLinkAction(LinkAction action) Adds a LinkAction object to list.
Bookmarks	getChildBookmarks() Gets a Bookmarks object that indicates the child bookmarks.
boolean	getIsExpanded() Gets a boolean value that indicates whether the bookmark item is expanded if it has child bookmarks.
java.util.ArrayList	getLinkActions() Gets a list of link action.
java.lang.String	getLinkParagraphID() Gets a string that indicates the ID of the paragraph that the bookmark item links to.
int	getPageNumber() Gets an int number that indicates the page number of the bookmark link.
java.lang.String	getTitle() Gets a String that indicates the title of the bookmark.
float	getYPosition() Gets a float number that indicates the Y coordination of the bookmark link.
void	setChildBookmarks(Bookmarks value) Sets a Bookmarks object that indicates the child bookmarks.
void	setIsExpanded(boolean value) Sets a boolean value that indicates whether the bookmark item is expanded if it has child bookmarks.
void	setLinkParagraphID(java.lang.String value) Sets a string that indicates the ID of the paragraph that the bookmark item links to.
void	setPageNumber(int value) Sets an int number that indicates the page number of the bookmark link.
void	setTitle(java.lang.String value) Sets a string that indicates the title of the bookmark.
void	setYPosition(float value) Sets a float number that indicates the Y coordination of the bookmark link.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Bookmark

public Bookmark()

Constructor - initializes a new instance of the Bookmark class.

Method Detail

getLinkParagraphID

public java.lang.String getLinkParagraphID()

Gets a string that indicates the ID of the paragraph that the bookmark item links to.

Returns:

A String value.

setLinkParagraphID

public void setLinkParagraphID(java.lang.String value)

Sets a string that indicates the ID of the paragraph that the bookmark item links to. If this property is set, the PageNumber and YPosition properties are not needed. If the link paragraph is Text or Heading and the Title property is not set, the content of the Text or Heading will be used as the title of the bookmark item.

Parameters:

value - A String value.

getChildBookmarks

public Bookmarks getChildBookmarks()

Gets a Bookmarks object that indicates the child bookmarks.

Returns:

A Bookmarks object.

setChildBookmarks

public void setChildBookmarks(Bookmarks value)

Sets a Bookmarks object that indicates the child bookmarks.

Parameters:

value - A Bookmarks object.

getTitle

public java.lang.String getTitle()

Gets a String that indicates the title of the bookmark.

Returns:

Title name.

setTitle

public void setTitle(java.lang.String value)

Sets a string that indicates the title of the bookmark. If the LinkParagraphID is set and the linked paragraph is Text or Heading and this property is not set, the content of the Text or Heading will be used as the title of the bookmark item.

Parameters:

value - Title name.

getPageNumber

public int getPageNumber()

Gets an int number that indicates the page number of the bookmark link.

Returns:

Page number.

setPageNumber

public void setPageNumber(int value)

Sets an int number that indicates the page number of the bookmark link. If the LinkParagraphID is set, this property is not needed.

Parameters:

value - PageNumber value.

getYPosition

public float getYPosition()

Gets a float number that indicates the Y coordination of the bookmark link. The origin of the coordination is the lower-left corner of the page.

Returns:

Y position.

setYPosition

public void setYPosition(float value)

Sets a float number that indicates the Y coordination of the bookmark link. The origin of the coordination is the lower-left corner of the page. If the LinkParagraphID is set, this property is not needed.

Parameters:

value - Y Position.

getIsExpanded

public boolean getIsExpanded()

Gets a boolean value that indicates whether the bookmark item is expanded if it has child bookmarks.

Returns:

A boolean value.

setIsExpanded

public void setIsExpanded(boolean value)

Sets a boolean value that indicates whether the bookmark item is expanded if it has child bookmarks.

Parameters:

value - A boolean value.

addLinkAction

public void addLinkAction(LinkAction action)

Adds a LinkAction object to list.

Parameters:

action - LinkAction object.

getLinkActions

public java.util.ArrayList getLinkActions()

Gets a list of link action.

Returns:

An ArrayList object.