CIB jView archive technischer Leitfaden
4. Schnittstellendefinitionen
4.5. Interface Bookmarkable
Dieses Interface aus dem Archive-API definiert die Schnittstelle von Archivobjekten, für die Lesezeichen vergeben werden können.
Jedes Archivobjekt, für das Lesezeichen erlaubt sind, muss folgende Interface-Methoden implementieren. Das Interface stellt Methoden zur Verfügung, um die Lesezeichen eines Teilarchivdokuments zu setzen und zu entfernen sowie benötigte Informationen der gesetzten Lesezeichen abzufragen.
|
Interface-Methode |
Beschreibung |
|
boolean hasBookmark() |
Gibt an, ob ein Teilarchivobjekt des Archivobjekts Lesezeichen enthält. |
|
boolean hasBookmark (int partIndex) |
Gibt an, ob das Teilarchivobjekt mit dem Index <partIndex> (0-basiert) Lesezeichen enthält. |
|
boolean hasBookmark (int partIndex, int pageIndex) |
Gibt an, ob das Teilarchivobjekt mit dem Index <partIndex> (0-basiert) auf der Seite <pageIndex> (1-basiert) ein Lesezeichen enthält. |
|
void addBookmark (Bookmark bookmark, boolean changedByUser) |
Fügt ein Lesezeichen zu dem Archivobjekt hinzu. Das Flag <changedByUser> gibt an, ob das Lesezeichen vom Benutzer geändert wurde. |
|
Bookmark removeBookmark (int partNumber, int pageNumber, boolean changed) |
Entfernt ein Lesezeichen aus dem Teilarchivobjekt mit dem Index <partIndex> (0-basiert) auf der Seite <pageIndex> (1-basiert). Das Flag <changedByUser> gibt an, ob das Lesezeichen vom Benutzer geändert wurde. |
|
void initBookmarks (Collection<Bookmark> bookmarks) |
Dient zur Initialisierung einer Collection von Lesezeichen |
|
Collection<Bookmark> getBookmarks(int partNum) |
Liefert eine Collection von Lesezeichen zu dem Teilarchivobjekt mit dem Index <partIndex> (0-basiert) zurück. |
|
boolean areBookmarksChanged() |
Gibt an, ob in dem Archivobjekt Lesezeichen geändert wurden. |
|
Bookmark getFirstBookmark() |
Gibt das erste Lesezeichen innerhalb des Archivobjekts zurück. |
|
Bookmark
getPreviousBookmark |
Gibt das vorige Lesezeichen innerhalb des Archivobjekts zurück, ausgehend von dem Teilarchivobjekt mit dem Index <partIndex> (0-basiert) und der Seite <pageIndex> (1-basiert). |
|
Bookmark
getNextBookmark |
Gibt das nächste Lesezeichen innerhalb des Archivobjekts zurück, ausgehend von dem Teilarchivobjekt mit dem Index <partIndex> (0-basiert) und der Seite <pageIndex> (1-basiert). |
|
Bookmark getLastBookmark() |
Gibt das letzte Lesezeichen innerhalb des Archivobjekts zurück. |