org.eclipse.stardust.engine.extensions.dms.data.annotations.printdocument

Interface PageBookmarkable

All Known Subinterfaces:

PrintDocumentAnnotations

public interface PageBookmarkable

Method Summary

Methods

Modifier and Type	Method and Description
void	addAllBookmarks(Set<PageBookmark> bookmarks) Adds the given set of bookmarks to the stored ones.
void	addBookmark(PageBookmark bookmark) Adds the Bookmark.
PageBookmark	getBookmark(String id)
Set<PageBookmark>	getBookmarks()
PageBookmark	getDefaultBookmark()
void	moveBookmark(int sourceOrder, int targetOrder)
void	removeAllBookmarks() Removes all bookmarks.
void	removeBookmark(String id)
void	setBookmarks(Set<PageBookmark> bookmarks) Replaces the stored bookmarks with the given set.
void	setDefaultBookmark(String id)

Method Detail

addBookmark

void addBookmark(PageBookmark bookmark)

Adds the Bookmark.

Parameters:

bookmark -

Throws:

org.eclipse.stardust.common.error.InvalidArgumentException - if the id of the Bookmark already exists.

getBookmark

PageBookmark getBookmark(String id)

getBookmarks

Set<PageBookmark> getBookmarks()

moveBookmark

void moveBookmark(int sourceOrder,
                int targetOrder)

removeBookmark

void removeBookmark(String id)

getDefaultBookmark

PageBookmark getDefaultBookmark()

setDefaultBookmark

void setDefaultBookmark(String id)

setBookmarks

void setBookmarks(Set<PageBookmark> bookmarks)

Replaces the stored bookmarks with the given set.

Parameters:

bookmarks -

Throws:

org.eclipse.stardust.common.error.InvalidArgumentException - if the given set contains more than one element with the same Identifiable#id.

addAllBookmarks

void addAllBookmarks(Set<PageBookmark> bookmarks)

Adds the given set of bookmarks to the stored ones.

Parameters:

bookmarks -

Throws:

org.eclipse.stardust.common.error.InvalidArgumentException - if the given set contains more than one element with the same Identifiable#id.

org.eclipse.stardust.common.error.InvalidArgumentException - if the given set contains at least one bookmark with the same Identifiable#id as a stored bookmark.

removeAllBookmarks

void removeAllBookmarks()

Removes all bookmarks.