enhancement
major
minor
major
minor
major
#29605
TL-Ansichten-Tabellenfilterleiste: eine anfänglich aktive Voreinstellung sowie die aktive Voreinstellung und der Suchbegriff als Kanäle für Abfrageverknüpfungen
Problem
Die Filterleiste von <table> (TableElement, com.top_logic.layout.view) bietet definierte <presets> als Kacheln, eine Freitextsuche über die angezeigten Spalten sowie benutzerspezifisch gespeicherte Filter. Zwei Dinge lassen sich damit nicht umsetzen, was beim Ersetzen der Schnellfilter-Symbolleistenbefehle der Ticketliste im Issue-Tracker tl-dev durch Voreinstellungen festgestellt wurde:
1. Keine Voreinstellung kann als anfänglich aktiv festgelegt werden
Eine Tabelle öffnet sich ungefiltert; die Voreinstellung ohne Kriterien („Alle“) ist markiert. Die letzte Auswahl des Benutzers wird über die Personalisierung unter dem Personalisierungsschlüssel der Tabelle wiederhergestellt, aber beim ersten Besuch, bei einem neuen Benutzer und bei einem skriptgesteuerten Test wird jeweils der gesamte Datensatz angezeigt. Eine Ticketliste, deren sinnvolle Standardeinstellung „die offenen Tickets“ ist (1.873 von 15.182 Zeilen in den importierten Daten), zeigt daher alles an, bis der Benutzer klickt. Bei den früheren Symbolleistenbefehlen bedeutete der nicht festgelegte Kanal „offen“; diese Standardeinstellung geht bei den Voreinstellungen verloren.
2. Die aktive Voreinstellung und der Suchbegriff haben keinen Kanal
TableElement liest seine Eingaben und schreibt den Auswahlkanal, aber weder der aktive benannte Filter noch der Suchbegriff erreichen einen Kanal. <query-bindings> (QueryBindingParticipant, #29530) bindet nur Kanäle, daher hat eine gefilterte Liste keine URL: /view/tickets?filter=mine war mit einem von einem Symbolleistenbefehl geschriebenen Kanal möglich und ist mit der Leiste nicht möglich. Ein von einem Entwickler bereitgestellter Link („die nicht zugewiesenen Tickets“) kann die Voreinstellung nicht benennen, und beim Neuladen wird der Filter aus der Personalisierung wiederhergestellt und nicht aus der Adresse.
Lösung
Anfänglich aktives Voreinstellung
<presets initial="open"> benennt die Voreinstellung, die angewendet wird, wenn die Tabelle für eine Sitzung erstellt wird, für die kein personalisierter Ansichtsstatus vorliegt. Das Attribut befindet sich auf dem Container, nicht auf dem einzelnen <preset>-Element, sodass genau eine Stelle den Standard benennen kann und ein unbekannter Name beim Start als Konfigurationsfehler gemeldet wird.
Die Entscheidung „Liegt eine Personalisierung vor?“ wird nur innerhalb von ` DefaultTableView.restore()` getroffen, das im Konstruktor ausgeführt wird und die einzige Stelle ist, an der die Regel „Personalisierung hat Vorrang vor dem konfigurierten Standard“ bereits implementiert ist (dieselbe Regel, der auch die Standardsortierung und die anfängliche Gruppierung folgen). Die Ansicht übernimmt daher die anfängliche benannte Filter-ID und wendet sie am Ende von `restore()` an, genau dann, wenn der `ViewStateStore` nichts für diese `TableId` enthält. Sobald der Benutzer selbst über die Filterung entschieden hat, hat die Personalisierung Vorrang – einschließlich der Entscheidung, den Filter zu löschen. Das Anwenden der anfänglichen Voreinstellung bewirkt an sich keine dauerhafte Speicherung, sodass eine nicht personalisierte Tabelle in jeder Sitzung davon ausgeht und dieser folgt, wenn ihre Kriterien neu definiert werden.
Aktive Voreinstellung und Suchbegriff als Kanäle
Zwei optionale Kanalbindungen für <table>, deklariert wie die bestehende Auswahl (und wie `range-start`/`range-end` von <calendar>):
- active-preset="channel" – die ID des benannten Filters, dem die Tabelle entspricht; null, wenn sie keinem entspricht. Wird von der Leiste geschrieben und angewendet, wenn von außen geschrieben wird. Die ID ist der Wert von NamedFilter.id(), d. h. ein deklarierter Voreinstellungsname oder – bei einem der vom Benutzer selbst gespeicherten Filter – dessen generierte ID.
- search-term="channel" – der Freitext der Suche in der Leiste, bidirektional.
Beides sind gewöhnliche Ansichtskanäle, daher fügt <query-bindings> sie in die Adresse ein (?filter=mine&q=…, ausgegeben mit replaceState wie jede rein abfragebezogene Änderung), ein <value-input> an anderer Stelle kann den Suchbegriff bearbeiten (die App-Leisten-Suche des Issue-Trackers), und ein Befehl kann die Voreinstellung wechseln. Eine Tabelle, die überhaupt keine Leiste anzeigt, wird auf dieselbe Weise über ihren Kanal durchsucht, und mehrere Tabellen, die an einen Suchkanal gebunden sind, werden gemeinsam durchsucht.
Eine an „active-preset“ geschriebene ID, die keinem benannten Filter entspricht, lässt die Tabelle ungefiltert, und die Bindung schreibt den tatsächlichen Zustand zurück, sodass sich eine veraltete oder falsch eingegebene Adresse von selbst korrigiert.
Eine Suche schränkt die Ergebnisse innerhalb der Voreinstellung ein
Damit die beiden Kanäle einen Satz von Zeilen beschreiben können, mussten der Suchbegriff und der benannte Filter voneinander unabhängig werden. NamedFilter.matches() verglich den Suchbegriff bedingungslos, und eine deklarierte Voreinstellung enthält niemals einen solchen (DeclaredFilters erstellt jede Deklaration ohne Suche), sodass jede Suche den Abgleich beendete, obwohl die Kriterien hinter dem Chip unberührt blieben: Die Tabelle zeigte weiterhin die durchsuchten Zeilen der Voreinstellung an, während die Adresse nur die Suche benannte und beim Neuladen einen anderen Zeilensatz wiedergab.
Der Suchbegriff fließt nun nur noch bei einem Filter in den Vergleich ein, der einen solchen definiert. Eine deklarierte Voreinstellung gleicht allein anhand ihrer Spalten ab, sodass der Chip aktiv bleibt, während der Benutzer darin sucht, und ?filter=mine&q=login ist die Adresse für „die Tickets, die ich kommentiert habe, nach ‚login‘ gesucht“ – es handelt sich um einen Round-Trip. Ein Filter, den der Benutzer während der Suche gespeichert hat, enthält den Suchbegriff und vergleicht ihn weiterhin exakt; und ein solcher Filter, der die vollständigere Beschreibung derselben Zeilen darstellt, ist der aktive Filter, während eine suchunabhängige Voreinstellung mit denselben Spalten ebenfalls übereinstimmen würde. Die Auswahl eines Chips ersetzt weiterhin die gesamte Filterung, einschließlich des Suchbegriffs.
Da jeder Schreiber jeweils nur einen Kanal festlegt – eine Abfragebindung schreibt einen gebundenen Parameter nach dem anderen –, versetzt ein Schreibvorgang in einen der beiden Kanäle die Tabelle in den Zustand, den beide beschreiben: zuerst den benannten Filter und dann den Suchbegriff. Würde nur der Kanal angewendet, der sich geändert hat, würde das Ergebnis davon abhängen, welcher der beiden unabhängigen Schreibvorgänge zuletzt erfolgte, sodass „?filter=mine&q=login“ je nach Reihenfolge der <bind> -Elemente entweder funktionieren oder den Suchbegriff verlieren würde.
Technische Umsetzung
Der aktive benannte Filter wird abgeleitet und nicht gespeichert, daher muss die Benachrichtigung von der Ansicht und nicht vom Filterleisten-Steuerelement kommen:
- TableViewListener erhält einen filterChanged() -Callback (eine Standardmethode, sodass bestehende Listener davon unberührt bleiben), der von DefaultTableView ausgelöst wird, sobald sich die Spaltenfilter, der Suchbegriff oder die angebotenen benannten Filter ändern – einschließlich setDeclaredFilters(), das den aktiven deklarierten Filter erneut anwendet, sobald sich eine Eingabe in der Tabelle ändert, sowie das Speichern und Löschen eines Filters, wodurch sich ändert, welcher Filter aktiv ist, ohne dass sich irgendwelche Kriterien ändern.
- Ein „TableFilterBinding“ neben dem „TableSelectionBinding“ verbindet diesen Callback bidirektional mit den beiden Kanälen, mit einer Reentrancy-Prüfung und einem „dispose()“ -Aufruf bei der Bereinigung. TableElement richtet es sowohl im schreibgeschützten als auch im bearbeitbaren Pfad ein; das bearbeitbare RowSetTableControl baut sein internes Tabellensteuerelement bei jedem Wechsel in den Bearbeitungsmodus neu auf und stellt die Bindung ebenso wie die Auswahlbindung wieder her.
- Die Bindung steuert die Tabelle über das „TableViewControl“ statt über die Ansicht, sodass eine auf einem Kanal eintreffende Änderung die Chips und das Suchfeld neu rendert, genau wie bei einer Änderung in der Leiste. Die Methoden „applyNamedFilter“, „clearFilter“ und „search“ sind eigene Implementierungen der Befehlshandler, die zu diesem Zweck zugänglich gemacht wurden.
Die Beobachtung der Ansicht anstelle des Filterleisten-Steuerelements sorgt außerdem dafür, dass die Kanäle auch bei einer Tabelle funktionieren, deren Leiste ausgeblendet ist (TableViewControl.refreshFilterBar() kehrt in diesem Fall vorzeitig zurück).
Es sind weder Änderungen an <query-bindings> noch neuer Client-Code erforderlich: Die React-Filterleiste rendert bereits den „activeNamedFilter“- und den „search“- Zustand, den der Server übermittelt.
Dokumentation
Ein Abschnitt zur Filterleiste in docs/faq/react-view-layer.md sowie die Objektlisten-Demo von com.top_logic.demo.react, die Voreinstellungen mit einer Anfangsvoreinstellung verwendet – sowohl Kanäle als auch die daraus resultierenden Abfragebindungen.