xmltree — u_pbt_xmltree #

← Komponentenreferenz · Inhalt des Handbuchs

xmltree zeigt einen XML-Wert als einklappbaren Baum, farbcodiert: ein Konfigurationsbildschirm, eine API-Antwort, ein Integrations-Debug. Sie setzen den XML-Text in is_xml, die Komponente zeigt ihn; ein Klick auf einen Knoten meldet seinen Pfad (ue_node_clicked), ungültiges XML löst ue_error aus. Sie ändert nichts: sie ist ein BETRACHTER.

▶ Live sehen — Demoanwendung, Kachel XML tree, mit dem Code und dieser Seite nebeneinander.

Auf einen Blick #

Schnellstart #

// Show an XML response as a tree
uo_xml.is_xml = inv_rest.of_response_text()

// Fold everything, then let the user open what interests them
uo_xml.of_collapse_all()

// ue_node_clicked : the path of the node clicked, an XPath ("/order/lines/line[2]",
// "/order/@id" for an attribute) -> n_pbt_xml.of_get_value(as_path) reads its value

Eigenschaften #

Methoden #

Ereignisse #

Beispiel #

Eine API-Antwort erkunden #

// Show the XML an API answered, or nothing if the call failed
if inv_rest.of_get(/*url*/ "https://api.example.com/orders/4152") = 200 then
	uo_xml.is_xml = inv_rest.of_response_text()
	uo_xml.of_collapse_all()          // the reader opens what interests them
else
	uo_xml.of_clear()
end if

Den Wert eines angeklickten Knotens lesen #

// Instance variable of the window : the answer, loaded ONCE by n_pbt_xml
n_pbt_xml inv_xml

// open event of the window : n_pbt_xml is created once, owned by the window
inv_xml = create n_pbt_xml
inv_xml.ipo_owner = this

// When the answer arrives : the tree shows it, n_pbt_xml loads the same text once
uo_xml.is_xml = inv_rest.of_response_text()
inv_xml.of_load(/*xml*/ inv_rest.of_response_text())

// ue_node_clicked of uo_xml : the value at the clicked path, nothing loaded again
st_value.text = inv_xml.of_get_value(/*xpath*/ as_path)

// or, without a second parser : the value of the selection, decoded
st_value.text = uo_xml.of_selected_value()

Ganze Wörter suchen, Groß-/Kleinschreibung beachtet #

// Whole words only, with the same case : "id" is not found inside "user_id"
uo_xml.ib_find_match_case = true
uo_xml.ib_find_whole_word = true
uo_xml.of_search(/*query*/ "id")

Die Faltungen behalten, wenn die Antwort aktualisiert wird #

// Local variables
string ls_layout

// The folds, the selected node and the line at the top, kept before the new text
ls_layout = uo_xml.of_get_layout()
uo_xml.is_xml = inv_rest.of_response_text()

// The same elements fold again ; a path the new text no longer has is ignored
uo_xml.of_set_layout(/*layout_json*/ ls_layout)

Jeden Knoten eines XPath finden #

// Local variables
long ll_found

// Every order line of more than one item : highlighted, the first one selected
ll_found = uo_xml.of_find_xpath(/*xpath*/ "//line[@qty > 1]")

// A Next button walks them, like F3 ; ue_search_result feeds a "2 / 5" status line
if ll_found > 1 then uo_xml.of_search_next()

// What is selected, without a second parser
st_kind.text = uo_xml.of_selected_kind() + " " + uo_xml.of_selected_name()

Ein Menü auf einem Knoten #

// ue_node_rclicked of uo_xml : the node is selected, open YOUR menu at that point of the screen
uo_menu.of_show(/*x*/ al_x, /*y*/ al_y)

// ue_item_selected of uo_menu : copy the XML of the node, or its path for n_pbt_xml
choose case as_keys
	case "copy"
		uo_xml.of_copy()
	case "copypath"
		uo_xml.of_copy_path()
end choose

Bewährte Praxis #

• Es ist ein Betrachter, kein Editor: er zeigt das XML, er ändert es nicht. Um einen Wert zu lesen, übergeben Sie den Pfad aus ue_node_clicked an n_pbt_xml.of_get_value auf demselben Text, oder lesen Sie of_selected_value.
• Ein großes XML bleibt flüssig: nur die Zeilen auf dem Bildschirm werden gezeichnet, ein Export von mehreren tausend Zeilen lässt sich ohne Wartezeit mit der Tastatur durchlaufen. Zuerst of_collapse_all bleibt am lesbarsten.
• Ungültiges XML bricht nichts: ue_error sagt es (mit Zeile und Spalte des Fehlers, in der Anzeigesprache), und der Baum zeigt die Quelle um die fehlerhafte Zeile. Das ist die zu zeigende Rückmeldung, kein Absturz.
• Ein Standard-Namensraum (xmlns="urn:…", eine SOAP-Antwort): der Pfad wird *[local-name()='Body'] geschrieben, die einzige Form, die ein XPath ohne registriertes Präfix lesen kann; ein mit anderer URI erneut deklariertes Präfix oder ein gleichnamiges Geschwister in einem anderen Namensraum wird *[local-name()='x' and namespace-uri()='urn:…'] geschrieben. @xml:lang wird unverändert gelesen. Eine xmlns-Deklaration wird angezeigt, hat aber keinen Pfad: XPath sieht sie nicht als Attribut.
• Was angezeigt wird, ist XML: ein Attributwert behält seine Anführungszeichen und seine kodierten Zeilenumbrüche (
), ein Text seine & und < und seine bedeutsamen Leerzeichen; nur die Layout-Zeilenumbrüche um einen Text entfallen. Ein Leerraum zwischen zwei Kindern (das Leerzeichen von <b>x</b> <i>y</i>) hat eine eigene Zeile, als ␠ gezeigt: er gehört zum Text.
• Mit der Tastatur: die Pfeile gehen von Zeile zu Zeile, Pfeil rechts durchläuft die Attribute eines Tags, bevor er absteigt, Bild ab springt um einen Bildschirm (ein CDATA-Abschnitt von dreihundert Zeilen zählt mit seiner Höhe), Strg+C kopiert das XML der Auswahl.
• Von rechts nach links: ein XML-Dokument ist ein Text von links nach rechts, der Baum bleibt so in einer RTL-Anwendung (nur das Suchfeld folgt der Richtung der Anwendung).

Vom gemeinsamen Sockel geerbt #

Diese Mitglieder gibt es bei jeder visuellen Komponente — sie sind nicht dieser eigen. Sie werden einmal in den übergreifenden Kapiteln beschrieben; diese Tabelle sagt nur, wo man sie liest.

← Komponentenreferenz · Inhalt des Handbuchs