CIB jView archive technischer Leitfaden
4. Schnittstellendefinitionen
4.6. Interface AnnotationBrowsable
Dieses Interface aus dem Archive-API definiert die Schnittstelle von Archivobjekten, bei denen zwischen Seiten mit Annotationen navigiert werden kann.
Jedes Archivobjekt, bei dem zwischen annotierten Seiten navigiert werden kann, muss folgende Interface-Methoden implementieren. Das Interface stellt Methoden zur Verfügung, um zwischen den Seiten eines Teilarchivdokuments, die Annotationen enthalten, zu navigieren sowie benötigte Informationen zu annotierten Archivobjekten abzufragen.
|
Interface-Methode |
Beschreibung |
|
boolean hasAnnotatedParts() |
Gibt an, ob ein Teilarchivobjekt des Archivobjekts Annotationen enthält. |
|
boolean isAnnotatedPart(int partNum) |
Gibt an, ob das Teilarchivobjekt mit dem Index <partNum> (0-basiert) Annotationen enthält. |
|
void addAnnotatedPart(int partNum) |
Fügt zu dem Teilarchivobjekt mit dem Index <partNum> (0-basiert) Informationen hinzu. Kann während der Initialisierung verwendet werden. |
|
void removeAnnotatedPart(int partNum) |
Entfernt von dem Teilarchivobjekt mit dem Index <partNum> (0-basiert) Informationen. Kann während der Initialisierung verwendet werden. Wird auch auf aufgerufen, wenn der Benutzer annotierte Seiten innerhalb der Archivanwendung ändert. |
|
void
initAnnotatedParts |
Dient zur Initialisierung einer Collection von annotierten Teilarchivobjekten. |
|
Collection<Integer> getAnnotatedParts() |
Gibt eine Collection aller annotierten Teilarchivobjekte zurück. |
|
int getFirstAnnotatedPart() |
Gibt den Index des ersten annotierten Teilarchivobjekts innerhalb des Archivobjekts zurück. |
|
int getPreviousAnnotatedPart |
Gibt den Index des vorigen annotierten Teilarchivobjekts zurück, ausgehend von dem Teilarchivobjekt mit dem Index <partIndex> (0-basiert) und der Seite <pageIndex> (1-basiert). |
|
int getNextAnnotatedPart(int partNum) |
Gibt den Index des nächsten annotierten Teilarchivobjekts zurück, ausgehend von dem Teilarchivobjekt mit dem Index <partIndex> (0-basiert) und der Seite <pageIndex> (1-basiert). |
|
int getLastAnnotatedPart() |
Gibt den Index des letzten annotierten Teilarchivobjekts innerhalb des Archivobjekts zurück. |