Diese Schnittstelle ist erst ab Version 5 verfügbar.
Die Javascript Bibliothek Dojo erlaubt es unter anderem vorgefertigte Dialoge und Felder darzustellen. Im Adminbereich werden mit Dojo die Javascript Funktionen alert(), confirm() und prompt() simuliert. Hierzu öffnet sich jeweils ein Dojo Dialog, welches die Funktionalität der genannten Funktionen nachahmt.
Alle drei Funktionen erben voneinander. Dies bedeutet dass die Parameterübergabe bei allen drei Funktionen identisch ist.
alert() wird zu dialog.alert() confirm() wird zu dialog.confirm() prompt() wird zu dialog.prompt() window.open() wird zu dialog.open()
Den confirm und prompt Funktionen wird ein Parameter übergeben, welches ein Objekt sein muss. Nur dialog.alert() kann optional auch ein String als Parameter übergeben werden.
dialog.alert('Das ist ein Alert!');
Ansonsten sieht ein übergebener Parameter standardmäßig wie folgt aus:
dialog.alert({
text : 'Das ist ein Alert!'
});
Bei der Funktion dialog.open() muss als erster Parameter der Titel und als zweiten Parameter die Ziel URL angegeben werden. Optional kann mit einem dritten Parameter eingestellt werden, ob die Ziel-URL in einem iframe geöffnet werden soll, damit man verschiedene Probleme (ID-Konflikte, Styles,...) aus dem Weg gehen kann.
Beispiel:
dialog.open("Verlorene_Seiten", "../desktop/lost_pages.php", true);
Bei dialog.confirm() und dialog.prompt() will man allerdings die Benutzeraktion auswerten, weshalb noch folgender Parameter notwendig ist:
dialog.confirm({
text : 'Das ist ein Confirm!',
onConfirm : function()
{
// Aktion die ausgeführt wird wenn der Ok Button geklickt wurde
}
});
dialog.prompt({
text : 'Das ist ein Prompt!',
onConfirm : function(response)
{
// Aktion die ausgeführt wird wenn der Ok Button geklickt wurde
// Die Variable response beinhaltet den eingegebenen Text
}
});
Alle optionalen Parameter im Überblick:
- title: Der Titel des Dialogs (Standard: keiner)
- buttons: Ok und Cancel Buttons anzeigen (Standard: Ja, außer bei dialog.alert())
- confirm: Text für den Ok Button (Standard: Ok)
- cancel: Text für den Cancel Button (Standard: Cancel)
- onConfirm: Funktion die aufgerufen wird wenn der Ok Button geklickt wurde
- onCancel: Funktion die aufgerufen wird wenn der Cancel Button geklickt wurde
- timeout: Zeit in Milliekunden bis der Dialog automatisch ausgeblendet wird (Standard: 3000)
Wenn nur true übergeben wird, ist der Standardwert 3000 Millisekunden. Wenn 0 übergeben wird, wird der Dialog nicht automatisch ausgeblendet.
- additionalElement: ein zusätzliches HTML Objekt
- doAfterHide: Es kann eine Referenz auf eine Funktion übergeben werden, die nach dem Schließen eines Dialoges (Alert,Confirm,Prompt) ausgeführt wird.
Je nach Einsatzort dieser Funktionen kann ein window.parent Aufruf notwendig sein.