Tools

Tools sind Erweiterungen der PageView, die über den ToolManager verwaltet werden. Die Tools werden grundsätzlich analog der jadice document platform 5 verwendet (siehe Abschnitt "Tools").

Einschränkungen/Unterschiede:

• Die Tool-Klassen des jadice web toolkit stellen eigenständige Implementierungen dar und sind deshalb in einem anderen Package (com.levigo.jadice.web.client.tools) abgelegt.

• Anstelle des Graphics2d wird ein Webgraphics/HTML5Canvas verwendet.

AnnotationTool

Die Erstellung und Bearbeitung von Annotationen wird über das AnnotationTool gesteuert.

Standardmäßig erlaubt das Tool, mehrere Annotationen gleichzeitig zu selektieren. Falls keine Mehrfachselektion gewünscht ist, kann das Tool über die Methode setSingleSelectionMode(true) in den Modus für einfache Selektion versetzt werden.

Details zur Integration und die zugehörigen Codebeispiele finden sich in den Showcases unter "Annotations".

DoubleTapZoomTool

Mit Hilfe des DoubleTapZoomTool kann durch schnelles zweifaches Tippen auf den Bildschirm auf Seitenbreite gezoomt werden.

GridTool

Um ein dem aktuellen Dokument vorab hinzugefügtes Grid zu visualisieren, kann das GridTool verwendet werden. Linienfarbe und -stärke sind dabei über das Tool konfigurierbar.

Details zur Integration und die zugehörigen Codebeispiele finden sich in den Showcases unter "Annotations -> Grid Positioning".

KeyboardNavigationTool

Das KeyboardNavigationTool dient zur Navigation im Dokument. Über die Pfeiltasten lässt sich im aktuell dargestellten Dokument intuitiv ein kleines bisschen nach oben, unten, rechts, links navigieren.

HoverLensTool

Um einzelne Stellen eines Dokuments zu vergrößern, ohne dabei den Überblick zu verlieren, kann mittels des HoverLensTools eine Lupe auf der aktuellen Seite eingeblendet werden. Mit Linksklicks wird der Zoomfaktor innerhalb der Lupe erhöht, mit Rechtsklicks wird der Zoomfaktor verringert.

Form, Größe und initialer Zoomfaktor der Lupe sind dabei über das Tool konfigurierbar, genauso wie die Größe der schrittweisen Zoomfaktor-Veränderung bei Rechts- und Linksklicks. Zusätzlich kann die Lupe mit der Kombination Strg + Linksklick auf der aktuellen Position fixiert werden.

Details zur Integration und die zugehörigen Codebeispiele finden sich in den Showcases unter "Tools -> HoverLensTool Examples".

PanForceTools

Mit Hilfe der PanForceTools kann durch das Dokument gescrollt werden. Das Tool ist in zwei Ausprägungen vorhanden. Für das Scrollen mit der Maus muss das PanForceMouseTool in den ToolManager eingehängt werden; zum Scrollen über Touch-Eingaben das PanForceTouchTool. Natürlich können auch beide Tools gleichzeitig eingesetzt werden.

SelectPageTool

Das SelectPageTool ermöglicht die Mehrfachauswahl von Seiten über die ThumbnailView. Es wird sowohl für das Markieren einzelner Seiten, als auch für das Verschieben von Seiten via Drag&Drop in der ThumbnailView verwendet. Das Tool kann ausschließlich in Kombination mit der ThumbnailView und nicht mit der Standard-PageView verwendet werden. Aus diesem Grund wird es - im Unterschied zu diversen anderen Tools - folgendermaßen am ToolManager der ThumbnailView registriert: ThumbnailPageView.getToolManager().register(SelectPageTool.class, true);

TextSelectionTools

Für die Textselekion gibt es wie bei den Scroll-Tools zwei Ausprägungen. Wird das TextSelectionTool in den ToolManager einghängt, so kann über Mauseingaben Text selektiert werden. Um über Touch-Eingaben Text zu selektieren, wird das TextSelectionTouchTool benötigt. Für den Betrieb dieses Tools ist es nötig, dass das HighlightTool im ToolManager registriert ist.

TwoFingerGestureTool

Das TwoFingerGestureTool bietet verschiedene Funktionalitäten für Zwei-Finger-Touch-Gesten. Wird das Tool einkonfiguriert, kann über Zwei-Finger-Gesten gedreht, gescrollt und gezoomt werden. Das Tool bietet zusätzlich über die Methoden disableZoom(), disableScroll(), disableRotate() die Möglichkeit, einzelne Funktionalitäten zu deaktivieren.

VisibleBoundsTool

