xmltree — u_pbt_xmltree #

← Referência dos componentes · Índice do guia

xmltree mostra um valor XML como uma árvore recolhível, colorida: um ecrã de configuração, uma resposta de API, uma depuração de integração. Define o texto XML em is_xml, o componente mostra-o; um clique num nó reporta o seu caminho (ue_node_clicked), um XML inválido levanta ue_error. Não modifica nada: é um VISUALIZADOR.

▶ Ver ao vivo — Aplicação de demonstração, mosaico XML tree, com o código e esta página lado a lado.

Em resumo #

Início 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

Propriedades #

Métodos #

Eventos #

Exemplo #

Explorar a resposta de uma 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

Ler o valor de um nó clicado #

// ue_node_clicked of uo_xml : the path is an XPath n_pbt_xml reads as it is
// (inv_xml is an n_pbt_xml created by the window, ipo_owner = the window)
inv_xml.of_load(/*xml*/ uo_xml.is_xml)
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()

Pesquisar palavras inteiras, com maiú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")

Boas práticas #

• É um visualizador, não um editor: mostra o XML, não o muda. Para ler um valor, passe o caminho de ue_node_clicked a n_pbt_xml.of_get_value sobre o mesmo texto, ou leia of_selected_value.
• Um XML grande continua fluido: só são desenhadas as linhas no ecrã, uma exportação de vários milhares de linhas percorre-se com o teclado sem esperas. Primeiro of_collapse_all continua a ser o mais legível.
• Um XML inválido não parte nada: ue_error di-lo (com a linha e a coluna da falha, na língua de apresentação), e a árvore mostra a fonte à volta da linha errada. É o retorno a mostrar, não uma falha.
• Um espaço de nomes predefinido (xmlns="urn:…", uma resposta SOAP): o caminho escreve-se *[local-name()='Body'], a única forma que um XPath sem prefixo registado sabe ler; um prefixo redeclarado com outro URI, ou um irmão com o mesmo nome noutro espaço, escreve-se *[local-name()='x' and namespace-uri()='urn:…']. @xml:lang lê-se tal como está. Uma declaração xmlns é mostrada mas não tem caminho: o XPath não a vê como um atributo.
• O que se mostra é XML: o valor de um atributo mantém as aspas e as quebras de linha codificadas (
), um texto os seus & e < e os espaços significativos; só desaparecem as quebras de linha de paginação à volta de um texto.
• Com o teclado: as setas passam de linha em linha, Seta direita percorre os atributos de uma etiqueta antes de descer, Page Down avança um ecrã (uma secção CDATA de trezentas linhas conta pela sua altura), Ctrl+C copia o XML da seleção.
• Da direita para a esquerda: um documento XML é um texto da esquerda para a direita, a árvore continua assim numa aplicação RTL (só a caixa de pesquisa segue o sentido da aplicação).

Herdado da base comum #

Estes membros existem em todos os componentes visuais — não são próprios deste. São detalhados uma só vez, nos capítulos transversais; esta tabela apenas diz onde os ler.

← Referência dos componentes · Índice do guia