Obxecto incorporado

Obxecto XmlElement

Os obxectos XmlElement representan elementos en documentos XML

Herdanza

#lineWidth: 1.5 #font: Helvetica,sans-Serif #fontSize: 10 #leading: 1.6 #.this: fill=lightgray #.class: fill=white [<class>object|toString();toJSON()] [<class>XmlNode|nodeType;nodeName;nodeValue;ownerDocument;parentNode;childNodes;firstChild;lastChild;previousSibling;nextSibling|hasChildNodes();normalize();cloneNode();lookupPrefix();lookupNamespaceURI();insertBefore();insertAfter();appendChild();replaceChild();removeChild()] [<this>XmlElement|namespaceURI;prefix;localName;tagName;id;textContent;innerHTML;className;attributes|getAttribute();getAttributeNS();setAttribute();setAttributeNS();removeAttribute();removeAttributeNS();hasAttribute();hasAttributeNS();getElementsByTagName();getElementsByTagNameNS();getElementById();getElementsByClassName()] [object] <:- [XmlNode] [XmlNode] <:- [XmlElement] XmlNode nodeType nodeName nodeValue ownerDocument parentNode childNodes firstChild lastChild previousSibling nextSibling hasChildNodes() normalize() cloneNode() lookupPrefix() lookupNamespaceURI() insertBefore() insertAfter() appendChild() replaceChild() removeChild() XmlElement namespaceURI prefix localName tagName id textContent innerHTML className attributes getAttribute() getAttributeNS() setAttribute() setAttributeNS() removeAttribute() removeAttributeNS() hasAttribute() hasAttributeNS() getElementsByTagName() getElementsByTagNameNS() getElementById() getElementsByClassName() object toString() toJSON()

Atributos dos membros

namespaceURI

String, o URI do espazo de nomes do elemento de consulta. Se o nodo seleccionado non ten espazo de nome, este atributo devolve NULO

1
readonly String XmlElement.namespaceURI;

prefix

Cadea, consulta e configura o prefixo do espazo de nomes do elemento. Se o nodo seleccionado non ten espazo de nome, este atributo devolve NULO

1
String XmlElement.prefix;

localName

String, o nome local do elemento de consulta. Se o nodo seleccionado non ten espazo de nome, este atributo equivale a nodeName

1
readonly String XmlElement.localName;

tagName

Cadea, devolve o nome da etiqueta do elemento

1
readonly String XmlElement.tagName;

id

Cadea, consulta e configura o atributo id do elemento

1
String XmlElement.id;

textContent

Cadea, consulta e configura o texto do elemento seleccionado. Ao realizar consultas, devolve os valores de todos os nodos de texto do nodo elemento; ao axustalo, elimine todos os nodos fillos e substitúeo por un único nodo de texto.

1
String XmlElement.textContent;

innerHTML

Cadea, consulta e configura o texto HTML do elemento seleccionado, só válido no modo html. Ao consultar, devolve o código HTML de todos os nodos fillos do nodo elemento; ao axustalo, elimine todos os nodos fillos e substitúeo polo HTML especificado despois da descodificación.

1
String XmlElement.innerHTML;

className

Cadea, consulta e configura o atributo de clase do elemento, só válido no modo html

1
String XmlElement.className;

attributes

XmlNamedNodeMap, Devolve o NamedNodeMap que contén os atributos do nodo seleccionado. Se o nodo seleccionado non é un elemento, este atributo devolve NULO.

1
readonly XmlNamedNodeMap XmlElement.attributes;

nodeType

Entero, devolve o tipo de nodo do nodo

1
readonly Integer XmlElement.nodeType;

O nodeType de diferentes obxectos devolverá diferentes valores:


nodeName

Cadea, devolve o nome do nodo segundo o seu tipo

1
readonly String XmlElement.nodeName;

O nodoName de diferentes obxectos devolverá diferentes valores:


nodeValue

Cadea, devolve o nome do nodo segundo o seu tipo

1
String XmlElement.nodeValue;

O nodoName de diferentes obxectos devolverá diferentes valores:


ownerDocument

XmlDocument, Devolve o elemento raíz do nodo (XmlDocument Obxecto)

1
readonly XmlDocument XmlElement.ownerDocument;

parentNode

XmlNode, Pode devolver o nodo pai dun nodo

1
readonly XmlNode XmlElement.parentNode;

childNodes

XmlNodeList, Devolve a lista de nodos dos nodos fillos do nodo especificado

