xmltree — u_pbt_xmltree #

← Riferimento dei componenti · Sommario della guida

xmltree mostra un valore XML come un albero comprimibile, colorato: una schermata di configurazione, una risposta API, un debug di integrazione. Imposti il testo XML in is_xml, il componente lo mostra; un clic su un nodo riporta il suo percorso (ue_node_clicked), un XML non valido solleva ue_error. Non modifica nulla: è un VISUALIZZATORE.

▶ Vederlo dal vivo — Applicazione dimostrativa, tessera XML tree, con il codice e questa pagina fianco a fianco.

In breve #

Avvio rapido #

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

Proprietà #

Metodi #

Eventi #

Esempio #

Esplorare una risposta 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

Leggere il valore di un nodo cliccato #

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

Cercare parole intere, maiuscole comprese #

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

Mantenere le pieghe quando la risposta viene aggiornata #

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

Trovare ogni nodo di 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 su un nodo #

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

Buone pratiche #

• È un visualizzatore, non un editor: mostra il XML, non lo cambia. Per leggere un valore, passa il percorso di ue_node_clicked a n_pbt_xml.of_get_value sullo stesso testo, oppure leggi of_selected_value.
• Un XML grande resta fluido: si disegnano solo le righe a schermo, un'esportazione di diverse migliaia di righe si scorre con la tastiera senza attese. Prima of_collapse_all resta la cosa più leggibile.
• Un XML non valido non rompe nulla: ue_error lo dice (con la riga e la colonna dell'errore, nella lingua di visualizzazione), e l'albero mostra il sorgente attorno alla riga errata. È il ritorno da mostrare, non un crash.
• Uno spazio dei nomi predefinito (xmlns="urn:…", una risposta SOAP): il percorso si scrive *[local-name()='Body'], l'unica forma che un XPath senza prefisso registrato sa leggere; un prefisso ridichiarato con un altro URI, o un fratello con lo stesso nome in un altro spazio, si scrive *[local-name()='x' and namespace-uri()='urn:…']. @xml:lang si legge così com'è. Una dichiarazione xmlns si vede ma non ha percorso: XPath non la vede come un attributo.
• Ciò che si vede è XML: il valore di un attributo mantiene le virgolette e gli a capo codificati (
), un testo i suoi & e < e gli spazi significativi; spariscono solo gli a capo di impaginazione attorno a un testo. Uno spazio tra due figli (lo spazio di <b>x</b> <i>y</i>) ha una riga sua, mostrata ␠: fa parte del testo.
• Da tastiera: le frecce passano di riga in riga, Freccia destra percorre gli attributi di un tag prima di scendere, Pag giù avanza di una schermata (una sezione CDATA di trecento righe conta per la sua altezza), Ctrl+C copia il XML della selezione.
• Da destra a sinistra: un documento XML è un testo da sinistra a destra, l'albero resta tale in un'applicazione RTL (solo la casella di ricerca segue la direzione dell'applicazione).

Ereditato dalla base comune #

Questi membri esistono su tutti i componenti visivi — non sono propri di questo. Sono descritti una sola volta, nei capitoli trasversali; questa tabella dice solo dove leggerli.

← Riferimento dei componenti · Sommario della guida