CIB doXiview - Toolbar Konfiguration

Site: CIB eLearning
Course: CIB doXiview
Book: CIB doXiview - Toolbar Konfiguration
Printed by: Guest user
Date: Wednesday, 26 January 2022, 10:10 PM

Konfiguration der Toolbar

In CIB doXiview können die verfügbaren Schaltflächen, sowie deren Position innerhalb der Toolbar konfiguriert werden. Der Aufbau der Toolbar wird dabei durch eine XML-Datei definiert, welche in WEB-INF\classes\toolbar-config abgelegt wird. Der Name der Datei muss dem Schema ui.<confName>.xml folgen (<confName> muss durch einen eigenen, beliebigen Bezeichner ersetzt werden).

Die Toolbar kann in mehrere Gruppen aufgeteilt werden, welche unterschiedlich ausgerichtet werden können (links / mittig / rechts). Jede Gruppe kann mehrere Toolbar-Elemente (Schaltflächen und Widgets), sowie weitere Untergruppen enthalten. Widgets sind im Gegensatz zu einfachen Schaltflächen komplexe Elemente, welche wiederum aus einzelnen Schaltflächen bestehen, jedoch als ganze Einheit in die Toolbar eingefügt werden.

Untergruppen haben keine eigene Ausrichtung. Sie dienen lediglich der Gruppierung von logisch zusammenhängenden Schaltflächen wie den Zoom- oder Rotations-Schaltflächen.


Aufbau der Konfiguration

Allgemein
toolbar-config
direction
groups
group
elements
element
composite-element


Allgemein

Die XML-Strukture basiert auf folgenden Tags:

XML-Tag

Beschreibung

toolbar-config

Root-Tag

direction

Gibt die Richtung der Toolbar an.

groups

Zusammenfassung mehrerer Gruppen.

group

Eine Gruppe.

elements

Zusammenfassung mehrerer Toolbar-Elemente.

element

Ein einzelnes Toolbar-Element.

composite-element

Zusammenfassung mehrerer Toolbar-Elemente, die logisch zusammengehören.

 

Beispielhafter Aufbau der Konfiguration:

<toolbar-config>
<direction>HORIZONTAL</direction>
<groups>
<group id="main" alignment="first">
<elements>
<element id="print"/>
<composite-element id="zoom">
<elements>
<element id="zoom-out"/>
<element id="zoom-in"/>
</elements>
</composite-element>
</elements>
</group>
</groups>
</toolbar-config>


toolbar-config

Das Wurzel-Element der Konfiguration.

Kind-Elemente:

direction, groups


direction

Beschreibt die Richtung der Toolbar. Prinzipiell sind die Werte HORIZONTAL und VERTICAL erlaubt. Da die Haupt-Toolbar von CIB doXiview jedoch nur horizontal verfügbar ist, ist hier stets HORIZONTAL zu setzen.

Erlaubte Werte:

HORIZONTAL


groups

Fasst mehrere Gruppen zusammen.

Kind-Elemente:

group


group

Eine Gruppe von Toolbar-Elementen.

Kind-Elemente:

group

Attribute:

id

Ein eindeutiger Bezeichner der Gruppe

 

alignment

Gibt an, wie die Gruppe innerhalb der Toolbar ausgerichtet werden soll.
Mögliche Werte: first, middle, last
(links, mittig, rechts)


elements

Fasst mehrere Toolbar-Elemente zusammen.

Kind-Elemente:

element, composite-element


element

Ein einzelnes Toolbar-Element wie etwa eine Schaltfläche oder ein Widget.

Attribute:

id

Der Bezeichner der Schaltfläche.


composite-element

Fasst mehrere Toolbar-Elemente, die logisch zusammengehören zu einer Untergruppe zusammen. Es enthält ähnlich wie eine Gruppe mehrere Toolbar-Elemente, die wiederum durch elements zusammengefasst werden.

Kind-Elemente:

elements

Attribute:

id

Ein eindeutiger Bezeichner der Untergruppe.


Verfügbare Schaltflächen

Nachfolgend sind alle Schaltflächen mit der zugehörigen ID und einer kurzen Beschreibung aufgelistet.

Toolbar-Schaltflächen
Archiv-Toolbar-Schaltflächen
Sign-Toolbar-Schaltflächen
Widgets

Toolbar-Schaltflächen

Id

CIB Icon

Beschreibung

file-upload

Schaltfläche zum Hochladen einer Datei.

print

Schaltfläche zum Drucken eines Dokuments.

export-original


Schaltfläche zum Speichern des Original Dokuments.

export-pdf


Schaltfläche zum Speichern des Dokuments als PDF Datei.