Das VisibleBoundsTool hebt den aktuell sichtbaren Bereich einer Seite in der Thumbnail-Ansicht hervor. Die Farbe dieses Tools können über eine GSS-Datei konfiguriert werden.

 @def PAGE_BOUNDS_BORDER_WIDTH 2; // Breite des Seitenrandes
 @def VISUAL_BOUNDS_BORDER_WIDTH 1; // Breite des Randes um den sichtbaren Bereich
 @def PAGE_BOUNDS_BORDER_COLOR #666565; // Farbe des Seitenrandes
 @def PAGE_VISUAL_BOUNDS_INTERSECTION_FILL_COLOR rgba(102,101,101,0.5); // Farbe des Bereiches zwischen Seitenrand und sichtbarem Bereichsrand
 @def VISUAL_BOUNDS_FILL_COLOR rgba(0,0,0,0); // Farbe des sichtbaren Bereiches
 @def VISUAL_BOUNDS_BORDER_COLOR #666565; // Farbe des Randes um den sichtbaren Bereich

AreaSelectionTool

Das AreaSelectionTool ermöglicht die Auswahl eines Bereiches. Nach der Selektion des Bereichs erscheint eine Toolbar mit registrierten Funktionen, die auf den Bereich angewendet werden können. Alternativ kann eine Standard-Aktion direkt ausgeführt werden

Als ersten Anwendungsfall für dieses Tool wurde das OCR-Addon für das Webtoolkit implementiert. Mehr Informationen zum Einsatz des Tools sind auch in der Dokumentation des OCR Addons zu finden.

LinkTool

Das LinkTool ermöglicht es, Links in Dokumenten anzuklicken. Der Benutzer bekommt dann ein Popup angezeigt, in welchem er auswählen kann, ob der Link in einem neuen Tab geöffnet werden soll. Intern sind Links über unsere Instructions-API abgebildet. Weitere Informationen zu dieser API finden sich in der Dokumentation des Instructions Addons.

CrossHairTool

Das CrossHairTool erzeugt ein Fadenkreuz auf dem Dokument um beispielsweise besser in Tabellen navigieren zu können.

GridTool

Visualisiert ein dem Dokument zugeordnetes Raster auf der Seite mit konfigurierbarer Farbe und Linienbreite. Das Gitter wird im DOCP-Koordinatensystem gerendert und reagiert dynamisch auf Änderungen der Grid-Eigenschaften des Dokuments. Unterstützt optionale Grid-Bounds-Einschränkung.

HighlightTool

Rendert farbige Hervorhebungen (Highlights) auf Dokumentseiten anhand von Schlüssel-Farben-Zuordnungen. Wird intern von TextSelectionTool und Suchwerkzeugen zur Visualisierung verwendet. Hervorhebungen können nach Schlüssel hinzugefügt oder entfernt werden.

MouseWheelScrollTool

Scrollt den Dokumentinhalt beim Drehen des Mausrads ohne Modifier-Tasten. Im Einzelseiten-Layout wird am Seitenanfang/-ende automatisch zur angrenzenden Seite navigiert. Das automatische Seitenwechsel-Verhalten ist konfigurierbar.

MouseWheelZoomTool

Zoomt den Dokumentinhalt beim Mausrad-Drehen mit gedrückter Ctrl- oder Alt-Taste. Jede Einheit ändert den Zoom um ca. 10 % relativ zum aktuellen Zoomfaktor. Der Zoom erfolgt auf den aktuellen Mauszeiger-Punkt und die aktuelle Seite wird dabei gesetzt.

PDFSignatureBoxTool

Zeigt ein animiertes Informations-Panel für PDF-Signaturen am oberen Rand des Viewers. Das Panel erscheint automatisch, wenn im Dokument Signaturfelder erkannt werden, und zeigt Name, Datum und Uhrzeit des letzten Unterzeichners an. Es kann manuell geschlossen werden.

PointerScrollTool

Ermöglicht das Scrollen per Pointer-Events (z. B. Stift oder Finger auf Desktop-Browsern). Ist inaktiv, wenn das AnnotationTool aktiv oder das CrossHairTool aktiviert ist. Verfolgt die Startposition und scrollt entsprechend der Zeigerbewegung.

PopupMenuTool

Zeigt ein Kontextmenü bei einem Rechtsklick (Popup-Trigger) an. Sammelt Menübeiträge von allen registrierten Tools und der ViewComponent. Blendet das Menü automatisch bei einem Dokumentwechsel aus.

RedactAllTool

Sucht den selektierten im gesamten Dokument und erstellt für jedes Ergebnis eine TextMask-Annotation (Schwärzung). Führt eine serverseitige Volltext-Suche durch und verarbeitet die Ergebnisse asynchron.

RedactSingleTool

Schwärzt nur die aktuell per TextSelectionTool ausgewählten Textstellen durch TextMask-Annotationen. Erstellt für jede Selektion eine eigene CreateTextMaskAnnoCommand-Instanz. Zeigt einen Menüeintrag im Kontextmenü an, wenn Text in der Zwischenablage vorhanden ist.

ThumbnailTool

Zeigt eine animierte Seitenvorschau-Leiste (ThumbnailView) am unteren Rand des PageView. Die Leiste erscheint bei Mausbewegung am Rand und kann fixiert ("angeheftet") werden. Erstellt intern einen vollständigen Viewer mit eigenem ToolManager.