xmltree — u_pbt_xmltree #

← Referencia de componentes · Índice de la guía

xmltree muestra un valor XML como un árbol plegable, coloreado: una pantalla de configuración, una respuesta de API, una depuración de integración. Fija el texto XML en is_xml, el componente lo muestra; un clic en un nodo reporta su ruta (ue_node_clicked), un XML inválido lanza ue_error. No modifica nada: es un VISOR.

▶ Verlo en vivo — Aplicación de demostración, mosaico XML tree, con el código y esta página lado a lado.

De un vistazo #

Inicio rápido #

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

Propiedades #

Métodos #

Eventos #

Ejemplo #

Explorar la respuesta de una 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

Leer el valor de un nodo pulsado #

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

Buscar palabras completas, con mayúsculas #

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

Conservar los pliegues cuando se actualiza la respuesta #

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

Encontrar cada nodo de 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 menú sobre 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

Buenas prácticas #

• Es un visor, no un editor: muestra el XML, no lo cambia. Para leer un valor, pase la ruta de ue_node_clicked a n_pbt_xml.of_get_value sobre el mismo texto, o lea of_selected_value.
• Un XML grande sigue fluido: solo se dibujan las líneas en pantalla, una exportación de varios miles de líneas se recorre con el teclado sin esperas. Primero of_collapse_all sigue siendo lo más legible.
• Un XML inválido no rompe nada: ue_error lo dice (con la línea y la columna del fallo, en el idioma de visualización), y el árbol muestra el origen alrededor de la línea errónea. Es el retorno a mostrar, no un fallo.
• Un espacio de nombres por defecto (xmlns="urn:…", una respuesta SOAP): la ruta se escribe *[local-name()='Body'], la única forma que un XPath sin prefijo registrado sabe leer; un prefijo redeclarado con otro URI, o un hermano del mismo nombre en otro espacio, se escribe *[local-name()='x' and namespace-uri()='urn:…']. @xml:lang se lee tal cual. Una declaración xmlns se muestra pero no tiene ruta: XPath no la ve como un atributo.
• Lo que se muestra es XML: el valor de un atributo conserva sus comillas y sus saltos de línea codificados (
), un texto sus & y < y sus espacios significativos; solo desaparecen los saltos de línea de maquetación alrededor de un texto. Un espacio entre dos hijos (el espacio de <b>x</b> <i>y</i>) tiene su propia línea, mostrada ␠: forma parte del texto.
• Con el teclado: las flechas pasan de línea en línea, Flecha derecha recorre los atributos de una etiqueta antes de bajar, Av Pág avanza una pantalla (una sección CDATA de trescientas líneas cuenta por su altura), Ctrl+C copia el XML de la selección.
• De derecha a izquierda: un documento XML es un texto de izquierda a derecha, el árbol sigue así en una aplicación RTL (solo el cuadro de búsqueda sigue la dirección de la aplicación).

Heredado de la base común #

Estos miembros existen en todos los componentes visuales — no son propios de este. Se detallan una sola vez, en los capítulos transversales; esta tabla solo dice dónde leerlos.

← Referencia de componentes · Índice de la guía