de.elo.client.scripting.dialog
Class GridDialog

java.lang.Object
  de.elo.client.scripting.dialog.GridDialog

public class GridDialog
extends java.lang.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-2012

Constructor Summary

GridDialog(de.elo.client.maindialog.Workspace workspace, int columns, int rows, java.lang.String title)
Konstruktor für die Klasse "GridDialog".

Method Summary

Button	addButton(int x, int y, int w, java.lang.String text, java.lang.String eventName) Erzeugt einen Button und fügt sie an der angegebenen Stelle in den Dialog ein.
CheckBox	addCheckBox(int x, int y, int w, java.lang.String text, boolean checked) Erzeugt eine CheckBox und fügt sie an der angegebenen Stelle in den Dialog ein.
ComboBox	addComboBox(int x, int y, int w, java.lang.String[] values, boolean editable) Erzeugt eine ComboBox und fügt sie an der angegebenen Stelle in den Dialog ein.
void	addComponent(int x, int y, int w, int h, java.awt.Component comp) Fügt eine Standard-Java Komponente (AWT/Swing) in den Dialog ein.
Label	addLabel(int x, int y, int w, java.lang.String text) Erzeugt einen Text (Label) und fügt ihn an der angegebenen Stelle in den Dialog ein.
List	addList(int x, int y, int w, int h) Erzeugt eine Liste und fügt ihn an der angegebenen Stelle in den Dialog ein.
TextArea	addTextArea(int x, int y, int w, int h) Erzeugt ein mehrzeiliges Textfeld (TextArea) und fügt ihn an der angegebenen Stelle in den Dialog ein.
TextField	addTextField(int x, int y, int w) Erzeugt ein einzeiliges Textfeld (TextField) und fügt ihn an der angegebenen Stelle in den Dialog ein.
void	close() Schließt den Dialog.
GridPanel	getGridPanel() Liefert das GridPanel, welches die Komponenten in diesem Dialog enthält.
void	setDialogId(java.lang.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.
void	setHelpButton(java.lang.String event) Fügt den "Hilfe" Button unten links in die Statuszeile des Dialogs ein.
void	setStatusNormal(java.lang.String message) Setzt den Text in der Statuszeile und schaltet den Status auf "normal" (blaue Hintergrundfarbe, der Button "OK" ist aktiviert).
void	setStatusRed(java.lang.String message) Setzt den Text in der Statuszeile und schaltet den Status auf "Fehler" (rote Hintergrundfarbe, der Button "OK" ist deaktiviert).
void	setStatusYellow(java.lang.String message) Setzt den Text in der Statuszeile und schaltet den Status auf "unvollständig" (gelbe Hintergrundfarbe, der Button "OK" ist deaktiviert).
boolean	show() Zeigt den Dialog an.
void	show(java.lang.String okEvent, java.lang.String closeEvent) Zeigt den Dialog im nichtmodalen Modus an.

Methods inherited from class java.lang.Object

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

Constructor Detail

GridDialog

public GridDialog(de.elo.client.maindialog.Workspace workspace,
                  int columns,
                  int rows,
                  java.lang.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(java.lang.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

addComponent

public void addComponent(int x,
                         int y,
                         int w,
                         int h,
                         java.awt.Component comp)

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,
                      java.lang.String text)

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)

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)

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)

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,
                            java.lang.String text,
                            boolean checked)

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,
                        java.lang.String text,
                        java.lang.String eventName)

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,
                            java.lang.String[] values,
                            boolean editable)

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(java.lang.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(java.lang.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(java.lang.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(java.lang.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

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(java.lang.String okEvent,
                 java.lang.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.

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

close

public void close()

Schließt den Dialog.

Since:

7.00.006