share


Schaltfläche zum Weiterleiten des Dokuments.

fit-page-height


Schaltfläche um die aktuelle Seite in voller Höhe anzuzeigen.

fit-page-width


Schaltfläche um die aktuelle Seite in voller Breite anzuzeigen.

fit-page


Schaltfläche um die komplette Seite anzuzeigen.

rotate-anticlockwise


Schaltfläche zum Rotieren der aktiven Seite gegen den Uhrzeigersinn.

rotate-180-degree


Schaltfläche zum Rotieren der aktiven Seite um 180 Grad.

rotate-clockwise


Schaltfläche zum Rotieren der aktiven Seite im Uhrzeigersinn.

enter-reading-mode


Schaltfläche zum Aktivieren des Lesemodus.

exit-reading-mode


Schaltfläche zum Verlassen des Lesemodus.

enter-presentation-mode


Schaltfläche zum Aktivieren des Präsentationsmodus.

exit-presentation-mode


Schaltfläche zum Verlassen des Präsentationsmodus.

close


Schaltfläche zum Schließen von CIB doXiview.

archive-close


Schaltfläche zum Schließen des Archiv-Modus.

info


Schaltfläche zum Aufrufen der Produkt-Webseite von CIB doXiview.

help


Schaltfläche zum Anzeigen zusätzlicher Informationen über CIB doXiview.

toggle-checkmasks


Schaltfläche zum Anzeigen / Ausblenden der Prüfschablonen.

zoom-in


Schaltfläche zum Erhöhen der Zoom-Stufe.

zoom-out


Schaltfläche zum Verringern der Zoom-Stufe.

correspondence-save


Schaltfläche zum Speichern der Änderungen im Editiermodus.

correspondence-close


Schaltfläche zum Schließen von CIB doXiview im Editiermodus.

highlight-formfields


Schaltfläche zum Anzeigen / Entfernen von Formularfeldern.

update-document-version


Schaltfläche zum Speichern der Änderungen.

update-document-version-and-close


Schaltfläche zum Speichern der Änderungen und anschließendem Schließen der Anwendung.


Archiv-Toolbar-Schaltflächen

Id

CIB Icon

Beschreibung

archive-save

Schaltfläche zum Speichern von Änderungen im Archiv

archive-export


Schaltfläche zum Herunterladen eines Archiv-Dokuments.

archive-load-next


Schaltfläche zum Laden des nächsten Archiv-Objekts.

archive-load-previous


Schaltfläche zum Laden des vorherigen Archiv-Objekts.


Sign-Toolbar-Schaltflächen

Id

CIB Icon

Beschreibung

sign


Schaltfläche zum Unterschreiben des aktuellen Dokuments.

sign-undo


Schaltfläche um die letzte Unterschrift rückgängig zu machen.


Widgets

Id

CIB Icon

Beschreibung

page-navigation

N/A

Widget um durch die Seiten zu navigieren

bookmark-navigation

N/A

Widget um durch die Lesezeichen zu navigieren

annotation-navigation

N/A

Widget um durch die annotierten Seiten zu navigieren

document-navigation

N/A

Widget um durch die Teildokumente zu navigieren

search

N/A

Widget zum durchsuchen des Dokuments

mouse-tool-combo

N/A

Widget zum Selektieren eines Mauswerkzeugs.


Anwenden der Konfiguration

Um die Toolbar entsprechend der Konfiguration anzuzeigen, muss beim Start von CIB doXiview der Name der Konfiguration (<confName>) in den Start-Parametern gesetzt werden (siehe Dokumentation CIB doXiview Startparameter.docx Abschnitt UI Modi).


Toolbar für Mobilgeräte

Für Mobilgeräte kann eine separate Toolbar konfiguriert werden, da der Funktionsumfang von CIB doXiview auf Mobilgeräten stark eingeschränkt ist. Der Name der Toolbar Konfiguration wird dazu einfach mit dem Zusatz „-mobile“ versehen.

z.B.:
Desktop-Toolbar:           ui.test.xml
Mobile-Toolbar: ui.test-mobile.xml

Beim Aufruf von CIB doXiview muss keine explizite Unterscheidung vorgenommen werden. DoXiview prüft automatisch, ob für die angegebene Toolbar eine Mobile Version verfügbar ist, und verwendet diese ggf. Falls keine solche Konfiguration gefunden wurde, wird eine vordefinierte Standard-Konfiguration für Mobilgeräte verwendet. 

Folgende Schaltflächen und Widgets können in mobile Toolbar-Konfigurationen hinterlegt werden:

  • close
  • export-pdf
  • export-original
  • update-document-version
  • update-document-version-and-close