Pflichtenheft GUI-Editor Mr. Bean

Transkript

1 SWTP 04: JB-01 Pflichtenheft für GUI-Editor Mr. Bean Seite 1/12 Pflichtenheft GUI-Editor Mr. Bean 1.Zielbestimmung In den Entwicklungen der letzten Jahre hat sich im Bereich der GUI-Erstellung und GUI- Programmierung im Bereich der Programmiersprache Java das Oberflächenkonzept nach dem Java Bean-Standard durchgesetzt. Mit Hilfe von Beans lassen sich auf unkomplizierte Art einfache Grundkomponenten wie Buttons, Listen und Tetfelder größere Komponenten und ganze Anwendungen zusammensetzen. Die zusammengesetzten Komponenten sind auch wieder Beans und lassen sich dadurch beliebig oft wiederverwenden, so dass vorherige Entwicklungen leicht in aktuelle Projekte eingebunden werden können und der Programmieraufwand minimiert wird. Die Software Mr. Bean stellt einen GUI-Editor dar, mit dem vorhandene Beans auf grafische Art und Weise komponiert werden können. Der Java-Entwickler bildet mit Hilfe des Editors die komplette Oberflächenlogik ab, so dass er sich auf das eigentliche, die Funktionsprogrammierung, konzentrieren kann. Mr. Bean nimmt dem Entwickler somit einen Großteil der erforderlichen, aber oft monotonen GUI-Programmierung ab. 1. Musskriterien Diese erste Version wird nur die grundlegenden Editieraktionen unterstützen, allerdings ein ausgereiftes Basiskonzept einsetzen, so dass spätere Erweiterungen ohne grundlegende Änderungen zu implementieren sind. Die folgenden Funktionen sind zu implementieren: Das Arbeiten mit Projekten (Laden/Speichern/Ändern) Das Erstellen, Löschen und Editieren von Anwendungsfenstern Das Hinzufügen, Ändern und Löschen von Komponenten in Anwendungsfenster, inklusive der Skalierung und des Verschiebens der Komponenten mit der Maus Die Generierung von.class- und Quellcodedateien Der Grad des zu implementierenden Bean-Standards ist unter 6. /LL30/ vermerkt

2 SWTP 04: JB-01 Pflichtenheft für GUI-Editor Mr. Bean Seite 2/12 Weiterhin ist es unbedingt notwendig, dass der Editor als selbststartende Jar-Datei ausgeliefert wird, die den Aufruf des Programms durch simples Klicken auf die Jar-Datei möglich macht, sofern das System des Benutzers dafür konfiguriert ist. 2. Wunschkriterien Es soll ein Menü-Editor erstellt werden, mit dem Menüs komfortabel bearbeitet werden können, da dies nicht mit dem normalen Eigenschaftseditor möglich ist. 3. Abgrenzungskriterien Der Editor ist nur für die Erstellung und Bearbeitung von Oberflächen nach dem Java-Bean- Standard gedacht. Es können keine AWT-basierten Oberflächen erstellt werden, auch keine Oberflächen für andere Oberflächen-Toolkits wie z.b. Gtk oder Qt. Weiterhin ist nur die Oberfläche zu editieren, der Quellcode kann im GUI-Editor nicht bearbeitet werden. Für diese Funktion sind andere Programme heranzuziehen. Es gibt kein Re-factoring vorhandene Quellcode- bzw. Class-Dateien können nicht wieder eingelesen werden. Nur die als Projekt vorhandenen Oberflächen lassen sich ändern und daraus Quellcode generieren. 2.Produkteinsatz 1. Anwendungsbereiche Der Editor ist für die Erstellung von grafischen Oberflächen, aufbauend auf der Java-Swing- Oberfläche sowie dem Bean-Standard, gedacht. 2. Zielgruppen Das Produkt ist für GUI-Entwickler und Java-Programmierer gedacht. 3.Produktüberblick Der Editor besteht aus mehreren Fenstern, die unterschiedliche Aufgaben erfüllen: 1. Hauptfenster Das Hauptfenster beinhaltet das Hauptmenü, mit dem der Benutzer projektspezifische Funktionen aufrufen als auch den Quelltet generieren kann. Unter dem Hauptmenü ist eine Liste mit den vom Benutzer generierten Anwendungsfenstern, die er durch Klick auf die Liste aktivieren kann. 2. Eigenschaftseditor Der Eigenschaftseditor ist ein Fenster, mit dem der Entwickler die Einstellungen der aktuell ausgewählten Bean sehen und verändern kann. 3. Anwendungs- oder Kompositionsfenster Das Kompositionsfenster ist das wichtigste Fenster des Editors; in diesem Fenster stellt der Benutzer nach WYSIWYG-Manier die Oberfläche seiner späteren Anwendung mit seiner Maus zusammen. Es zeigt das Anwendungsfenster fast so (mit Hilfslinien), wie es später einmal in der fertigen Anwendung aussehen wird.

