|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectaspose.pdf.Bookmark
public class Bookmark
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 |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Bookmark()
Bookmark
class.
Method Detail |
---|
public java.lang.String getLinkParagraphID()
public void setLinkParagraphID(java.lang.String value)
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.
value
- A String value.public Bookmarks getChildBookmarks()
Bookmarks
object that indicates the child bookmarks.
Bookmarks
object.public void setChildBookmarks(Bookmarks value)
Bookmarks
object that indicates the child bookmarks.
value
- A Bookmarks
object.public java.lang.String getTitle()
public void setTitle(java.lang.String value)
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.
value
- Title name.public int getPageNumber()
public void setPageNumber(int value)
LinkParagraphID
is set,
this property is not needed.
value
- PageNumber value.public float getYPosition()
public void setYPosition(float value)
LinkParagraphID
is set, this property
is not needed.
value
- Y Position.public boolean getIsExpanded()
public void setIsExpanded(boolean value)
value
- A boolean value.public void addLinkAction(LinkAction action)
LinkAction
object to list.
action
- LinkAction
object.public java.util.ArrayList getLinkActions()
ArrayList
object.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |