Bookmark

Inheritance: java.lang.Object

public final class Bookmark

Represents a bookmark.

Constructors

ConstructorDescription
Bookmark()Initializes a new instance of the Bookmark class.

Methods

MethodDescription
toOutlineItemCollection(IDocument doc)convert to OutlineItemCollection
getAction()Gets the action bound with the bookmark.
setAction(String value)Sets the action bound with the bookmark.
getBoldFlag()Gets the bold flag of bookmark’s title.
setBoldFlag(boolean value)Sets the bold flag of bookmark’s title.
getChildItem()Gets bookmark’s children.
setChildItem(Bookmarks value)Sets bookmark’s children.
getChildItems()Gets bookmark’s children.
setChildItems(Bookmarks value)Sets bookmark’s children.
getCustomAcorbatViewerMenuActionName()Not supported yet.
setCustomAcorbatViewerMenuActionName(int[] value)Not supported yet.
getDestination()Gets bookmark’s destination page.
setDestination(String value)Sets bookmark’s destination page.
getItalicFlag()Gets the italic flag of bookmark’s title.
setItalicFlag(boolean value)Sets the italic flag of bookmark’s title.
getLevel()Gets bookmark’s hierarchy level.
setLevel(int value)Sets bookmark’s hierarchy level.
getPageDisplay()Gets the type of display bookmark’s destination page.
setPageDisplay(String value)Sets the type of display bookmark’s destination page.
getPageDisplay_Bottom()Gets the bottom coordinate of page display.
setPageDisplay_Bottom(int value)Sets the bottom coordinate of page display.
getPageDisplay_Left()Gets the left coordinate of page display.
setPageDisplay_Left(int value)Sets the left coordinate of page display.
getPageDisplay_Right()Gets the right coordinate of page display.
setPageDisplay_Right(int value)Sets the right coordinate of page display.
getPageDisplay_Top()Gets the top coordinate of page display.
setPageDisplay_Top(int value)Sets the top coordinate of page display.
getPageDisplay_Zoom()Gets the zoom factor of page display.
setPageDisplay_Zoom(int value)Sets the zoom factor of page display.
getPageNumber()Gets the number of bookmark’s destination page.
setPageNumber(int value)Sets the number of bookmark’s destination page.
getRemoteFile()Gets the file (path) which is required for “GoToR” action of bookmark.
setRemoteFile(String value)Sets the file (path) which is required for “GoToR” action of bookmark.
getTitle()Gets bookmark’s title.
setTitle(String value)Sets bookmark’s title.
getTitleColor()Gets the color of bookmark’s title.
setTitleColor(Color value)Sets the color of bookmark’s title.
isOpen()Gets bookmark state (open, close).
setOpen(boolean value)Sets bookmark state (open, close).

Bookmark()

public Bookmark()

Initializes a new instance of the Bookmark class.

toOutlineItemCollection(IDocument doc)

public OutlineItemCollection toOutlineItemCollection(IDocument doc)

convert to OutlineItemCollection

Parameters:

ParameterTypeDescription
docIDocumentDocument object

Returns: OutlineItemCollection - OutlineItemCollection object

getAction()

public String getAction()

Gets the action bound with the bookmark. If PageNumber is presented the action can not be specified. The action type includes: “GoTo”, “GoToR”, “Launch”, “Named”.

Returns: java.lang.String - String value

setAction(String value)

public void setAction(String value)

Sets the action bound with the bookmark. If PageNumber is presented the action can not be specified. The action type includes: “GoTo”, “GoToR”, “Launch”, “Named”.

Parameters:

ParameterTypeDescription
valuejava.lang.StringString value

getBoldFlag()

public boolean getBoldFlag()

Gets the bold flag of bookmark’s title.

Returns: boolean - boolean value

setBoldFlag(boolean value)

public void setBoldFlag(boolean value)

Sets the bold flag of bookmark’s title.

Parameters:

ParameterTypeDescription
valuebooleanboolean value

getChildItem()

public Bookmarks getChildItem()

Gets bookmark’s children.

Obsolete(“Use getChildItems() property instead of this one.”)

Returns: Bookmarks - Bookmarks element

setChildItem(Bookmarks value)

public void setChildItem(Bookmarks value)

Sets bookmark’s children.

Obsolete(“Use setChildItems() property instead of this one.”)

Parameters:

ParameterTypeDescription
valueBookmarksBookmarks element

getChildItems()

public Bookmarks getChildItems()

Gets bookmark’s children.

Returns: Bookmarks - bookmark’s children items.

setChildItems(Bookmarks value)

public void setChildItems(Bookmarks value)

Sets bookmark’s children.

Parameters:

ParameterTypeDescription
valueBookmarksbookmark’s children items.