3 SWTP 04: JB-01 Pflichtenheft für GUI-Editor Mr. Bean Seite 3/12 4. Widget-Tree Da die Darstellung des Kompositionsfensters zweidimensional ist, sind Verschachtelungen der Beans nicht oder sehr schwer zu erkennen. Um diesem Abhilfe zu schaffen gibt es den Widget-Tree, in dem die Schachtelungen der Beans im Anwendungsfenster als Baum dargestellt werden. 5. Toolbar mit Beans In der Toolbar sind alle Beans, die der Benutzer zur im Kompositionsfenster zusammenstellen kann, als Symbole angesammelt. Mit einem Klick auf ein Bean-Symbol und einem anschließenden Klick auf eine freie Fläche im Kompositionsfenster wird eine Beans eingefügt. 4.Produktfunktionen /LF0010/ /LF0020/ /LF0030/ Neues Projekt anlegen Es ist kein Projekt aktiv, d.h. es wurde noch keines geladen oder ein schon geladenes wurde wieder geschlossen. Klick auf Menüeintrag Neues Projekt Nach Programmstart muss der Benutzer entweder ein vorhandenes Projekt laden oder ein neues erstellen, da sonst keine der Funktionen zugänglich ist. Ein Dialog mit den Projekteigenschaften wird angezeigt. Der Benutzer trägt alle Werte ein und bestätigt sie. Ein neues Projekt wurde erstellt, es gibt keine Anwendungsfenster Projekt laden Siehe /LF0010/ Klick auf Menüeintrag Projekt laden Ein vorhandenes, vorher gespeichertes Projekt wird über einen Öffnen-Dialog durch den Benutzer ausgewählt und geladen. Ein Datei öffnen -Dialog erscheint, in dem der Benutzer die Projektdatei auswählen kann. Das Projekt inkl. aller Anwendungsfenster wurde geladen. Der Editor wird so hergestellt, wie sie zum Zeitpunkt des Speichern durch den Benutzer eingerichtet war. Der Benutzer bricht die Aktion ab. Der Zustand des Editors bleibt unverändert. Projekt speichern Der Benutzer hat ein Projekt, neu oder geöffnet, geladen. Klick auf Menüeintrag Projekt speichern

4 SWTP 04: JB-01 Pflichtenheft für GUI-Editor Mr. Bean Seite 4/12 /LF0050/ /LF0100/ /LF1010/ Das aktuelle Projekt inkl. aller Komponentendaten und -einstellungen wird auf der Festplatte gespeichert, damit der Benutzer seine Arbeit später fortführen kann Alle Daten werden gespeichert, und der Benutzer kann mit seiner Arbeit fortfahren. Die Daten wurden gesichert. Nicht genug Speicherplatz frei Hilfe aufrufen Klick auf Menüpunkt Hilfe Wenn der Benutzer auf diesen Menüpunkt klickt, wird die Hilfedatei im Browser gestartet. Der Standardbrowser des Benutzers wird aufgerufen und die Hilfedatei angezeigt. Benutzer sieht die Hilfe Keine Hilfedatei/ kein Browser vorhanden Code generieren Es ist ein Projekt geladen (neu oder geöffnet), es gibt Anwendungsfenster Klick auf Menüpunkt Code generieren Wenn der Benutzer mit der Bearbeitung und Änderung der Oberfläche fertig ist, kann er mit dieser Funktion Java-Quellcode generieren lassen, den er dann in seine Anwendung einbinden kann. Standardmäßig werden kompilierte Java-Bytecode-Dateien (.class) generiert. Dies geschieht, da Änderungen im Sourcecode (.java) vom GUI-Editor nicht reflektiert werden können und der Benutzer mit dem erneuten Klicken auf Code generieren alle Änderungen im Sourcecode überschreiben würde. Auf epliziten Wunsch (Projekteinstellungen) kann der Benutzer auch direkten Java- Sourcecode generieren. Die.class-Dateien bzw. die Source-Dateien werden generiert und abgespeichert. (Abhängig von Projekteinstellung) Quellcode bzw..class-dateien können vom Benutzer verwendet werden. Nicht genug Speicherplatz Neues Anwendungsfenster erstellen Projekt geladen Klick auf Menüpunkt Neues Anwendungsfenster

5 SWTP 04: JB-01 Pflichtenheft für GUI-Editor Mr. Bean Seite 5/12 /LF1020/ /LF1030/ /LF1040/ Hiermit erstellt der Benutzer ein neues Kompositionsfenster, in welchem er die Oberfläche mit Beans zusammenstellen kann. Ein neues Anwendungsfenster wird erstellt und in die Fensterliste des Hauptfensters eingetragen. Das Anwendungsfenster standardmäßig hat ein GridBag-Layout mit 34 Feldern, auf denen die Beans platziert werden können. Der Benutzer hat ein zusätzliches Anwendungsfenster, in welchem er die Beans platzieren kann Beansymbol auswählen Der Benutzer hat ein Anwendungsfenster ausgewählt Klick auf Symbol in Toolbar In der Toolbar klickt der Benutzer auf das Symbol einer Bean-Klasse. Damit schaltet der Editor in den Einfügen-Modus um. Der Editor schaltet in den Einfügen-Modus um, der Mauszeiger verändert sich (Platzieren-Symbol) Der Benutzer kann die Komponente einfügen Es ist kein Platz mehr im Anwendungsfenster Komponente einfügen Editor ist im Einfügen-Modus Klick mit der Maus auf den freien Bereich des aktiven Anwendungsfensters Im Einfügen-Modus klickt der Benutzer mit seiner Maus auf ein freies Feld im GridBag-Layout des Anwendungsfenster. Während der Bearbeitung der Komponenten im GUI-Editor sind diese in eine Art Design-Modus geschaltet, d.h. sie reagieren nicht auf Klicks und Tastatureingaben. Dieses Verhalten gilt nur im Editor, in der späteren Anwendung verhalten sich die Komponenten normal. Als Resultat wird an der Stelle im Anwendungsfenster eine Instanz der ausgewählten Bean-Klasse platziert und als aktiv gekennzeichnet. Weiterhin werden alle Bean- Eigenschaften ausgelesen und im Eigenschaftseditor angezeigt. Die Bean wird an der richtigen Stelle im Widget-Tree eingefügt und dort mit ihrem Namen repräsentiert. Editor ist im Design-Modus, Komponente ist aktiv und kann verändert werden. Komponente auswählen Es eistiert ein aktives Anwendungsfenster mit einer oder mehreren Komponenten

6 SWTP 04: JB-01 Pflichtenheft für GUI-Editor Mr. Bean Seite 6/12 /LF1050/ /LF1060/ /LF1070/ Klick mit der Maus auf eine nicht-aktive Komponente Wenn der Benutzer mit der Maus auf eine im Anwendungsfenster platzierte Komponente klickt, wird diese als aktiv gekennzeichnet. Die ausgewählte Bean wird im Widget-Tree hervorgehoben und deren Eigenschaften im Eigenschaftseditor angezeigt. Der Benutzer kann eine Komponente auch im Widget-Tree auswählen. Dies akiviert die Komponente auch im Anwendungsfenster. Als Resultat wird an der Stelle im Anwendungsfenster eine Instanz der ausgewählten Bean-Klasse platziert und als aktiv gekennzeichnet. Weiterhin werden alle Bean- Eigenschaften ausgelesen und im Eigenschaftseditor angezeigt. Editor ist im Design-Modus, Komponente ist aktiv und kann verändert werden. Verschieben einer Komponente Editor ist im Design-Modus, Komponente ist ausgewählt, es gibt noch freie Felder im Anwendungsfenster Drag'n'Drop der aktiven Komponente in ein freies Feld des Anwendungsfensters Aktive Komponenten können im Anwendungsfenster mit Hilfe der Maus (Drag'n'Drop) an neue, freie Positionen des Layouts verschoben werden. Die Eigenschaften der Komponente bleiben dabei erhalten, nur die Position wird geändert. Das Verschieben einer Komponente wird auch im Widget-Tree durch Aktualisierung der Darstellung reflektiert. Die Komponente befindet sich an einem neuen Platz Skalieren einer Komponente Editor ist im Design-Modus, Komponente ist ausgewählt Ziehen des Rahmens der aktiven Komponente (Vergrößern oder Verkleinern) Eine aktive Komponente kann vom Benutzer mit Hilfe der Maus in der Größe verändert werden. Die Größe der Komponente ändert sich. Die Änderung wird nicht nur im Anwendungsfenster direkt reflektiert, sondern auch im Eigenschaftsfenster (Breitenund Höhenwerte ändern sich). Komponente hat eine neue Größe Komponente kann diese Größe nicht annehmen Entfernen von Komponenten

