Allgemein

Das Interface toolbar dient der Manipulation von Toolbar-Schaltflächen.

Es ist aus Sicht des Masters in Form des Objekts CibMasterToolbarFunctions verfügbar.

Es ist möglich, dass der Master eigene Schaltflächen in die CIB doXiview Toolbar einbettet. CIB doXiview kann die Master-Anwendung darüber informieren, wenn der Benutzer auf eine solche Schaltfläche geklickt hat. Darüber hinaus ist es möglich, für alle Schaltflächen der Haupt-Toolbar die folgenden Zustände zu beeinflussen: aktiviert, deaktiviert, sichtbar, unsichtbar.

Bei der Integration von Schaltflächen in die CIB doXiview Toolbar ist wie folgt vorzugehen.

1. Das Icon der Schaltfläche wird fest in der css-Definition von CIB doXiview hinterlegt und wird nicht über das Client-seitige Interface übergeben. Es wird hier nur über eine css-Id referenziert. Wird ein individuelles Icon benötigt, muss dies also schon beim Deployment von CIB doXiview hinterlegt werden.
2. In den Startparametern müssen die Schaltflächen übergeben werden, die in der CIB doXiview Toolbar integriert werden sollen.
3. Es ist möglich, nach Auslösen von Benutzerereignissen die Schaltflächen über definierte Schnittstellen zu verändern, z. B. deaktivieren.

Definition von Schaltflächen in den Startparametern:

CIB doXiview fragt die hinzuzufügenden Schaltflächen in den Startparametern ab, damit der Master nicht prüfen muss, wann CIB doXiview vollständig initialisiert ist. CIB doXiview fügt dann auf Basis der Startparametereinträge die Schaltflächen eigenständig hinzu.

Aufbau des Startparameters für die Schaltflächendefinitionen:

toolbar: {
    buttons: [{           
        buttonId: String: the buttons id,           
        buttonLabel: String: the buttons label (may be displayed in menus),           
        cssId: String: the buttons css id,           
        tooltip: String: the buttons tooltip,           
        isEnabled: boolean: whether or not the button should be enabled,
        isVisible: boolean: whether or not the button should be visible,           
        group: String: the buttons group,           
        groupIndex: <optional> int: group position if it has to be created,           
        index: int: the buttons index within its group,           
        buttonGroup: <optional> String: the buttons composite group,     
    }, {            
        ...second button definition     
    }]
}

toolbarButtonPressed

Diese Funktion wird lediglich für eine Anpassung der Toolbar benötigt.

Wenn der Master eigene Schaltflächen in die CIB doXiview Toolbar integriert hat, wird er über die Funktion toolbarButtonPressed darüber informiert, welche Schaltfläche vom Benutzer betätigt wurde.

toolbarButtonPressed

buttonId: String

void

master.toolbar.registerButtonPressedCallback(callback: FunctionCallback);

Hinweis: In der Testoberfläche kann dieser Aufruf von CIB doXiview an den Master nachvollzogen werden:

1. Selektieren Sie den Modus Sign (Pdf)
2. In dem Bereich Toolbar Configuration wählen Sie Sign aus.
3. Öffnen Sie CIB doXiview
4. Die ersten zwei Schaltflächen in der Toolbar sind nun die vom Master eingefügten Schaltflächen: 
5. Klicken Sie auf eine der beiden Schaltflächen.
6. In der Browser-Konsole erscheint der JavaScript-Aufruf:

2015-01-19 14:22:59,237 [INFO ] OUTER: toolbarButtonPressed(params: {"buttonId":"sign-button"})

updateButton

Diese Funktion wird lediglich für eine Anpassung der Toolbar benötigt.

Schaltflächen können mit der Funktion updateButton unter Angabe der buttonId zur Laufzeit verändert werden. Dabei können eingestellt werden:

• Css-Id
• Tooltip
• Aktivierungszustand
• Sichtbarkeit

updateButton

params: JSON

void

        {
                  buttonId: the external id of the button,
                  cssId: the CSS id of the button (for appearance),
                  tooltip: the tooltip of the button,
                  isEnabled: whether or not the button should be enabled,
                  isVisible: whether or not the button should be visible
          }

slave.toolbar.registerToolbarCallback(toolbar.updateButton=function(params));

Hinweis: In der Testoberfläche kann der Aufruf vom Master an CIB doXiview nachvollzogen werden:

1. Selektieren Sie den Modus Sign (Pdf)
2. In dem Bereich Toolbar Configuration wählen Sie Sign aus.
3. Öffnen Sie CIB doXiview
4. In dem Reiter Runtime Manipulation unter Toolbar control können Sie nun mit dem Button Id Wert sign-button die Eigenschaften für diese Schaltfläche etwa wie folgt eingeben. Klicken Sie anschließend auf Test.

setEnabled

Diese Funktion wird lediglich für eine Anpassung der Toolbar benötigt.

Soll nur der Aktivierungszustand einer Schaltfläche verändert werden, kann der Master die Funktion setEnabled aufrufen.

setEnabled

buttonId: String
enable: boolean

void

slave.toolbar.registerToolbarCallback(toolbar.setEnabled=function(params));

setVisible

Diese Funktion wird lediglich für eine Anpassung der Toolbar benötigt.

Soll nur der Sichtbarkeitszustand einer Schaltfläche verändert werden, kann der Master die Funktion setVisible aufrufen.

setVisible

buttonId: String
isVisible: boolean

void

slave.toolbar.registerToolbarCallback(toolbar.setVisible=function(params));

setTooltip

Diese Funktion wird lediglich für eine Anpassung der Toolbar benötigt.

Soll nur der Tooltip verändert werden, kann der Master die Funktion setTooltip aufrufen.

setTooltip

buttonId: String
tooltip: String

void

slave.toolbar.registerToolbarCallback(toolbar.setTooltip=function(params));

triggerButton

Diese Funktion wird lediglich für eine Anpassung der Toolbar benötigt.

Mit der Funktion triggerButton kann der Master den Klick auf eine Schaltfläche auslösen.

triggerButton

buttonId: String

void

slave.toolbar.registerToolbarCallback(toolbar.triggerButton=function(params));

Hinweis: In der Testoberfläche kann dieser Aufruf durch den Master nachvollzogen werden:

1. Selektieren Sie den Modus Sign (Pdf)
2. In dem Bereich Toolbar Configuration wählen Sie Sign aus.
3. Öffnen Sie CIB doXiview
4. Wählen Sie auf dem Reiter Runtime manipulation unter Toolbar control in der Drop-Down-Liste Trigger aus.
5.  Belegen Sie Button Id mit sign-button und klicken Sie auf Test

setToggleButtonState

Diese Funktion wird lediglich für eine Anpassung der Toolbar benötigt.

Mit dieser Funktion können sogenannte Toggle-Buttons beeinflusst werden. Dies sind Buttons mit den Zuständen gedrückt und nicht gedrückt.

setToggleButtonState

buttonId: String
pressed: boolean

void

slave.toolbar.registerToolbarCallback(toolbar.toggleButton=function(params));