major
#29429
Vervollständigen Sie den View-Designer, damit damit eine Ansicht von Anfang bis Ende erstellt werden kann.
Ziel
Der View-Designer kann eine Ansicht anzeigen und skalare Eigenschaften bearbeiten, lässt sich jedoch nicht zum eigentlichen Erstellen einer Ansicht verwenden. Dieses Ticket vervollständigt ihn so weit, dass ein Element erstellt, ausgefüllt, platziert und gespeichert werden kann, ohne den Designer zu verlassen oder die Anwendung neu zu starten. Alle dabei auftretenden Aspekte werden hier behandelt.
Fehler
Strukturelle Bearbeitungen wurden nicht in die Konfiguration übernommen
Die Befehle„Add Child“, „Remove“ und „Move“ veränderten nur den Spiegelbaum „DesignTreeNode“, niemals jedoch das zugrunde liegende „ConfigurationItem“, sodass beim Anwenden serialisierter, unveränderter Konfigurationen keine Änderungen dauerhaft gespeichert wurden. Dabei waren drei separate Ursachen beteiligt:
- Die Befehle haben die zugehörige Konfigurationseigenschaft nie berührt.
- ReactTreeControl übertrug Kontextmenü-Einträge als Status, den keine Client-Komponente rendert, sodass das Menü überhaupt nicht angezeigt wurde.
- Nur „AppShellElement“ stellte einen „ContextMenuOpener“ bereit, sodass eine Ansicht ohne App-Shell (der Designer selbst) kein Overlay hatte, in das ein Menü gerendert werden konnte. Die Overlays auf Fensterebene (Menü, Dialogmanager, Snackbar) gehören nun zum Fenster.
Beim Hinzufügen gab es keine Auswahlmöglichkeit für den Elementtyp
Der „AddChildCommand“ verwendete fest „StackElement“, und der Listeneditor des Formulars wählte stillschweigend die erste polymorphe Option. Ein Container für UI-Elemente akzeptiert etwa 60 Typen, daher werden diese als Menü mit den Typen angeboten, die die Ziel-Eigenschaft tatsächlich zulässt.
Eine gespeicherte Ansicht konnte die Anwendung zum Absturz bringen
Ein Editor kann eine Konfiguration erzeugen, die zwar serialisiert werden kann, vom View-Loader jedoch abgelehnt wird – beispielsweise ein Element, das hinzugefügt, aber nicht ausgefüllt wurde, oder zwei Einträge einer schlüsselbasierten Liste, die denselben Schlüssel teilen. Das Speichern führte dazu, dass die Anwendung die Ansicht nicht mehr laden konnte. Die Überprüfung einzelner Einschränkungen ist der falsche Ansatz, da der Reader viele davon durchsetzt; die serialisierte Ansicht wird nun über den eigenen Parser des Loaders zurückgelesen, bevor etwas geschrieben wird.
Eine Ansicht, die nicht geladen werden konnte, brachte die gesamte Anwendung zum Absturz
Eine einzige fehlerhafte .view.xml-Datei machte die gesamte Anwendung unbrauchbar, da „ReferenceElement.createControl“ eine Ausnahme auslöste, wenn die referenzierte Ansicht nicht geladen werden konnte. Die Ausnahme breitete sich über den gesamten Steuerelementbaum aus, sodass die Seite mit einem internen Fehler abstürzte, anstatt gerendert zu werden – Navigation, App-Leiste und der View Designer waren ebenfalls nicht mehr erreichbar, einschließlich des Designers, der zur Behebung des Fehlers benötigt wurde.
Eine Ansicht, deren Laden fehlschlägt, ersetzt nun nur noch sich selbst: ReferenceElement rendert einen Platzhalter, der die Ansicht und den Grund nennt, sodass der Rest der Anwendung weiter funktioniert und der Fehler dort sichtbar ist, wo er auftritt. Der Designbaum verhielt sich bereits über `ErrorDesignTreeNode` auf diese Weise; die Anwendungsseite fehlte noch.
Eine fehlerhafte Root-Ansicht kann nach wie vor nicht gerendert werden: Es gibt keinen übergeordneten Steuerelementbaum, auf den zurückgegriffen werden kann, und der Designer kann aus einer nicht parsbaren Datei ebenfalls keinen Designbaum erstellen. Um dies abzudecken, sind eine Fallback-Seite sowie ein Designer erforderlich, der eine Datei darstellen kann, die er nicht parsen kann.
Ein hinzugefügtes Element konnte nicht ausgefüllt oder verwendet werden
- Ein neu hinzugefügter Knoten wurde direkt statt über den Baum-Builder erstellt, sodass er nicht an die Eigenschaften seines eigenen Containers gebunden war: Einem gerade erstellten Reiter konnte nichts hinzugefügt werden, bis der gesamte Designer erneut geöffnet wurde.
- Beim Bearbeiten einer identifizierenden Eigenschaft zeigte der Baum weiterhin die vorherige Bezeichnung an.
- Ein Element, das einer Schlüssel-Liste hinzugefügt wurde, erhielt keinen Schlüssel, sodass eine Registerkarte mit einer leeren ID erstellt wurde – und da TypedConfiguration einen zweiten Eintrag mit demselben leeren Schlüssel ablehnt, konnte eine zweite Registerkarte überhaupt nicht hinzugefügt werden.
- Eine strukturelle Bearbeitung führte zum Zusammenklappen des Baums; die Erweiterung bleibt erhalten, und das Entfernen eines Elements wählt dessen übergeordnetes Element aus.
- Ein Reiter ohne Bezeichnung wurde als leerer Reiter dargestellt, sodass ein im Designer hinzugefügter Reiter in der Anwendung unsichtbar war. Die Bezeichnung fällt auf die Reiter-ID zurück, solange keine Bezeichnung konfiguriert ist.
Editoren für jede Art von Eigenschaft
Für einige Eigenschaftstypen gab es überhaupt keinen Editor, sodass eine Ansicht im Formular nicht vervollständigt werden konnte:
- Eine Eigenschaft, deren Werte keine Zeichenketten sind (z. B. eine Kanalreferenz input="model"), wurde über ein reines Texteingabefeld bearbeitet, das der Eigenschaft eine Zeichenkette übergab, die diese nicht speichern kann, sodass die Eingabe stillschweigend verloren ging. Eine solche Eigenschaft wird nun gemäß der Spezifikation bearbeitet, die die Konfigurationsdatei dafür verwendet, umgewandelt durch das eigene Wertformat der Eigenschaft.
- Modellattribute und Konfigurationseigenschaften verfügten über separate Editor-Sätze, sodass jeder Editor doppelt erstellt werden musste. Nun gibt es einen einzigen Satz, der anhand des Java-Typs des bearbeiteten Werts (FieldControlRegistry in der React-Schicht) ermittelt wird und sowohl von der Modellseite als auch von den Konfigurationseigenschaften gespeist wird. Eine einzelne Eigenschaft weicht durch eine FieldControl-Annotation davon ab.
- Eine DERIVED -Eigenschaft wurde vollständig übersprungen, anstatt schreibgeschützt angezeigt zu werden. Eine Eigenschaft wird nun nur dann ausgeblendet, wenn dies ausdrücklich festgelegt ist.
- Eine Annotation, die auf der Eigenschaft deklariert war, die eine Konfiguration überschrieb, wurde nicht berücksichtigt, sodass @Hidden keine Auswirkung auf eine geerbte Eigenschaft hatte – die Typ-Eigenschaft einer polymorphen Konfiguration wurde zur Bearbeitung angeboten.
- Eine Eigenschaft, die ein Konfigurationselement enthält, das die Konfiguration als Text schreibt – einen TL-Script-Ausdruck –, wurde als Formular über ihrem Syntaxbaum dargestellt und bei fehlender Einstellung gar nicht, sodass kein Skript eingegeben werden konnte.
- Ein Skript in einer Konfiguration wird nun im selben TL-Script-Editor bearbeitet, den auch die Skriptkonsole verwendet, mit Syntaxhervorhebung und Inline-Parsing-Diagnosen. Das Steuerelement zur Bearbeitung einer bestimmten Wertart kann für einen einfachen Java-Typ deklariert werden, sodass ein Werttyp, der durch keinen Modelltyp beschrieben wird, über das Modul, das ihn definiert, in den Editor gelangt.
Es werden nur allgemein verwendbare Implementierungen angeboten
Die Element-, Befehls- und Aktionsauswahlen boten bisher jede Implementierung an, darunter viele, die für einen einzigen Anwendungsfall geschrieben wurden. Sie bieten nun die Implementierungen an, die über @InApp als allgemein verwendbar klassifiziert wurden, wodurch das Elementmenü von 63 auf 40 Einträge reduziert wurde. Die Implementierungen wurden entsprechend klassifiziert.
Eine generische Aktion darf ihre Eingabe nicht ausführen
Die Skript-Aktion der React-Ebene kompilierte und führte jeden Wert aus, der auf ihrem Eingabekanal eintraf, sodass jeder konfigurierbare Datenpfad ein Codepfad war. Die generische Aktion bezieht ihr Skript aus ihrer Konfiguration und übergibt die Eingabe des Befehls als Argument an dieses. Das Kompilieren der Eingabe selbst verbleibt in der TL-Script-Konsole, in einer Aktion, die kein Tag beansprucht und nicht als Baustein angeboten wird.
Eine polymorphe Konfigurationsreferenz muss einen Platzhalter verwenden
Eine Eigenschaft, die auf eine polymorphe Konfiguration verweist, muss ihren Basistyp als Platzhalterangabe benennen, da der in der Eigenschaft gespeicherte Wert die Konfiguration einer Implementierung dieses Typs ist:
{{{#!java PolymorphicConfiguration<? extends Renderer> getRenderer(); // korrekt PolymorphicConfiguration<Renderer> getRenderer(); // falsch }}}
Ohne den Platzhalter beschreibt die Eigenschaft nicht, was sie enthalten kann, und die Deklaration bleibt bei einer Suche nach den Eigenschaften eines bestimmten Basistyps unsichtbar. So wurden diese gefunden: Die ViewAction-Selektoren der Ansichtsebene konnten bei der Suche nach `PolymorphicConfiguration<? extends ViewAction>` nicht gefunden werden. Diese fünf Deklarationen werden hier korrigiert.
Es verbleiben noch279 weitere Deklarationen in 21 Modulen. Die vollständige Liste – eine Zeile pro Deklaration im Format Modul :: Pfad:Zeile Deklaration, gruppiert nach Modul – wurde unter
docs/sweeps/polymorphic-configuration-wildcards.md
eingecheckt, damit sie im Verlauf des Sweeps verglichen werden kann. Sie wird mit folgendem Befehl neu generiert:
grep -rnE „(Named)?PolymorphicConfiguration<[A-Z]“ --include=*.java | grep -v /target/ \\
| grep -v "extends PolymorphicConfiguration<" | grep -E "(get|set|is)[A-Z]\\w*\\s*\\("
Nicht betroffen und nicht zu ändern: interface Config extends PolymorphicConfiguration<MyImpl> – eine Konfiguration benennt die von ihr konfigurierte Implementierung korrekt – sowie eine Parametrisierung durch eine Typvariable.
Durch Hinzufügen des Platzhalters liefert ein Stream der konfigurierten Instanzen einen erfassten Typ, sodass das Sammeln in einer typisierten Liste einen expliziten Typ-Witness erfordert, z. B. .<ViewAction> map(context::getInstance).
Verifizierung
Eine Registerkarte, ein darin enthaltenes Panel und ein darin enthaltenes Textelement wurden ausschließlich über den Designer erstellt, wobei die Registerkarten-ID und die Kanalbindung des Texts im Konfigurationsformular eingegeben und auf „Übernehmen“ geklickt wurde. Das Ergebnis lautet
{{{#!xml <tab id="designer-tab">
<panel>
<text input="gridAnchor"/>
</panel>
</tab> }}}
und die laufende Anwendung zeigt die neue Registerkarte an, wählt sie aus und rendert den Wert des gebundenen Kanals – ohne Neustart.
Der TL-Script-Editor wurde sowohl für eine Skript-Eigenschaft einer bestehenden Aktion als auch für eine neu hinzugefügte Aktion getestet: Er zeigt den tatsächlichen Quellcode an, Änderungen werden beibehalten und Syntaxfehler werden als Inline-Diagnose angezeigt. Die Skriptkonsole bleibt davon unberührt.
Migration
Eine Anwendung, die den React-Feldsteuerungsanbieter der Ansichtsebene implementiert, muss stattdessen die gemeinsame Schnittstelle verwenden:
com.top_logic.layout.view.form.ReactFieldControlProvider -> com.top_logic.layout.react.field.ReactFieldControlProvider
Die Methode behält ihre Funktion bei, erhält jedoch anstelle des Modellattributs ein `FieldSpec`, das den bearbeiteten Wert beschreibt, sodass dasselbe Steuerelement sowohl ein Modellattribut als auch eine Konfigurationseigenschaft bedient. Ein über den `FieldControlService` für einen Modelltyp registrierter Provider muss nicht geändert werden.
Eine Anwendungsimplementierung von ` UIElement`, `ReactCommand` oder `ViewAction`, die in den Auswahlfeldern des Designers angeboten werden soll, muss das Annotation `@InApp` tragen; ohne diese bleibt sie zwar konfigurierbar, wird aber nicht mehr aufgelistet.
Nicht behandelt
Die Serialisierung normalisiert die Datei und entfernt XML-Kommentare. Das normalisierte Layout ist beabsichtigt; der Verlust von Kommentaren ist eine verbleibende Folge.