7 SWTP 04: JB-01 Pflichtenheft für GUI-Editor Mr. Bean Seite 7/12 /LF1080/ /LF1090/ /LF1100/ Editor ist im Design-Modus, Komponente ist ausgewählt Klick auf die Entf -Taste Aktive Komponenten können durch Druck auf die Entf -Taste gelöscht werden. Sie verschwinden sowohl vom Anwendungsfenster, als auch im Widget-Tree. Die Instanz der Bean wird zerstört. Komponente eistiert nicht mehr Kopieren einer Komponente Editor ist im Design-Modus, Komponente ist ausgewählt Drücken der Tastenkombination Strg+C Die Eigenschaften und Einstellungen der aktiven Komponente können mit Hilfe der Tastenkombination Strg+C in die Zwischenablage kopiert werden. Es passiert nichts sichtbares. Daten der Komponente sind in der Zwischenablage. Ausschneiden einer Komponente Editor ist im Design-Modus, Komponente ist ausgewählt Drücken der Tastenkombination Strg+X Gleiches wie Kopieren, nur dass mit der Komponente danach wie unter Entfernen von Komponenten verfahren wird. Die Komponente wird aus dem Anwendungsfenster entfernt. Daten der Komponente sind in der Zwischenablage. Die Komponente wurde zerstört. Einfügen aus der Zwischenablage Es gibt Komponentendaten in der Zwischenablage Drücken der Tastenkombination Strg+V Wenn der Benutzer Komponentendaten in die Zwischenablage kopiert hat, so kann er mit der Tastenkombination Strg+V eine neue Komponente im Anwendungsfenster wie unter Komponente einfügen beschreiben hinzufügen. Im Gegensatz zu Komponente einfügen werden nicht die Standardwerte für die Eigenschaften benutzt, sondern alle in der Zwischenablage vorhandenen Einstellungen werden übernommen.

8 SWTP 04: JB-01 Pflichtenheft für GUI-Editor Mr. Bean Seite 8/12 /LF1110/ /LF1120/ /LF1130/ Eine neue Komponente wird an der Mausposition eingefügt. Die Daten der neuen Komponente wurden aus der Zwischenablage übernommen. Komponenteneigenschaften bearbeiten Editor ist im Design-Modus, Komponente ist ausgewählt Änderung der Eigenschaft im Eigenschaftseditor Die Einstellungen aktiver Komponenten werden im Eigenschaftseditor angezeigt. Im Eigenschaftseditor kann der Benutzer nun die Einstellungen der aktiven Bean verändern, z.b. das Ändern des Namens durch ein Tetfeld. Je nach Eigenschaftstyp wird das passende Eingabefeld angezeigt: - Tetfeld bei Strings - Drehfeld bei Zahlen (int, float) - Checkbo bei boolean-werten usw. Typen, für die es kein Eingabefeld gibt, werden als nicht bearbeitbar gekennzeichnet und können nur im Quelltet geändert werden. Falls die Komponente einen eigenen Eigenschaftseditor bereitstellt, erscheint ein Button..., der auf Klick den komponenteneigenen Editor zum Vorschein bringt. Die Eigenschaftsänderungen werden im Editor angezeigt und evtl. im Anwendungsfenster reflektiert Die geänderte Eigenschaft wird übernommen Der Wert der Eigenschaft wird von der Bean nicht akzeptiert. Ereignisempfänger aktivieren Editor ist im Design-Modus, Komponente ist ausgewählt Aktivierung der Ereignis-Checkbo im Eigenschaftseditor Auch im Eigenschaftseditor findet der Benutzer eine Liste mit allen Ereignissen, die die Komponente bereitstellt. Über eine Checkbo kann der Benutzer das jeweilige Ereignis aktivieren. Für aktivierte Ereignisse wird ein Ereignisempfänger automatisch im Quellcode generiert, so dass der Benutzer weniger Arbeit bei der Initialprogrammierung hat. Die Checkbo wird aktiviert. Das Ereignis wird vorgemerkt, damit es später generiert werden kann. Menü bearbeiten Editor ist im Design-Modus, Menükomponente ist ausgewählt Klick auf Menüeditor im Eigenschaftseditor

