Package de.elo.client.scripting.dialog

Class GridDialog

  • public class GridDialog
extends Object

    Überschrift: GridDialog

    Beschreibung: Ein Dialog mit einem Layout-Raster. Dieser kann im Internen Scripting zur einfachen Erstellung komplexerer Dialoge benutzt werden.

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

    • Constructor Detail

      • GridDialog

        public GridDialog​(Workspace workspace,
                  int columns,
                  int rows,
                  String title)
        Konstruktor für die Klasse "GridDialog".
        Parameters:
        workspace - Aktueller Arbeitsbereich
        columns - Anzahl der Spalten im Tabellenraster
        rows - Anzahl der Zeilen im Tabellenraster
        title - Dialogtitel
        Since:
        7.00.004

    • Method Detail

      • setDialogId

        public void setDialogId​(String id)
        Setzt einen eindeutiger Bezeichner für diesen Dialog, damit die automatisch vom Client gespeicherten Größenänderungen sich bei mehreren Dialogen nicht überschreiben.
        Parameters:
        id - Eindeutiger Bezeichner für diesen Dialog
        Since:
        7.00.008

      • getMostRecentFocusOwner

        public Component getMostRecentFocusOwner()
        Liefert das Control zurück, welches zuletzt den Fokus hatte. Das kann für Event-Funktionen wichtig sein, die den Fokus weggezogen haben (z.B. Button Click) und wissen müssen, wer zuvor im Dialog aktiv war.
        Returns:
        Dialog-Komponente oder null
        Since:
        10.00.000

      • hideOkButton

        public void hideOkButton()
        Blendet den Ok Button aus

      • hideAbortButton

        public void hideAbortButton()
        Blendet den Abbruch Button aus. Der Dialog kann aber immer noch über [x] im Window Header abgebrochen werden.

      • addComponent

        public void addComponent​(int x,
                         int y,
                         int w,
                         int h,
                         Component comp)
        Deprecated.
        Ersetzt durch getGridPanel() und GridPanel.addComponent(int, int, int, int, Component)
        Fügt eine Standard-Java Komponente (AWT/Swing) in den Dialog ein.
        Parameters:
        x - X-Position im Raster (Spalte), Zählung beginnt hier bei 1
        y - Y-Position im Raster (Zeile), Zählung beginnt hier bei 1
        w - Breite der Komponente im Raster
        h - Höhe der Komponente im Raster
        comp - die grafische Komponente
        Since:
        7.00.010

      • addLabel

        public Label addLabel​(int x,
                      int y,
                      int w,
                      String text)
        Deprecated.
        Ersetzt durch getGridPanel() und GridPanel.addLabel(int, int, int, String)
        Erzeugt einen Text (Label) und fügt ihn an der angegebenen Stelle in den Dialog ein.
        Parameters:
        x - X-Position im Raster (Spalte), Zählung beginnt hier bei 1
        y - Y-Position im Raster (Zeile), Zählung beginnt hier bei 1
        w - Breite des Labels im Raster
        text - der anzuzeigende Text
        Returns:
        das erzeugte Label-Objekt
        Since:
        7.00.004

      • addTextArea

        public TextArea addTextArea​(int x,
                            int y,
                            int w,
                            int h)
        Deprecated.
        Ersetzt durch getGridPanel() und GridPanel.addTextArea(int, int, int, int)
        Erzeugt ein mehrzeiliges Textfeld (TextArea) und fügt ihn an der angegebenen Stelle in den Dialog ein.
        Parameters:
        x - X-Position im Raster (Spalte), Zählung beginnt hier bei 1
        y - Y-Position im Raster (Zeile), Zählung beginnt hier bei 1
        w - Breite des Textfeldes im Raster
        h - Höhe des Textfeldes im Raster
        Returns:
        das erzeugte TextArea-Objekt
        Since:
        7.00.004

      • addList

        public List addList​(int x,
                    int y,
                    int w,
                    int h)
        Deprecated.
        Ersetzt durch getGridPanel() und GridPanel.addList(int, int, int, int)
        Erzeugt eine Liste und fügt ihn an der angegebenen Stelle in den Dialog ein.
        Parameters:
        x - X-Position im Raster (Spalte), Zählung beginnt hier bei 1
        y - Y-Position im Raster (Zeile), Zählung beginnt hier bei 1
        w - Breite der Liste im Raster
        h - Höhe der Liste im Raster
        Returns:
        das erzeugte List-Objekt
        Since:
        7.00.008

      • addTextField

        public TextField addTextField​(int x,
                              int y,
                              int w)
        Deprecated.
        Ersetzt durch getGridPanel() und GridPanel.addTextField(int, int, int)
        Erzeugt ein einzeiliges Textfeld (TextField) und fügt ihn an der angegebenen Stelle in den Dialog ein.
        Parameters:
        x - X-Position im Raster (Spalte), Zählung beginnt hier bei 1
        y - Y-Position im Raster (Zeile), Zählung beginnt hier bei 1
        w - Breite des Textfeldes im Raster
        Returns:
        das erzeugte TextField-Objekt
        Since:
        7.00.004

      • addCheckBox

        public CheckBox addCheckBox​(int x,
                            int y,
                            int w,
                            String text,
                            boolean checked)
        Deprecated.
        Ersetzt durch getGridPanel() und GridPanel.addCheckBox(int, int, int, String, boolean)
        Erzeugt eine CheckBox und fügt sie an der angegebenen Stelle in den Dialog ein.
        Parameters:
        x - X-Position im Raster (Spalte), Zählung beginnt hier bei 1
        y - Y-Position im Raster (Zeile), Zählung beginnt hier bei 1
        w - Breite der Checkbox im Raster
        text - Text-Label der CheckBox
        checked - True, wenn die CheckBox "angehakt" sein soll
        Returns:
        das erzeugte Label-Objekt
        Since:
        7.00.004

      • addButton

        public Button addButton​(int x,
                        int y,
                        int w,
                        String text,
                        String eventName)
        Deprecated.
        Ersetzt durch getGridPanel() und GridPanel.addButton(int, int, int, String, String)
        Erzeugt einen Button und fügt sie an der angegebenen Stelle in den Dialog ein.
        Parameters:
        x - X-Position im Raster (Spalte), Zählung beginnt hier bei 1
        y - Y-Position im Raster (Zeile), Zählung beginnt hier bei 1
        w - Breite des Buttons im Raster
        text - Text-Label der CheckBox
        eventName - Ein Scripting-Event, das aufgerufen wird, wenn der Button gedrückt wird.
        Returns:
        das erzeugte Button-Objekt
        Since:
        7.00.004

      • getGridPanel

        public GridPanel getGridPanel()
        Liefert das GridPanel, welches die Komponenten in diesem Dialog enthält.
        Returns:
        Das im Dialog enthaltene GridPanel.
        Since:
        8.01.000

      • addComboBox

        public ComboBox addComboBox​(int x,
                            int y,
                            int w,
                            String[] values,
                            boolean editable)
        Deprecated.
        Ersetzt durch getGridPanel() und GridPanel.addComboBox(int, int, int, String[], boolean)
        Erzeugt eine ComboBox und fügt sie an der angegebenen Stelle in den Dialog ein.
        Parameters:
        x - X-Position im Raster (Spalte), Zählung beginnt hier bei 1
        y - Y-Position im Raster (Zeile), Zählung beginnt hier bei 1
        w - Breite der ComboBox im Raster
        values - Die auswählbaren Werte des ComboBox
        editable - True, wenn zusätzliche Eingaben möglich sein sollen, bei False ist nur eine Auswahl aus den vorhandenen Werten möglich
        Returns:
        das erzeugte Button-Objekt
        Since:
        7.00.004

      • 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:
        7.00.004

      • 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:
        7.00.004

      • 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:
        7.00.004

      • setHelpButton

        public void setHelpButton​(String event)
        Fügt den "Hilfe" Button unten links in die Statuszeile des Dialogs ein.
        Parameters:
        event - Ein Scripting-Event, das aufgerufen wird, wenn der Hilfe-Button gedrückt wird
        Since:
        7.00.006

      • setHelpButton

        public void setHelpButton​(BaseFunction callbackFunction,
                          ScriptableObject thisScope)
        Fügt den "Hilfe" Button unten links in die Statuszeile des Dialogs ein.
        Parameters:
        callbackFunction - JavaScript Funktion, welche aufgerufen wird wenn die Hilfe angezeigt werden soll.
        thisScope - "this" Scope der Funktion
        Since:
        10.00.000

      • show

        public boolean show()
        Zeigt den Dialog an.
        Returns:
        True wenn der Dialog mit "OK" geschlossen wurde, sonst False
        Since:
        7.00.004

      • show

        public void show​(String okEvent,
                 String closeEvent)
        Zeigt den Dialog im nichtmodalen Modus an. Der Dialog bleibt nach diesem Aufruf geöffnet, das Skript läuft sofort weiter. Im Client kann parallel zum Dialog gearbeitet werden.
        Callback Parameter:
        GridDialog Dialog, aus welchem das Callback aufgerufen wird.
        GridDialog.CloseEventSource Quellevent, aus welchem der Dialog geschlossen wird.
        Parameters:
        okEvent - Ein Event welches beim Klick auf "OK" aufgerufen werden soll oder null. Im Scripting kann das Schließen des Dialogs verhindert werden, wenn eine Funktion zu diesem Event einen negativen Rückgabewert liefert.
        closeEvent - Ein Event welches bei "Abbrechen" oder "X" aufgerufen wird oder null. Das Schließen des Dialogs kann hierbei nicht abgebrochen werden.
        Since:
        8.00.006, 10.00.012 CloseEventSource-Parameter im Callback

      • show

        public void show​(BaseFunction okCallback,
                 BaseFunction closeCallback,
                 ScriptableObject thisScope)
        Zeigt den Dialog im nichtmodalen Modus an. Der Dialog bleibt nach diesem Aufruf geöffnet, das Skript läuft sofort weiter. Im Client kann parallel zum Dialog gearbeitet werden.
        Callback Parameter:
        GridDialog Dialog, aus welchem das Callback aufgerufen wird.
        GridDialog.CloseEventSource Quellevent, aus welchem der Dialog geschlossen wird.
        Parameters:
        okCallback - Die JavaScript-Funktion, welche beim Klick auf "OK" aufgerufen werden soll oder null. Im Scripting kann das Schließen des Dialogs verhindert werden, wenn diese Funktion einen negativen Rückgabewert liefert.
        closeCallback - Die JavaScript-Funktion, welche bei "Abbrechen" oder "X" aufgerufen wird oder null. Das Schließen des Dialogs kann hierbei nicht abgebrochen werden.
        thisScope - "this" Scope der Callback-Methoden: Das die Funktionen definierende Objekt.
        Since:
        10.00.000, 10.00.012 CloseEventSource-Parameter im Callback

      • close

        public void close()
        Schließt den Dialog.
        Since:
        7.00.006