xmltree — u_pbt_xmltree #

← Référence des composants · Sommaire du guide

xmltree affiche une valeur XML comme un arbre repliable, coloré : un écran de configuration, une réponse d'API, un débogage d'intégration. Vous posez le texte XML dans is_xml, le composant le montre ; un clic sur un nœud rapporte son chemin (ue_node_clicked), un XML invalide lève ue_error. Il ne modifie rien : c'est un VISUALISEUR.

▶ Le voir en vrai — Application de démonstration, tuile XML tree, avec le code et cette page côte à côte.

En bref #

Démarrage rapide #

// 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

Propriétés #

Méthodes #

Événements #

Exemple #

Explorer la réponse d'une API #

// 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

Lire la valeur d'un nœud cliqué #

// 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()

Chercher des mots entiers, casse comprise #

// 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")

Garder les plis quand la réponse est rafraîchie #

// 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)

Trouver chaque nœud d'un XPath #

// 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()

Un menu sur un nœud #

// 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

Bonnes pratiques #

• C'est un visualiseur, pas un éditeur : il montre le XML, il ne le change pas. Pour lire une valeur, donnez le chemin de ue_node_clicked à n_pbt_xml.of_get_value sur le même texte, ou lisez of_selected_value.
• Un gros XML reste fluide : seules les lignes à l'écran sont dessinées, un export de plusieurs milliers de lignes se parcourt au clavier sans attente. of_collapse_all d'abord reste le plus lisible.
• Un XML invalide ne casse rien : ue_error le dit (avec la ligne et la colonne de la faute, dans la langue d'affichage), et l'arbre montre la source autour de la ligne fautive. C'est le retour à montrer, pas un plantage.
• Un espace de noms par défaut (xmlns="urn:…", une réponse SOAP) : le chemin s'écrit *[local-name()='Body'], la seule forme qu'un XPath sans préfixe enregistré sait lire ; un préfixe redéclaré avec un autre URI, ou un frère de même nom dans un autre espace, s'écrit *[local-name()='x' and namespace-uri()='urn:…']. @xml:lang se lit tel quel. Une déclaration xmlns s'affiche mais n'a pas de chemin : XPath ne la voit pas comme un attribut.
• Ce qui s'affiche est du XML : une valeur d'attribut garde ses guillemets et ses retours à la ligne codés (
), un texte ses & et <, ses blancs significatifs ; seuls les retours à la ligne de mise en page autour d'un texte disparaissent. Un blanc entre deux enfants (l'espace de <b>x</b> <i>y</i>) a sa propre ligne, montrée ␠ : il fait partie du texte.
• Au clavier : les flèches passent de ligne en ligne, Flèche droite parcourt les attributs d'une balise avant de descendre, Page bas avance d'un écran (une section CDATA de trois cents lignes compte pour sa hauteur), Ctrl+C copie le XML de la sélection.
• De droite à gauche : un document XML est un texte de gauche à droite, l'arbre le reste dans une application en RTL (seule la zone de recherche suit le sens de l'application).

Hérité du socle commun #

Ces membres existent sur tous les composants visuels — ils ne sont pas propres à celui-ci. Ils sont détaillés une seule fois, dans les chapitres transverses ; cette table dit seulement où les lire.

← Référence des composants · Sommaire du guide