9 SWTP 04: JB-01 Pflichtenheft für GUI-Editor Mr. Bean Seite 9/12 /LF1140/ /LF1150/ Menüs können nicht wie normale Beans erstellt werden. Deshalb gibt es im Eigenschaftseditor für Komponenten der Menü-Klasse einen Etraknopf, der einen Menüeditor zum Vorschein bringt und in dem das Menü komfortabel zusammengestellt werden kann. Menüeditor wird angezeigt Menü wurde generiert Anwendungsfenster skalieren Anwendungsfenster ist ausgewählt Ziehen des Rahmens des Anwendungsfensters Vom Benutzer erstellte Anwendungsfenster können mit Hilfe der Maus in der Größe geändert werden. Fenster wird sichtbar vergrößert oder verkleinert Die Breiten- und Höheneigenschaften werden geändert Anwendungsfenster kann diese Größe nicht annehmen (zu klein) Anwendungsfenster entfernen Anwendungsfenster ist ausgewählt Klick auf Entf -Taste Der Benutzer kann ein von ihm erstelltes aktives Anwendungsfenster durch Druck auf die Entf -Taste löschen. Dadurch werden alle auf ihm platzierten Komponenten gelöscht. Anwendungsfenster verschwindet und wird aus der Fensterliste im Hauptfenster gelöscht Alle Komponenten im Anwendungsfenster werden zerstört. Das Anwendungsfenster wird zerstört. 5.Produktdaten /LD10/ GUI-Daten (Position, Größe der Komponenten, ma je Projekt) /LD20/ Bean-Daten (Bean-Eigenschaften, ma. 200 je Bean) /LD30/ Projektdaten (Speicherort, Autor, unbegrenzt). Projekte werden in einem XML-Format auf der Festplatte gespeichert. 6.Produktleistungen /LL10/ Das Programm soll innerhalb 30 Sekunden nach Start auf Benutzereingaben reagieren

10 SWTP 04: JB-01 Pflichtenheft für GUI-Editor Mr. Bean Seite 10/12 /LL20/ /LL30/ Bei Funktionen, die mehr als 10 Sekunden Rechenzeit benötigen, ist ein Statusfenster mit dem Fortschritt anzuzeigen Grad des zu implementierenden Bean-Standards: vollständige Implementierung der per Reflection zu bekommenden Informationen (Eigenschaften + Events) Einfache Datentypen bearbeiten: int, double, float, char, long, short, byte, String Unsichtbare Beans Eingeschränkte Eigenschaften (vetos -> Rückmeldungen implementieren) Bean-eigene Eigenschaftseditoren (eigene Fenster) Bean-eigene Eigenschaftseditoren: getastet/setastet + gettags Bean-eigene Anpasser (Eigenschaftseditoren für mehrere Eigenschaften) 7.Qualitätsanforderungen Produktqualität sehr gut gut normal nicht relevant Funktionalität Angemessenheit Richtigkeit Interoperabilität Ordnungsmäßigkeit Sicherheit Zuverlässigkeit Reife Fehlertoleranz Wiederherstellbarkeit Benutzbarkeit Verständlichkeit Erlernbarkeit Bedienbarkeit Effizienz Zeitverhalten Verbrauchsverhalten Änderbarkeit Analysierbarkeit Modifizierbarkeit Stabilität Prüfbarkeit Übertragbarkeit

11 SWTP 04: JB-01 Pflichtenheft für GUI-Editor Mr. Bean Seite 11/12 Produktqualität sehr gut gut normal nicht relevant Anpassbarkeit Installierbarkeit Konformität Austauschbarkeit 8.Benutzungsoberfläche /B10/ /B20/ Die Bedienung des Programms erfolgt mit Maus und Tastatur. Eine Bedienung ohne Maus oder ohne Tastatur ist nicht vorgesehen. Das Aussehen der Dialoge und der Programmablauf orientieren sich am KDE Style Guide 9.Nichtfunktionale Anforderungen es gibt keine nichtfunktionale Anforderungen 10.Technische Produktumgebung Der Editor läuft auf einem Arbeitsplatzrechner mit grafischer Oberfläche. 1. Software Lauffähige Java VM mit Version >= Hardware Handelsüblicher PC / Notebook / Workstation mit Bildschirm, Tastatur und Zeigegerät (Maus, Touchpad) 3. Produktschnittstellen Es werden Java-Quellcodedateien und Java-Class-Dateien erzeugt, die dann weiterverarbeitet werden können. 11.Spezielle Anforderungen keine keine 1. Software 2. Hardware 3. Entwicklungsschnittstellen Es gibt keine Entwicklungsschnittstellen, auch keine Scripting-Schnittstellen

12 SWTP 04: JB-01 Pflichtenheft für GUI-Editor Mr. Bean Seite 12/12 12.Gliederung in Teilprodukte Es gibt keine Teilprodukte 13.Ergänzungen Es gibt keine Ergänzungen.