Package de.elo.client.scripting.interfaces

Class FlowConfirmDialogAdapter

  • public class FlowConfirmDialogAdapter
extends Object

    Überschrift: FlowConfirmDialogAdapter.

    Beschreibung: Kapselt einen FlowConfirmDialog gegenüber dem Script. Im Scripting verfügbar über "dialogs.getFlowConfirmDialog()".

    Copyright: Copyright (c) ELO Digital Office GmbH 2010-2014

    Since:
    7.00.010

    • Constructor Summary

      Constructors 
      Constructor Description
      FlowConfirmDialogAdapter​(Workspace workspace)
      Interner Konstruktor.

    • Method Summary

      Modifier and Type Method Description
      GridPanel addGridPanel​(int columns, int rows)
      Fügt ein zusätzliches Panel mit einem Tabellenlayout unterhalb der vorhandenen in den Dialog ein.
      String getComment()
      Liefert den im Feld "Bemerkung" eingegebenen Text zurück.
      WFNode getCurrentNode()
      Liefert den aktuellen Workflow-Knoten mit geänderten Werten (Name, Kommentar) zurück.
      int getFlowId()
      Liefert die Workflow-ID dieses Workflows.
      ObjKeyAdapter getObjKey​(int no)
      Liefert den Adapter für ein Indexfeld.
      ObjKeyAdapter getObjKey​(String name)
      Liefert den Adapter für ein Indexfeld.
      int[] getSelectedSuccessorIds()
      Liefert eine Liste mit den IDs der ausgewählten Nachfolgeknoten.
      WFNode[] getSelectedSuccessors()
      Liefert eine Liste der ausgewählten Nachfolgerknoten.
      Sord getSord()
      Liefert die ursprüngliche Verschlagwortung des Archiveintrags zurück.
      boolean isAvailable()
      Meldet zurück, ob derzeit ein FlowConfirmDialog(Dialog zum Weiterleiten von Workflows) im Scripting verfügbar ist.
      void pressCancel()
      Schließt den Dialog über den Button "Abbrechen".
      void pressOK()
      Schließt den Dialog über den Button "OK".
      boolean setActionButtonEnabled​(int actionButtonNr, boolean enabled)
      Setzt den Status des angegegbenen Aktion-Buttons und meldet zurück ob der Button aktualisiert wurde.
      void setObjKeyValue​(int no, String value)
      Setzt den Wert eines Indexfelds.
      void setObjKeyValue​(String name, String value)
      Setzt den Wert eines Indexfelds.
      void setSord​(Sord sord)
      Setzt die angegebene Verschlagwortung des Archiveintrags.
      void setStatusNormal​(String message)
      Setzt den Text in der Statuszeile und schaltet den Status auf "normal" (blaue Hintergrundfarbe, der Button "OK" ist aktiviert).
      void setStatusRed​(String message)
      Setzt den Text in der Statuszeile und schaltet den Status auf "Fehler" (rote Hintergrundfarbe, der Button "OK" ist deaktiviert).
      void setStatusYellow​(String message)
      Setzt den Text in der Statuszeile und schaltet den Status auf "unvollständig" (gelbe Hintergrundfarbe, der Button "OK" ist deaktiviert).

      • Methods inherited from class Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • FlowConfirmDialogAdapter

        public FlowConfirmDialogAdapter​(Workspace workspace)
        Interner Konstruktor.
        Parameters:
        workspace - Aktueller Arbeitsbereich

    • Method Detail

      • getCurrentNode

        public WFNode getCurrentNode()
        Liefert den aktuellen Workflow-Knoten mit geänderten Werten (Name, Kommentar) zurück.
        Returns:
        aktueller Workflow-Knoten
        Since:
        8.01.000

      • addGridPanel

        public GridPanel addGridPanel​(int columns,
                              int rows)
        Fügt ein zusätzliches Panel mit einem Tabellenlayout unterhalb der vorhandenen in den Dialog ein. In diesem Panel können Eingabefelder definiert und abgefragt werden.
        Parameters:
        columns - Anzahl der Spalten im Tabellenraster
        rows - Anzahl der Zeilen im Tabellenraster
        Returns:
        das eingefügte GridPanel
        Since:
        7.00.010

      • isAvailable

        public boolean isAvailable()
        Meldet zurück, ob derzeit ein FlowConfirmDialog(Dialog zum Weiterleiten von Workflows) im Scripting verfügbar ist.
        Returns:
        True wenn der Dialog benutzt werden kann, False wenn derzeit kein Dialog im Client vorhanden ist
        Since:
        7.00.010

      • pressCancel

        public void pressCancel()
        Schließt den Dialog über den Button "Abbrechen".
        Since:
        7.00.010

      • pressOK

        public void pressOK()
        Schließt den Dialog über den Button "OK".
        Since:
        7.00.010

      • getSelectedSuccessorIds

        public int[] getSelectedSuccessorIds()
        Liefert eine Liste mit den IDs der ausgewählten Nachfolgeknoten.
        Returns:
        Array mit den IDs
        Since:
        7.00.014

      • getSelectedSuccessors

        public WFNode[] getSelectedSuccessors()
        Liefert eine Liste der ausgewählten Nachfolgerknoten. Diese dürfen nur gelesen und nicht verändert werden.
        Returns:
        Array der ausgewählten Nachfolger
        Since:
        8.01.000

      • getComment

        public String getComment()
        Liefert den im Feld "Bemerkung" eingegebenen Text zurück.
        Returns:
        Bemerkungstext
        Since:
        8.01.000

      • getSord

        public Sord getSord()
        Liefert die ursprüngliche Verschlagwortung des Archiveintrags zurück.
        Returns:
        Verschlagwortung des Archiveintrags
        Since:
        9.01.000

      • setActionButtonEnabled

        public boolean setActionButtonEnabled​(int actionButtonNr,
                                      boolean enabled)
        Setzt den Status des angegegbenen Aktion-Buttons und meldet zurück ob der Button aktualisiert wurde.
        Parameters:
        actionButtonNr - Nummer des Aktion-Buttons
        enabled - Button aktivieren
        Returns:
        Button wurde aktualisiert
        Since:
        9.01.000

      • setStatusNormal

        public void setStatusNormal​(String message)
        Setzt den Text in der Statuszeile und schaltet den Status auf "normal" (blaue Hintergrundfarbe, der Button "OK" ist aktiviert).
        Parameters:
        message - Text, welcher in der Statuszeile angezeigt werden soll
        Since:
        9.01.000

      • setStatusRed

        public void setStatusRed​(String message)
        Setzt den Text in der Statuszeile und schaltet den Status auf "Fehler" (rote Hintergrundfarbe, der Button "OK" ist deaktiviert).
        Parameters:
        message - Text, welcher in der Statuszeile angezeigt werden soll
        Since:
        9.01.000

      • setStatusYellow

        public void setStatusYellow​(String message)
        Setzt den Text in der Statuszeile und schaltet den Status auf "unvollständig" (gelbe Hintergrundfarbe, der Button "OK" ist deaktiviert).
        Parameters:
        message - Text, welcher in der Statuszeile angezeigt werden soll
        Since:
        9.01.000

      • getObjKey

        public ObjKeyAdapter getObjKey​(int no)
        Liefert den Adapter für ein Indexfeld.
        Parameters:
        no - Nummer des Indexfelds, ACHTUNG: Zählung beginnt hier bei 0
        Returns:
        ObjKeyAdapter oder null, falls das Indexfeld nicht gefunden wurde.
        Since:
        9.02.000

      • getObjKey

        public ObjKeyAdapter getObjKey​(String name)
        Liefert den Adapter für ein Indexfeld.
        Parameters:
        name - Gruppen-Name des Indexfelds, ACHTUNG: Diese Auswahl ist nicht eindeutig, bei mehreren Indexfeldern mit diesem Namen wird die erste benutzt.
        Returns:
        ObjKeyAdapter oder null, falls das Indexfeld nicht gefunden wurde.
        Since:
        9.02.000

      • setObjKeyValue

        public void setObjKeyValue​(String name,
                           String value)
                    throws Exception
        Setzt den Wert eines Indexfelds.
        Parameters:
        name - Gruppen-Name des Indexfelds, ACHTUNG: Diese Auswahl ist nicht eindeutig, bei mehreren Indexfeldern mit diesem Namen wird die erste benutzt.
        value - Der zu setzende Wert des Indexfelds. Um einen Spaltenindes zu verwenden, müssen die Werte durch ein Pilcrow (¶) getrennt sein.
        Throws:
        Exception - Wenn das Indexfeld nicht gefunden wird.

      • setObjKeyValue

        public void setObjKeyValue​(int no,
                           String value)
                    throws Exception
        Setzt den Wert eines Indexfelds.
        Parameters:
        no - Nummer des Indexfelds, ACHTUNG: Zählung beginnt hier bei 0
        value - Der zu setzende Wert des Indexfelds. Um einen Spaltenindes zu verwenden, müssen die Werte durch ein Pilcrow (¶) getrennt sein.
        Throws:
        Exception - Wenn das Indexfeld nicht gefunden wird.
        Since:
        9.02.000

      • setSord

        public void setSord​(Sord sord)
        Setzt die angegebene Verschlagwortung des Archiveintrags.
        Parameters:
        sord - Verschlagwortung des Archiveintrags
        Since:
        9.02.000

      • getFlowId

        public int getFlowId()
        Liefert die Workflow-ID dieses Workflows.
        Returns:
        Workflow-ID
        Since:
        9.02.000