getCustomAcorbatViewerMenuActionName()

public int[] getCustomAcorbatViewerMenuActionName()

Not supported yet.

The action name corresponding to execute a menu item in Acrobat viewer.

Returns: int[] - array of int value

setCustomAcorbatViewerMenuActionName(int[] value)

public void setCustomAcorbatViewerMenuActionName(int[] value)

Not supported yet.

Sets the action name corresponding to execute a menu item in Acrobat viewer.

Parameters:

ParameterTypeDescription
valueint[]array of int value

getDestination()

public String getDestination()

Gets bookmark’s destination page. Required if action is set as “”.

Returns: java.lang.String - String value

setDestination(String value)

public void setDestination(String value)

Sets bookmark’s destination page. Required if action is set as “”.

Parameters:

ParameterTypeDescription
valuejava.lang.StringString value

getItalicFlag()

public boolean getItalicFlag()

Gets the italic flag of bookmark’s title.

Returns: boolean - boolean value

setItalicFlag(boolean value)

public void setItalicFlag(boolean value)

Sets the italic flag of bookmark’s title.

Parameters:

ParameterTypeDescription
valuebooleanboolean value

getLevel()

public int getLevel()

Gets bookmark’s hierarchy level.

Returns: int - int value

setLevel(int value)

public void setLevel(int value)

Sets bookmark’s hierarchy level.

Parameters:

ParameterTypeDescription
valueintint value

getPageDisplay()

public String getPageDisplay()

Gets the type of display bookmark’s destination page.

Returns: java.lang.String - String value

setPageDisplay(String value)

public void setPageDisplay(String value)

Sets the type of display bookmark’s destination page.

Parameters:

ParameterTypeDescription
valuejava.lang.StringString value

getPageDisplay_Bottom()

public int getPageDisplay_Bottom()

Gets the bottom coordinate of page display.

Returns: int - int value

setPageDisplay_Bottom(int value)

public void setPageDisplay_Bottom(int value)

Sets the bottom coordinate of page display.

Parameters:

ParameterTypeDescription
valueintint value

getPageDisplay_Left()

public int getPageDisplay_Left()

Gets the left coordinate of page display.

Returns: int - int value

setPageDisplay_Left(int value)

public void setPageDisplay_Left(int value)

Sets the left coordinate of page display.

Parameters:

ParameterTypeDescription
valueintint value

getPageDisplay_Right()

public int getPageDisplay_Right()

Gets the right coordinate of page display.

Returns: int - int value

setPageDisplay_Right(int value)

public void setPageDisplay_Right(int value)

Sets the right coordinate of page display.

Parameters:

ParameterTypeDescription
valueintint value

getPageDisplay_Top()

public int getPageDisplay_Top()

Gets the top coordinate of page display.

Returns: int - int value

setPageDisplay_Top(int value)

public void setPageDisplay_Top(int value)

Sets the top coordinate of page display.

Parameters:

ParameterTypeDescription
valueintint value

getPageDisplay_Zoom()

public int getPageDisplay_Zoom()

Gets the zoom factor of page display.

Returns: int - int value

setPageDisplay_Zoom(int value)

public void setPageDisplay_Zoom(int value)

Sets the zoom factor of page display.

Parameters:

ParameterTypeDescription
valueintint value

getPageNumber()

public int getPageNumber()

Gets the number of bookmark’s destination page.

Returns: int - int value

setPageNumber(int value)

public void setPageNumber(int value)

Sets the number of bookmark’s destination page.

Parameters:

ParameterTypeDescription
valueintint value

getRemoteFile()

public String getRemoteFile()

Gets the file (path) which is required for “GoToR” action of bookmark.

Returns: java.lang.String - String value

setRemoteFile(String value)

public void setRemoteFile(String value)

Sets the file (path) which is required for “GoToR” action of bookmark.

Parameters:

ParameterTypeDescription
valuejava.lang.StringString value

getTitle()

public String getTitle()

Gets bookmark’s title.

Returns: java.lang.String - String value

setTitle(String value)

public void setTitle(String value)

Sets bookmark’s title.

Parameters:

ParameterTypeDescription
valuejava.lang.StringString value

getTitleColor()

public Color getTitleColor()

Gets the color of bookmark’s title.

Returns: Color - Color element

setTitleColor(Color value)

public void setTitleColor(Color value)

Sets the color of bookmark’s title.

Parameters:

ParameterTypeDescription
valuejava.awt.ColorColor element

isOpen()

public boolean isOpen()

Gets bookmark state (open, close).

Returns: boolean - boolean value

setOpen(boolean value)

public void setOpen(boolean value)

Sets bookmark state (open, close).

Parameters:

ParameterTypeDescription
valuebooleanboolean value