Package com.levigo.jadice.web.client.bookmark

Class BookmarkFactory

java.lang.Object

com.levigo.jadice.web.client.bookmark.BookmarkFactory

public class BookmarkFactory
extends Object

Factory class to create client side Bookmark instances.

Constructor Summary

Constructors

Constructor	Description
BookmarkFactory()

Method Summary

Modifier and Type	Method	Description
static Bookmark	createBookmark(Document document, Page page)	Creates a new Bookmark for the given document and page.
static Bookmark	createBookmark(Document document, Page page, Point2D panPoint, Float zoomfactor, BaseRenderSettings.Rotation rotation)	Creates a new Bookmark for the given document and page.

Methods inherited from class java.lang.Object

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

Constructor Details

BookmarkFactory

public BookmarkFactory()

Method Details

createBookmark

public static Bookmark createBookmark(Document document,
 Page page)

Creates a new Bookmark for the given document and page.

May only be used on the client side. Use SerializableBookmark() to create a bookmark on the server side.

Used by the standard commands that are part of jadice web toolkit.

Parameters:

document - the document

page - the page

Returns:

the created bookmark

createBookmark

public static Bookmark createBookmark(Document document,
 Page page,
 Point2D panPoint,
 Float zoomfactor,
 BaseRenderSettings.Rotation rotation)

Creates a new Bookmark for the given document and page. Stores additional attributes with the bookmark that may be used when navigating to the bookmark later.

May only be used on the client side.

Not used by jadice web toolkit standard commands. May be used by customized commands.

Parameters:

document - the document

page - the page

panPoint - optional attribute that can be used e.g. to store the location of the bookmark within the page

zoomfactor - optional attribute that can be used e.g. to store the zoomfactor of the page or the document (150% = 1.5f)

rotation - optional attribute that can be used e.g. to store the BaseRenderSettings.Rotation of the page or the document

Returns:

the created bookmark