net.sf.japi.swing.bookmarks
Interface Bookmarkable

All Superinterfaces:

CanLoad

public interface Bookmarkable
extends CanLoad

Interface for classes that want to interact with the BookmarkManager. Implement this interface if your class provides information for creating bookmarks. See the class BookmarkManager for more information on Bookmarks.

Author:

Christian Hujer

See Also:

BookmarkManager

Method Summary

Component	getBookmarkBlocker() Get the component which to block for modal dialogs.
String	getBookmarkTitle() Get the title for the Bookmark.
String	getBookmarkURL() Get the URL for the Bookmark.
boolean	isBookmarkPossible() Get wether it currently is possible to create a bookmark.
boolean	load(String url) Load a document. Invoked when the user requests to load a Bookmark.

Method Detail

isBookmarkPossible

boolean isBookmarkPossible()

Get wether it currently is possible to create a bookmark.

Returns:

true if it is possible to create a bookmark, e.g. getBookmarkTitle() and getBookmarkURL() will return meaningful values, otherwise false

getBookmarkTitle

String getBookmarkTitle()

Get the title for the Bookmark.

Returns:

title for Bookmark

getBookmarkURL

String getBookmarkURL()

Get the URL for the Bookmark.

Returns:

url for Bookmark

load

boolean load(String url)

Load a document. This method does not declare any exceptions. The implementor of this method is responsible for handling any exceptional conditions which might occur during the load operation. Invoked when the user requests to load a Bookmark. The implementor of this method is itself responsible of handling errors and displaying eventual error messages to the user

Specified by:

load in interface CanLoad

Parameters:

url - URL from bookmark

Returns:

true if and only if loading the file was successful

getBookmarkBlocker

Component getBookmarkBlocker()

Get the component which to block for modal dialogs. It is safe to return null.

Returns:

component