1
readonly XmlNodeList XmlElement.childNodes;

firstChild

XmlNode, Devolve o primeiro nodo fillo do nodo

1
readonly XmlNode XmlElement.firstChild;

lastChild

XmlNode, Devolve o último nodo fillo do nodo

1
readonly XmlNode XmlElement.lastChild;

previousSibling

XmlNode, Devolve o nodo inmediatamente antes dun determinado nodo (ao mesmo nivel de árbore), se non existe ese nodo, entón o atributo devolve nulo

1
readonly XmlNode XmlElement.previousSibling;

nextSibling

XmlNode, Devolve o nodo inmediatamente despois dun elemento (no mesmo nivel de árbore), se non existe ese nodo, a propiedade devolve nulo

1
readonly XmlNode XmlElement.nextSibling;

Función de membro

getAttribute

Consulte o valor dun atributo por nome

1
String XmlElement.getAttribute(String name);

Parámetros de chamada:

  • name: Cadea, especifique o nome da propiedade da consulta

Resultado de volta:

  • String, Devolve o valor do atributo

getAttributeNS

Obter valor de atributo por URI e nome do espazo de nomes

1 2
String XmlElement.getAttributeNS(String namespaceURI, String localName);

Parámetros de chamada:

  • namespaceURI: Cadea, especifique o URI do espazo de nomes da consulta
  • localName: Cadea, especifique o nome da propiedade da consulta

Resultado de volta:

  • String, Devolve o valor do atributo

setAttribute

Crear ou cambiar unha nova propiedade

1 2
XmlElement.setAttribute(String name, String value);

Parámetros de chamada:

  • name: Cadea, especifique o nome da propiedade a configurar
  • value: Cadea, especifique o valor do atributo a establecer

Este método establece o atributo especificado no valor especificado. Se non hai ningún atributo co nome especificado, o método creará un novo atributo


setAttributeNS

Crear ou cambiar atributos co espazo de nomes

1 2 3
XmlElement.setAttributeNS(String namespaceURI, String qualifiedName, String value);

Parámetros de chamada:

  • namespaceURI: Cadea, especifique o URI do espazo de nomes que se vai definir
  • qualifiedName: Cadea, especifique o nome da propiedade a configurar
  • value: Cadea, especifique o valor do atributo a establecer

Este método é similar ao método setAttribute, excepto que o atributo que se vai crear ou configurar está especificado polo URI do espazo de nomes e o nome cualificado (composto polo prefixo do espazo de nome, os dous puntos e o nome local no espazo de nomes). Ademais de cambiar o valor dun atributo, usar este método tamén pode cambiar o prefixo do espazo de nomes do atributo


removeAttribute

Elimina o atributo especificado por nome

1
XmlElement.removeAttribute(String name);

Parámetros de chamada:

  • name: Cadea, especifica o nome do atributo eliminado

removeAttributeNS

Elimina os atributos especificados por espazo de nome e nome

1 2
XmlElement.removeAttributeNS(String namespaceURI, String localName);

Parámetros de chamada:

  • namespaceURI: Cadea, especifique o URI do espazo de nomes que se vai eliminar
  • localName: Cadea, especifica o nome do atributo eliminado

hasAttribute

Consulte se o nodo actual ten un atributo co nome especificado

1
Boolean XmlElement.hasAttribute(String name);

Parámetros de chamada:

  • name: Cadea, especifique o nome do atributo da consulta

Resultado de volta:

  • Boolean, Se o nodo do elemento actual ten o atributo especificado, devolve verdadeiro, se non, devolve falso

hasAttributeNS

Consulte se o nodo actual ten atributos do espazo de nome e nome especificado

1 2
Boolean XmlElement.hasAttributeNS(String namespaceURI, String localName);

Parámetros de chamada:

  • namespaceURI: Cadea, especifique o URI do espazo de nomes que se vai consultar
  • localName: Cadea, especifique o nome do atributo da consulta

Resultado de volta:

  • Boolean, Se o nodo do elemento actual ten o atributo especificado, devolve verdadeiro, se non, devolve falso

getElementsByTagName

Devolve todos os elementos co nome especificado XmlNodeList

1
XmlNodeList XmlElement.getElementsByTagName(String tagName);

Parámetros de chamada:

  • tagName: Cadea, nome da etiqueta que se vai recuperar. O valor "*" coincide con todas as etiquetas

Resultado de volta:

  • XmlNodeList, Do nodo XmlElement coa marca especificada na árbore do nodo XmlNodeListxuntar. A orde dos nodos de elementos devoltos é a orde na que aparecen no documento de orixe.

