com.levigo.jadice.demo.bookmark

Class BookmarkStore

java.lang.Object

com.levigo.jadice.demo.bookmark.BookmarkStore

public class BookmarkStore
extends Object

A simple Bookmark store which holds Bookmarks.

This implementation uses a DefaultOutline to store the bookmarks. It uses the outline type Outlines.TYPE_CUSTOM_OUTLINE.

Note
Another possible way of implementing such a store is to extend Outline directly.

Constructor Summary

Constructors

Constructor and Description
BookmarkStore()

Method Summary

Modifier and Type	Method and Description
void	addBookmark(Bookmark bookmark) Adds the given Bookmark to this store.
void	addBookmarkStoreListener(BookmarkStoreListener listener)
Bookmark	createBookmark(Document document, Page page, String description, PageView pageView) Creates a new Bookmark for the given parameters.
List<Bookmark>	getBookmarks() Returns a list of all Bookmarks this store is holding.
List<Bookmark>	getBookmarks(Document doc) Returns an unmodifiable list of the Bookmarks for this document.
List<Bookmark>	getBookmarks(Page p) Returns an unmodifiable list of the bookmarks for the given Page.
boolean	hasBookmark(Document doc) Checks if the given Document has a Bookmark on it.
boolean	hasBookmark(Page p) Checks if the given Page has a Bookmark on it.
boolean	isBookmarksModified() Returns the "bookmarks modified" flag.
void	removeBookmark(Bookmark bookmark) Removes the given Bookmark from this store.
void	removeBookmarkStoreListener(BookmarkStoreListener listener)
void	setBookmarksModified(boolean modified) Sets the modified flag to the given value.

Methods inherited from class java.lang.Object

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

Constructor Detail

BookmarkStore

public BookmarkStore()

Method Detail

isBookmarksModified

public boolean isBookmarksModified()

Returns the "bookmarks modified" flag.

Note
This demo will set the modified flag when adding/removing bookmarks. The flag will not be reset at any point, so a bookmark store can be assumed to have the flag set to true if it contains bookmarks. Other implementations might sync the state of the store to some external data source and reset the flag accordingly.

Returns:

true: bookmarks have been modified; false otherwise

setBookmarksModified

public void setBookmarksModified(boolean modified)

Sets the modified flag to the given value.

Parameters:

modified - the flag

addBookmark

public void addBookmark(Bookmark bookmark)

Adds the given Bookmark to this store.

Parameters:

bookmark - the bookmark to add

removeBookmark

public void removeBookmark(Bookmark bookmark)

Removes the given Bookmark from this store.

Parameters:

bookmark - the bookmark to remove

getBookmarks

public List<Bookmark> getBookmarks()

Returns a list of all Bookmarks this store is holding.

Returns:

the list of bookmarks

getBookmarks

public List<Bookmark> getBookmarks(Page p)

Returns an unmodifiable list of the bookmarks for the given Page.

Note
This method is not optimized for performance and will traverse the complete outline to retrieve all bookmarks which correspond to the given page. Other implementations might use an other way to find the bookmarks or use some type of caching to speed up finding the bookmarks.

Parameters:

p - the page

Returns:

the list of bookmarks (unmodifiable)

hasBookmark

public boolean hasBookmark(Document doc)

Checks if the given Document has a Bookmark on it.

Implementation note: The check is not optimized for performance. This method will simply check if getBookmarks(Document) has a size > 0.

Parameters:

doc - the document

Returns:

true: the document has a bookmark; false otherwise

hasBookmark

public boolean hasBookmark(Page p)

Checks if the given Page has a Bookmark on it.

Implementation note: The check is not optimized for performance. This method will simply check if getBookmarks(Page) has a size > 0.

Parameters:

p - the page

Returns:

true: page has a bookmark; false otherwise

getBookmarks

public List<Bookmark> getBookmarks(Document doc)

Returns an unmodifiable list of the Bookmarks for this document.

To add/remove bookmarks, use the appropriate methods (addBookmark(Bookmark) / removeBookmark(Bookmark)).

Note
This method is not optimized for performance and will traverse the complete outline to find bookmarks matching the given document. Other implementations might use an other way to find the bookmarks or use some type of caching to speed up finding the bookmarks.

Parameters:

doc - the document

Returns:

the list of bookmarks

addBookmarkStoreListener

public void addBookmarkStoreListener(BookmarkStoreListener listener)

removeBookmarkStoreListener

public void removeBookmarkStoreListener(BookmarkStoreListener listener)

createBookmark

public Bookmark createBookmark(Document document,
                               Page page,
                               String description,
                               PageView pageView)

Creates a new Bookmark for the given parameters.

Note
The created Bookmark will not be added to this store automatically. Use addBookmark(Bookmark) to add the bookmark to this store.

Parameters:

document - the document the bookmark is belonging to

page - the corresponding page

description - the description of the bookmark

pageView - the pageView

Returns:

the created Bookmark