enhancement
major
minor
major
minor
major
#29622
TL-Ansichten: Ein `<flow-diagram selection="ch">` schreibt seinen Kanal, folgt ihm jedoch nicht, sodass ein an anderer Stelle ausgewählter Knoten im Diagramm nicht markiert wird.
Problem
Ein <flow-diagram selection="ch"> veröffentlicht das Benutzerobjekt des Knotens, auf den der Benutzer klickt, in seinen Auswahlkanal, beobachtet diesen Kanal jedoch nicht: Ein Wert, der von einem anderen Element in den Kanal geschrieben wird, lässt die eigene Markierung des Diagramms unverändert.
Beobachtet auf der Seite „Flow Diagram“ der React-Demo (demo/flow-diagram-demo.view.xml, seit #29613 ein Dashboard), wo sich das Diagramm, eine <table selection="selectedNode"> der Build-Schritte und ein <form input="selectedNode"> einen Kanal teilen. Ein Klick auf den Knoten „Querträger“ im Diagramm wählt dessen Zeile in der Tabelle aus, füllt das Formular aus und markiert den Knoten (tlSelected). Wählt man dann in der Tabelle die Zeile „Unterboden“ aus, wird das Formular mit „Unterboden“ ausgefüllt, aber im Diagramm bleibt „Querträger“ markiert, sodass zwei Selektoren desselben Kanals unterschiedliche Auswahlen anzeigen. Ein an denselben Kanal gebundenes <table> folgt diesem in beide Richtungen.
In der React-Demo-App (tl-demo-react) ist die Markierung zudem überhaupt nicht sichtbar, nicht einmal für einen im Diagramm angeklickten Knoten: Die Demo zeichnet ihre Markierung als Rahmen und Füllung mit der Klasse tlSelectionMarker, die das React-Flow-Stylesheet tl-react-flow.css ausblendet, und die Regel, die sie bei einem ausgewählten Knoten anzeigt, existiert nur im Stylesheet tl-blocks.css der veralteten graphic.blocks-Module, die nur von der veralteten tl-demo bereitgestellt werden. Auch die Zoom-Anzeige des React-Diagramm-Controls wird ausschließlich durch dieses veraltete Stylesheet gestylt.
Analyse
`FlowDiagramElement` löst die Referenz auf den Auswahlkanal auf und übergibt sie an `FlowDiagramControl.setSelectionChannel()`, das diese lediglich speichert. Das Steuerelement ruft _selectionChannel.set(...) auf, wenn der Client eine Auswahländerung meldet und nach einem Neuaufbau des Diagramms, registriert jedoch keinen ViewChannel.ChannelListener für den Kanal und verfügt über keinen Pfad von einem Kanalwert zurück zu den ausgewählten „SelectableBox“-Knoten des Diagramms auf dem Client. Die Dokumentation zu Config#getSelection() beschreibt den Kanal als schreibgeschützt („um das Benutzerobjekt des ausgewählten Knotens zu schreiben“), was der Code auch tut; allerdings muss auch ein Kanal beachtet werden, den andere Selektoren gemeinsam nutzen.
Der Transport in umgekehrter Richtung existiert bereits: Das Diagrammmodell ist ein gemeinsam genutzter „msgbuf“-Graph, der Server-Bereich überwacht jeden von ihm serialisierten Knoten, und `FlowDiagramControl.pushDiagramChanges()` übermittelt aufgezeichnete Änderungen als „diagramPatch“-Zustandsaktualisierung, die der Client anwendet und Knoten für Knoten neu zeichnet (`SelectableBoxOperations.draw ` schreibt `tlSelected`). Vom Benutzer vorgenommene Auswahländerungen werden in umgekehrter Richtung als dieselbe Art von Patch (Update-Befehl ) übertragen; der Auswahlbefehl, den das Steuerelement ebenfalls verarbeitet, wird vom Client niemals gesendet.
Lösung
Die Regeln, nach denen ein Selektor einen Kanal mit anderen Selektoren teilt, sind diejenigen, die bereits für <table> in TableSelectionBinding implementiert sind: Der Selektor schreibt nur dann in den Kanal, wenn eine Auswahl in ihm selbst getroffen wurde oder wenn eine angezeigte Auswahl nach einer Aktualisierung verschwunden ist; ein Wert, den er lediglich nicht anzeigt, bedeutet „hier ist nichts ausgewählt“ und lässt den Kanal unberührt (er könnte zu einem anderen Selektor über eine andere Objektmenge gehören); das eigene Echo eines angewendeten Werts durch den Selektor wird niemals zurückgeschrieben. Diese Regeln werden in das generische `SelectionChannelBinding` in `com.top_logic.layout.view.model` extrahiert, mit Hooks für die angezeigte Auswahl, für das Anwenden einer Auswahl und dafür, ob mehrere Werte angezeigt werden können; `TableSelectionBinding` ist eine Unterklasse davon. Mehrere ausgewählte Werte werden von beiden Selektoren als Set geschrieben.
FlowDiagramControl verfügt über eine Auswahl-API (die ausgewählten Benutzerobjekte, das Auswählen von Benutzerobjekten, einen Auswahl-Listener, der nach einem Client-Patch benachrichtigt wird, und einen Modell-Listener, der nach einem Neuaufbau des Diagramms benachrichtigt wird), und „DiagramSelectionBinding“ bindet diese an den Kanal: Ein von außen gesetztes Wert-Set wird den Knoten zugeordnet, die es als Benutzerobjekt tragen; die Knoten werden im Servermodell markiert und die Änderung wird als Patch an den Client übertragen. Die Knoten werden mit WidgetTraversal (com.top_logic.react.flow.common) ermittelt, einem generischen Durchlauf über jedes Widget, das vom Diagramm aus über die modell-eigenen Eigenschaftswerte erreichbar ist. Nach einem Neuaufbau des Diagramms anhand seiner Eingaben wird die Auswahl auf die Knoten übertragen, die das neue Diagramm noch enthält; die Bindung wendet den Kanalwert erneut an, und erst dann wird das Diagramm serialisiert, sodass die Markierung Teil des Diagramms ist, das der Client einbindet, und nicht Teil eines Patches, der der erneuten Einbindung vorgreift; Ein angezeigter Knoten, der im neuen Diagramm kein Gegenstück hat, wird wie zuvor (#29462) aus dem Kanal entfernt. Die Bindung wird gelöst, wenn das Steuerelement bereinigt wird. Die schreibgeschützte Funktion `setSelectionChannel()` und der ungenutzte Befehlshandler für die Auswahl werden entfernt; es sind keine Änderungen am Client-Code erforderlich.
tl-react-flow.css zeigt die tlSelectionMarker-Elemente eines ausgewählten Knotens an und gestaltet den Zoom-Indikator (Theme-Tokens, die wieder ausgeblendet werden, sobald die „invisible“-Klasse des Indikators gesetzt ist), sodass das React-Flussdiagramm für beides nicht mehr auf ein veraltetes Stylesheet angewiesen ist.
Die Demoseite „Flow Diagram“ dient als Testumgebung: Die Auswahl einer Zeile in der Tabelle „Build steps“ markiert den entsprechenden Knoten im „Construction Plan“, und ein Klick auf einen Knoten wählt weiterhin dessen Zeile aus. Die Demo zeichnet zudem, wie die alte Demo, das Bild jedes Build-Schritts in dessen Knoten ein, und ihre Tabelle „Build-Schritte“ verfügt nicht mehr über eine Filterleiste (diese nahm den größten Teil der Kachel ein). „TestDiagramSelectionBinding“ deckt die Kanalregeln ab, einschließlich des Client-Patch-Pfads und der Fälle für einen Neuaufbau.
Das <tree> -Element folgt bereits seinem Kanal (#29502) über sein eigenes „TreeSelectionBinding“, eine parallele Implementierung derselben Regeln; die Einbindung in „SelectionChannelBinding“ ist ein separater Arbeitszweig.