Este método percorrerá os descendentes do elemento especificado e devolverá un nodo XmlElement XmlNodeListObxecto, que significa todos os elementos do documento co nome da etiqueta especificado. A orde dos elementos da matriz devolta é a orde na que aparecen no código fonte do documento.

XmlDocument A interface tamén define o método getElementsByTagName, que é similar a este método, pero percorre todo o documento en lugar de percorrer os descendentes dun elemento.


getElementsByTagNameNS

Devolve todos os elementos co nome e espazo de nome especificado XmlNodeList

1 2
XmlNodeList XmlElement.getElementsByTagNameNS(String namespaceURI, String localName);

Parámetros de chamada:

  • namespaceURI: Cadea, especifique o URI do espazo de nomes que se vai consultar
  • localName: Cadea, nome da etiqueta que se vai recuperar. O valor "*" coincide con todas as etiquetas

Resultado de volta:

  • XmlNodeList, Do nodo XmlElement coa marca especificada na árbore do nodo XmlNodeListxuntar. A orde dos nodos de elementos devoltos é a orde na que aparecen no documento de orixe.

Este método é similar ao método getElementsByTagName, excepto que o nome da etiqueta do elemento que desexa obter se especifica como unha combinación do URI do espazo de nomes e o nome local definido no espazo de nomes.


getElementById

Devolve o elemento co atributo id especificado

1
XmlElement XmlElement.getElementById(String id);

Parámetros de chamada:

  • id: Cadea, id que se recuperará

Resultado de volta:

  • XmlElement, Nodo XmlElement co atributo id especificado na árbore de nodos

Este método percorrerá os nodos descendentes do elemento especificado e devolverá un obxecto de nodo XmlElement que represente o primeiro elemento do documento co atributo id especificado. .

XmlDocument A interface tamén define o método getElementsByTagName, que é similar a este método, pero percorre todo o documento en lugar de percorrer os descendentes dun elemento.


getElementsByClassName

Devolve unha lista de nodos de todos os elementos co nome da clase especificado

1
XmlNodeList XmlElement.getElementsByClassName(String className);

Parámetros de chamada:

  • className: Cadea, o nome da clase que se recuperará

Resultado de volta:

  • XmlNodeList, O nodo XmlElement co nome da clase especificado na árbore do documento XmlNodeListxuntar. A orde dos nodos de elementos devoltos é a orde na que aparecen no documento de orixe.

Este método devolverá un XmlNodeList Obxecto (pódese tratar como unha matriz de só lectura). Este obxecto almacena todos os nodos XmlElement co nome de clase especificado no documento. A orde na que se almacenan é a orde na que aparecen no documento de orixe. XmlNodeList O obxecto é "vivo", é dicir, se se engade ou elimina no documento un elemento co nome da etiqueta especificado, o seu contido actualizarase automaticamente segundo sexa necesario.


hasChildNodes

Consulta se hai nodos fillos

1
Boolean XmlElement.hasChildNodes();

Resultado de volta:

  • Boolean, Devolve verdadeiro se hai nodos fillos, en caso contrario devolve falso

normalize

Combina nodos de texto adxacentes e elimina nodos de texto baleiros

1
XmlElement.normalize();

Este método percorrerá todos os nodos descendentes do nodo actual e normalizará o documento eliminando o nodo de texto baleiro e fusionando todos os nodos de texto adxacentes. Este método é útil para simplificar a estrutura da árbore do documento despois de inserir ou eliminar nodos.


cloneNode

Crea unha copia exacta do nodo especificado

1
XmlNode XmlElement.cloneNode(Boolean deep = true);

Parámetros de chamada:

  • deep: Booleano, se se copia en profundidade, cando é verdadeiro, o nodo clonado clonará todos os nodos fillos do nodo orixinal

Resultado de volta:

Este método copiará e devolverá unha copia do nodo que o chamou. Se o parámetro que se lle pasou é certo, tamén copiará recursivamente todos os descendentes do nodo actual. Se non, só copia o nodo actual. O nodo devolto non pertence á árbore do documento e a súa propiedade parentNode é nula. Cando se copia o nodo Element, copiaranse todos os seus atributos.


lookupPrefix

Devolve o prefixo que coincide co URI do espazo de nomes especificado no nodo actual

1
String XmlElement.lookupPrefix(String namespaceURI);

