JSWindow.js

Allgemeine Funktionen

Effekte

Selbstverständlich können für alle Effekte (z.B. beim Schließen, Minimieren, ...) auch eigene Animationen definiert werden. Zwei einfache Standard-Effekte sind bereits in der JSWindow.js definiert. Um die Effekte für ein Fenster einzutragen, müssen sie in dem Objekt JSWindow.effects eingetragen werden.

Konvention

Jeder Effekt ist eine Funktion, die zum Starten ein mal mit, je nach Effekt-Typ vordefinierten, Parametern aufgerufen wird. Bei diesem Erstaufruf muss sich der Effekt selbstständig um das Beenden eventuell gerade aktiver Effekte kümmern und sich dann in die Eigenschaft JSWindow.effect seines Fensters eintragen. Für die Animation kann sich die Effektfunktion per Interval selbst aufrufen und dabei am Besten nur den win-Parameter übergeben. So kann der Selbstaufruf vom Erstaufruf unterschieden werden. Alle beim Erstaufruf übergebenen Eigenschaften können in JSWindow.effect gespeichert werden.

JSWindow.effect

In JSWindow.effect können beliebige Werte, die für den Effekt gebraucht werden, gespeichert werden. JSWindow.effect ist ein Objekt, das beim Erstaufruf eines Effektes instanziiert wird und bei dessen Beendigung auf null gesetzt wird. Die folgenden Properties von JSWindow.effect haben besondere Aufgaben und müssen gesetzt werden:

Aufbau einer Effektfunktion

Das folgende Beispiel veranschaulicht den Aufbau, den eine Effektfunktion sinnvoller Weise haben sollte:

function JSWEffect_Example (win, duration, onTerminate, param1, param2) {
 if (duration) { // Erstaufruf
  // Eventuell laufenden Effekt beenden. Wenn JSWEffect_terminate true zurueck gibt, darf kein neuer Effekt gestartet werden.
  if (JSWEffect_terminate(win)) return;
  // JSWindow.effect instanziieren und Werte speichern
  win.effect = new Object();
  win.effect['fkt'] = JSWEffect_Example; // Pflichtproperty
  win.effect['onTerminate'] = onTerminate; // Pflichtproperty
  win.effect['start'] = getTickCount();
  win.effect['stop'] = win.effect['start'] + duration; // Pflichtproperty
  win.effect['interval'] = window.setInterval(win.effect['fkt'], 20, win); // Pflichtproperty
  win.effect['param1'] = param1;
  win.effect['param2'] = param2;
  
  // Hier eventuelle initial-Stylesheets fuer Effekt setzen
  
 }
 var t = getTickCount();
 if (isNaN(win.effect['stop']) || t >= win.effect['stop']) { // Effekt beenden (wenn Zeit abgelaufen oder JSWindow.effect['stop'] auf Number.NaN gesetzt (Abbruch))
  // Timer beenden
  if (win.effect['interval']) window.clearInterval(win.effect['interval']); // mit if-Bedingung, falls timer bereits beendet wurde
  win.effect['interval'] = null; // Muss auf null gesetzt werden, um Doppelbeendigung zu verhindern
  
  // Hier "Ziel-Style" setzen; alle aussergewoehnlichen Stylesheets, die durch den Effekt gesetzt wurden, sollten zurrueckgenommen werden
  
  // Effekt beenden
  var onTerm = win.effect['onTerminate'];
  win.effect = null;
  if (onTerm) return onTerm(win); // onTerminate darf erst aufgerufen werden, nachdem JSWindow.effect auf null gesetzt wurde
 } else {
 
  // Animation
  
 }
}

Typen von Effektfunktionen

Hinweis: Viele Effekttypen (z.B. blend-in und blend-out) sind von der Form her identisch. Es ist also möglich, hier die gleiche Effektfunktion zu verwenden und nur über den frei wählbaren param (Siehe Effektregistrierung) zwischen den Effekten zu unterscheiden. Oftmals genügt es, nur wenige Zeilen einzufügen, um einen Effekt zu bauen, der sowohl ein- als auch ausblenden kann.

Effektregistrierung

Damit ein Fenster die gewünschten Effekte anwendet, müssen diese im Objekt JSWindow.effects registriert werden. Wenn keine Effekte gewünscht sind, darf JSWindow.effects null sein. Um einen Effekt zu registrieren, muss die Effektfunktion in der Eigenschaft JSWindow.effects[Effekttyp] eingetragen werden. Effekttyp ist dabei der Typ (String), wie er in der Tabelle im vorherigen Abschnitt benannt ist (Gross/Kleinschreibung beachten!). Zu jeder Effektfunktion kann ein beliebiger Parameter (param) notiert werden. Dieser kann in der Eigenschaft JSWindow.effects[Effekttyp + 'Param'] gespeichert werden. Außerdem ist vorgesehen, dass die Dauer für jeden Effekt separat festgelegt werden kann. Dafür soll die Eigenschaft JSWindow.effects[Effekttyp + 'Duration'] zuständig sein. Ist diese nicht gesetzt, soll als Fallback die Eigenschaft JSWindow.effects['duration'] verwendet werden. Im Moment wird jedoch immer JSWindow.effects['duration'] für alle Effekte verwendet.
Im Managed-Windows-State muss nicht für jedes Fenster ein eigenes Effects-Objekt angelegt werden, sondern es wird standardgemäß das Effects-Objekt des Managers verwendet.

EventListener

Über die Methode JSWindow.addEventListener können eventListener auf ein Fenster gesetzt werden. Wird der Listener ausgelöst, so wird der Listener-Funktion als einziger Parameter das Fenster, das den Event ausgelöst hat, übergeben. Folgende EventListener werden von JSWindow unterstützt:

Im Managed-Windows-State existieren weitere EventListener.

Die Klasse JSWindow

Die Prototypeklasse JSWindow stellt die Funktionalität je eines Fensters dar. Sie kümmert sich um das Verschieben, Maximieren, Minimieren, Schließen und natürlich Erstellen von Fenstern. Außerdem enthällt sie wichtige Funktionen zu Positionsberechnung, etc.

Die Klasse JSWindow erwartet beim Erstellen genau einen optionalen Parameter _el. _el kann ein existierendes OuterBox-Element sein, das z.B. beim Laden der Seite als HTML-Code gegeben war, aber noch von keinem anderen JSWindow verwendet wird. Wird _el übergeben, so versucht JSWindow, diese bis dahin statische Box in ein vollwertiges Fenster zu verwandeln. Ansonsten wird ein OuterBox-Element erzeugt, dass aber vom Konstruktor NICHT ins DOM eingehängt wird. Dies geschied in diesem Fall erst mit show.