Parámetros de chamada:

  • namespaceURI: Cadea, especifique o URI do espazo de nomes coincidente

Resultado de volta:

  • String, Devolve o prefixo coincidente, devolve nulo se non se coincide

lookupNamespaceURI

Devolve o URI do espazo de nomes que coincide co prefixo especificado no nodo actual

1
String XmlElement.lookupNamespaceURI(String prefix);

Parámetros de chamada:

  • prefix: Cadea, especifique o prefixo coincidente

Resultado de volta:

  • String, Devolve o URI do espazo de nome coincidente, devolve nulo se non coincide

insertBefore

Insira un novo nodo fillo antes do nodo fillo existente

1 2
XmlNode XmlElement.insertBefore(XmlNode newChild, XmlNode refChild);

Parámetros de chamada:

  • newChild: XmlNode, Insira un novo nodo
  • refChild: XmlNode, Insira un novo nodo antes deste nodo

Resultado de volta:

  • XmlNode, Devolve o novo nodo fillo

Se newChild xa existe na árbore do documento, eliminarase da árbore do documento e despois volverá inserilo na súa nova posición. Os nodos dun documento (ou nodos creados por un documento) non se poden inserir noutro documento. Noutras palabras, a propiedade ownerDocument de newChild debe ser a mesma que a propiedade ownerDocument do nodo actual.


insertAfter

Insira un novo nodo fillo despois do nodo fillo existente

1 2
XmlNode XmlElement.insertAfter(XmlNode newChild, XmlNode refChild);

Parámetros de chamada:

  • newChild: XmlNode, Insira un novo nodo
  • refChild: XmlNode, Insira un novo nodo despois deste nodo

Resultado de volta:

  • XmlNode, Devolve o novo nodo fillo

Se newChild xa existe na árbore do documento, eliminarase da árbore do documento e despois volverá inserilo na súa nova posición. Os nodos dun documento (ou nodos creados por un documento) non se poden inserir noutro documento. Noutras palabras, a propiedade ownerDocument de newChild debe ser a mesma que a propiedade ownerDocument do nodo actual.


appendChild

Engade un novo nodo fillo ao final da lista de nodos fillos do nodo

1
XmlNode XmlElement.appendChild(XmlNode newChild);

Parámetros de chamada:

  • newChild: XmlNode, Especifique o nodo engadido

Resultado de volta:

  • XmlNode, Devolve este novo nodo fillo

Se newChild xa existe na árbore do documento, eliminarase da árbore do documento e despois volverá inserilo na súa nova posición. Os nodos dun documento (ou nodos creados por un documento) non se poden inserir noutro documento. Noutras palabras, a propiedade ownerDocument de newChild debe ser a mesma que a propiedade ownerDocument do nodo actual.


replaceChild

Substitúe un nodo fillo por outro

1 2
XmlNode XmlElement.replaceChild(XmlNode newChild, XmlNode oldChild);

Parámetros de chamada:

  • newChild: XmlNode, Especifique un novo nodo
  • oldChild: XmlNode, Especifique o nodo a substituír

Resultado de volta:

  • XmlNode, Se a substitución é correcta, este método pode devolver o nodo substituído; se a substitución falla, devolve nulo

Se newChild xa existe na árbore do documento, eliminarase da árbore do documento e despois volverá inserilo na súa nova posición. Os nodos dun documento (ou nodos creados por un documento) non se poden inserir noutro documento. Noutras palabras, a propiedade ownerDocument de newChild debe ser a mesma que a propiedade ownerDocument do nodo actual.


removeChild

Elimina un nodo da lista de nodos fillos

1
XmlNode XmlElement.removeChild(XmlNode oldChild);

Parámetros de chamada:

  • oldChild: XmlNode, Especifique o nodo que se vai eliminar

Resultado de volta:

  • XmlNode, Se a eliminación é correcta, este método pode devolver o nodo eliminado; se falla, devolve nulo

toString

Devolve a representación de cadea do obxecto, xeralmente devolve "[Obxecto nativo]", o obxecto pode reimplementarse segundo as súas propias características

1
String XmlElement.toString();

Resultado de volta:

  • String, Devolve a representación de cadea do obxecto

toJSON

Devolve a representación en formato JSON do obxecto, xeralmente devolve unha colección de atributos lexibles definidos polo obxecto

1
Value XmlElement.toJSON(String key = "");

Parámetros de chamada:

  • key: Cadea, sen usar

Resultado de volta:

  • Value, Devolve un valor que contén JSON serializable