ObjectXmlElement
Os obxectos XmlElement representan elementos nun documento XML
relación de herdanza
propiedades dos membros
namespaceURI
Cadea, URI do espazo de nomes do elemento de consulta. Se o nodo seleccionado non ten espazo de nomes, esta propiedade devolve NULL
1readonly String XmlElement.namespaceURI;
prefix
Cadea, consulta e establece o prefixo do espazo de nomes do elemento. Se o nodo seleccionado non ten espazo de nomes, esta propiedade devolve NULL
1String XmlElement.prefix;
localName
Cadea, o nome local do elemento de consulta. Se o nodo seleccionado non ten espazo de nomes, esta propiedade é equivalente a nodeName
1readonly String XmlElement.localName;
tagName
Cadea, devolve o nome da etiqueta do elemento
1readonly String XmlElement.tagName;
id
Cadena, consulta e establece o atributo id do elemento
1String XmlElement.id;
innerHTML
Encadea, consulta e establece o texto HTML dos descendentes do elemento seleccionado, só válido no modo html. Ao realizar a consulta, devolve a codificación HTML de todos os nodos secundarios do nodo de elementos; ao configurar, elimina todos os nodos secundarios e substitúeos pola decodificación HTML especificada.
1String XmlElement.innerHTML;
outerHTML
Cadena, consulta o texto HTML do elemento seleccionado e os seus descendentes, só válido no modo html. Ao realizar a consulta, devolve a codificación HTML do elemento e de todos os nodos fillos do nodo.
1readonly String XmlElement.outerHTML;
className
Cadena, consulta e establece o atributo class do elemento, só válido no modo html
1String XmlElement.className;
attributes
XmlNamedNodeMap, devolve un NamedNodeMap que contén os atributos do nodo seleccionado. Se o nodo seleccionado non é un elemento, esta propiedade devolve NULL.
1readonly XmlNamedNodeMap XmlElement.attributes;
nodeType
Enteiro, devolve o tipo de nodo do nodo
1readonly Integer XmlElement.nodeType;
O nodeType de diferentes obxectos devolverá valores diferentes:
- XmlElement: ELEMENT_NODE(1)
- XmlAttr:ATTRIBUTE_NODE(2)
- XmlText: TEXT_NODE(3)
- XmlCDATASection: CDATA_SECTION_NODE(4)
- XmlProcessingInstruction: PROCESSING_INSTRUCTION_NODE(7)
- XmlComment:COMMENT_NODE(8)
- XmlDocument: DOCUMENT_NODE(9)
- XmlDocumentType: DOCUMENT_TYPE_NODE(10)
nodeName
String, devolve o nome do nodo, segundo o seu tipo
1readonly String XmlElement.nodeName;
O nodeName de diferentes obxectos devolverá valores diferentes:
- XmlElement: nome do elemento
- XmlAttr: nome do atributo
- XmlText: #texto
- XmlCDATASection: #cdata-section
- XmlProcessingInstruction: Devolve o destino de destino especificado
- XmlComment: #comentar
- XmlDocument: #documento
- XmlDocumentType: nome do tipo de documento
nodeValue
String, devolve o nome do nodo, segundo o seu tipo
1String XmlElement.nodeValue;
O nodeName de diferentes obxectos devolverá valores diferentes:
- XmlElement: nulo
- XmlAttr: valor do atributo
- XmlText: o contido do nodo
- XmlCDATASection: o contido do nodo
- XmlProcessingInstruction: Devolve os datos de contido especificados
- XmlComment: texto de anotación
- XmlDocument: nulo
- XmlDocumentType: nulo
ownerDocument
XmlDocument, devolve o elemento raíz do nodo (XmlDocumentobxecto)
1readonly XmlDocument XmlElement.ownerDocument;
parentNode
XmlNode, pode devolver o nodo pai dun nodo
1readonly XmlNode XmlElement.parentNode;
childNodes
XmlNodeList, devolve a lista de nodos dos nodos fillos do nodo especificado
1readonly XmlNodeList XmlElement.childNodes;
children
XmlNodeList, devolve a lista de nodos dos nodos do elemento fillo do nodo especificado.
1readonly XmlNodeList XmlElement.children;
firstChild
XmlNode, devolve o primeiro nodo fillo do nodo
1readonly XmlNode XmlElement.firstChild;
lastChild
XmlNode, devolve o último nodo fillo do nodo
1readonly XmlNode XmlElement.lastChild;
previousSibling
XmlNode, devolve o nodo inmediatamente anterior a un nodo (no mesmo nivel de árbore). Se non hai tal nodo, esta propiedade devolve nulo.
1readonly XmlNode XmlElement.previousSibling;
nextSibling
XmlNode, devolve o nodo inmediatamente despois dun elemento (no mesmo nivel de árbore). Se non hai tal nodo, o atributo devolve nulo.
1readonly XmlNode XmlElement.nextSibling;
firstElementChild
XmlNode, devolve o primeiro nodo do elemento fillo do nodo
1readonly XmlNode XmlElement.firstElementChild;
lastElementChild
XmlNode, devolve o último nodo do elemento fillo do nodo
1readonly XmlNode XmlElement.lastElementChild;
previousElementSibling
XmlNode, devolve o nodo do elemento inmediatamente anterior a un nodo (no mesmo nivel de árbore). Se non hai tal nodo, esta propiedade devolve nulo.
1readonly XmlNode XmlElement.previousElementSibling;
nextElementSibling
XmlNode, devolve o nodo do elemento inmediatamente despois dun elemento (no mesmo nivel de árbore). Se non hai tal nodo, o atributo devolve nulo.
1readonly XmlNode XmlElement.nextElementSibling;
textContent
Cadena, consulta e establece o texto do elemento seleccionado. Ao consultar, devolve os valores de todos os nodos de texto dentro do nodo de elemento; ao configurar, elimina todos os nodos fillos e substitúeos por un único nodo de texto.
1String XmlElement.textContent;
función de membro
getAttribute
Consulta o valor dun atributo polo nome
1String XmlElement.getAttribute(String name);
Parámetros de chamada:
- name: Cadea, especifica o nome do atributo da consulta
Resultados de devolución:
- String, devolve o valor do atributo
getAttributeNS
Obter o valor do atributo por URI e nome do espazo de nomes
1
2String XmlElement.getAttributeNS(String namespaceURI,
String localName);
Parámetros de chamada:
- namespaceURI: Cadea, especificando o URI do espazo de nomes da consulta
- localName: Cadea, especifica o nome do atributo da consulta
Resultados de devolución:
- String, devolve o valor do atributo
setAttribute
Crea ou cambia unha nova propiedade
1
2XmlElement.setAttribute(String name,
String value);
Parámetros de chamada:
- name: Cadea, especifica o nome do atributo a definir
- value: Cadea, especifica o valor do atributo a definir
Este método establece a propiedade especificada co valor especificado. Se non existe unha propiedade co nome especificado, este método crea unha nova propiedade
setAttributeNS
Crea ou altera propiedades espaciadas entre nomes
1
2
3XmlElement.setAttributeNS(String namespaceURI,
String qualifiedName,
String value);
Parámetros de chamada:
- namespaceURI: Cadea, especifica o URI do espazo de nomes que se establecerá
- qualifiedName: Cadea, especifica o nome do atributo a definir
- value: Cadea, especifica o valor do atributo a definir
Este método é semellante ao método setAttribute, agás que o atributo que se vai crear ou definir é especificado por un URI de espazo de nomes e un nome cualificado que consiste nun prefixo de espazo de nomes, dous puntos e un nome local no espazo de nomes. Ademais de cambiar o valor dun atributo, tamén pode usar este método para cambiar o prefixo do espazo de nomes do atributo.
removeAttribute
Elimina o atributo especificado polo nome
1XmlElement.removeAttribute(String name);
Parámetros de chamada:
- name: Cadea, especifica o nome do atributo que se vai eliminar
removeAttributeNS
Elimina as propiedades especificadas por espazo de nomes e nome
1
2XmlElement.removeAttributeNS(String namespaceURI,
String localName);
Parámetros de chamada:
- namespaceURI: Cadea, especifica o URI do espazo de nomes que se vai eliminar
- localName: Cadea, especifica o nome do atributo que se vai eliminar
hasAttribute
Consulta se o nodo actual ten un atributo co nome especificado
1Boolean XmlElement.hasAttribute(String name);
Parámetros de chamada:
- name: Cadea, especifica o nome do atributo da consulta
Resultados de devolución:
- Boolean, se o nodo do elemento actual ten o atributo especificado, devolve verdadeiro, se non, devolve false
hasAttributeNS
Consulta se o nodo actual ten atributos co espazo de nomes e nome especificados
1
2Boolean XmlElement.hasAttributeNS(String namespaceURI,
String localName);
Parámetros de chamada:
- namespaceURI: Cadea, especifica o URI do espazo de nomes que se vai consultar
- localName: Cadea, especifica o nome do atributo da consulta
Resultados de devolución:
- Boolean, se o nodo do elemento actual ten o atributo especificado, devolve verdadeiro, se non, devolve false
getElementsByTagName
Devolve todos os elementos co nome especificadoXmlNodeList
1XmlNodeList XmlElement.getElementsByTagName(String tagName);
Parámetros de chamada:
- tagName: String, o nome da etiqueta que se vai recuperar. O valor "*" coincide con todas as etiquetas
Resultados de devolución:
- XmlNodeList, o nodo XmlElement coa etiqueta especificada na árbore de nodosXmlNodeListrecoller. A orde dos nós dos elementos devoltos é a orde na que aparecen no documento de orixe.
Este método atravesará os nodos descendentes do elemento especificado e devolverá un nodo XmlElement.XmlNodeListObxecto que representa todos os elementos do documento co nome de etiqueta especificado. A orde dos elementos na matriz devolta é a orde na que aparecen no código fonte do documento.
XmlDocumentA interface tamén define o método getElementsByTagName, que é semellante a este método, pero atravesa todo o documento en lugar de atravesar os nodos descendentes dun elemento.
getElementsByTagNameNS
Devolve todos os elementos co espazo de nomes e nome especificadosXmlNodeList
1
2XmlNodeList XmlElement.getElementsByTagNameNS(String namespaceURI,
String localName);
Parámetros de chamada:
- namespaceURI: Cadea, especifica o URI do espazo de nomes que se vai consultar
- localName: String, o nome da etiqueta que se vai recuperar. O valor "*" coincide con todas as etiquetas
Resultados de devolución:
- XmlNodeList, o nodo XmlElement coa etiqueta especificada na árbore de nodosXmlNodeListrecoller. A orde dos nós dos elementos devoltos é a orde na que aparecen no documento de orixe.
Este método é semellante ao método getElementsByTagName, agás que o nome da etiqueta do elemento que quere 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
1XmlElement XmlElement.getElementById(String id);
Parámetros de chamada:
- id: String, o identificador que se vai recuperar
Resultados de devolución:
- XmlElement, o nodo XmlElement co atributo id especificado na árbore de nodos
Este método atravesará os nodos descendentes do elemento especificado e devolverá un obxecto nodo XmlElement que representa o primeiro elemento do documento co atributo id especificado. .
XmlDocumentA interface tamén define o método getElementsByTagName, que é semellante a este método, pero atravesa todo o documento en lugar de atravesar os nodos descendentes dun elemento.
getElementsByClassName
Devolve unha lista de nodos de todos os elementos co nome de clase especificado
1XmlNodeList XmlElement.getElementsByClassName(String className);
Parámetros de chamada:
- className: String, o nome da clase que se vai recuperar
Resultados de devolución:
- XmlNodeList, o nodo XmlElement co nome de clase especificado na árbore do documentoXmlNodeListrecoller. A orde dos nós dos elementos devoltos é a orde na que aparecen no documento de orixe.
Este método devolverá aXmlNodeListObxecto (pódese procesar como unha matriz de só lectura), que 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.XmlNodeListO obxecto está "en directo", é dicir, se se engade ou elimina un elemento co nome de etiqueta especificado no documento, o seu contido actualizarase automaticamente segundo sexa necesario.
hasChildNodes
Consulta se hai nós fillos
1Boolean XmlElement.hasChildNodes();
Resultados de devolución:
- Boolean, devolve verdadeiro se hai algún nodo fillo, se non, devolve falso
normalize
Combina os nós de Texto adxacentes e elimina os nós de Texto baleiros
1XmlElement.normalize();
Este método atravesará todos os nodos descendentes do nodo actual e normalizará o documento eliminando os nós de Texto baleiros e fusionando todos os nós de Texto adxacentes. Este método é útil para simplificar a estrutura da árbore do documento despois de inserir ou eliminar nós.
cloneNode
Crea unha copia exacta do nodo especificado
1XmlNode XmlElement.cloneNode(Boolean deep = true);
Parámetros de chamada:
- deep: Booleano, se debe copiar en profundidade, cando é verdadeiro, o nodo clonado clonará todos os nodos fillos do nodo orixinal
Resultados de devolución:
- XmlNode, devolve o nodo copiado
Este método copiará e devolverá unha copia do nodo no que foi chamado. Se o argumento que se lle pasou é verdadeiro, tamén copiará de forma recursiva todos os nodos descendentes do nodo actual. En caso contrario, só copia o nodo actual. O nodo devolto non pertence á árbore do documento e a súa propiedade parentNode é nula. Cando se copia un nodo Element, copiaranse todas as súas propiedades.
lookupPrefix
Devolve o prefixo que coincide co URI de espazo de nomes especificado no nodo actual
1String XmlElement.lookupPrefix(String namespaceURI);
Parámetros de chamada:
- namespaceURI: Cadea, especifica o URI do espazo de nomes coincidente
Resultados de devolución:
- String, devolve o prefixo coincidente, devolve nulo se non coincide.
lookupNamespaceURI
Devolve o URI do espazo de nomes que coincide co prefixo especificado no nodo actual
1String XmlElement.lookupNamespaceURI(String prefix);
Parámetros de chamada:
- prefix: Cadea, especifica o prefixo coincidente
Resultados de devolución:
- String, devolve o URI do espazo de nomes coincidente, devolve nulo se non coincide.
insertBefore
Insira un novo nodo fillo antes dun nodo fillo existente
1
2XmlNode XmlElement.insertBefore(XmlNode newChild,
XmlNode refChild);
Parámetros de chamada:
Resultados de devolución:
- XmlNode, devolve o novo nodo fillo
Se xa existe newChild na árbore de documentos, eliminarase da árbore de documentos e reinserirase na súa nova posición. Os nós dun documento (ou os nodos creados por un documento) non se poden inserir noutro documento. É dicir, o atributo ownerDocument de newChild debe ser o mesmo que o atributo ownerDocument do nodo actual.
insertAfter
Insira un novo nodo fillo despois dun nodo fillo existente
1
2XmlNode XmlElement.insertAfter(XmlNode newChild,
XmlNode refChild);
Parámetros de chamada:
Resultados de devolución:
- XmlNode, devolve o novo nodo fillo
Se xa existe newChild na árbore de documentos, eliminarase da árbore de documentos e reinserirase na súa nova posición. Os nós dun documento (ou os nodos creados por un documento) non se poden inserir noutro documento. É dicir, o atributo ownerDocument de newChild debe ser o mesmo que o atributo ownerDocument do nodo actual.
appendChild
Engade un novo nodo fillo ao final da lista de nodos fillos dun nodo
1XmlNode XmlElement.appendChild(XmlNode newChild);
Parámetros de chamada:
- newChild:XmlNode, especifique o nodo engadido
Resultados de devolución:
- XmlNode, devolve este novo nodo fillo
Se xa existe newChild na árbore de documentos, eliminarase da árbore de documentos e reinserirase na súa nova posición. Os nós dun documento (ou os nodos creados por un documento) non se poden inserir noutro documento. É dicir, o atributo ownerDocument de newChild debe ser o mesmo que o atributo ownerDocument do nodo actual.
replaceChild
Substitúe un nodo fillo por outro
1
2XmlNode XmlElement.replaceChild(XmlNode newChild,
XmlNode oldChild);
Parámetros de chamada:
Resultados de devolución:
- XmlNode, Se a substitución ten éxito, este método pode devolver o nodo substituído. Se a substitución falla, devolve nulo.
Se xa existe newChild na árbore de documentos, eliminarase da árbore de documentos e reinserirase na súa nova posición. Os nós dun documento (ou os nodos creados por un documento) non se poden inserir noutro documento. É dicir, o atributo ownerDocument de newChild debe ser o mesmo que o atributo ownerDocument do nodo actual.
removeChild
Elimina un nodo da lista de nodos fillos
1XmlNode XmlElement.removeChild(XmlNode oldChild);
Parámetros de chamada:
- oldChild:XmlNode, especifica o nodo que se vai eliminar
Resultados de devolución:
- XmlNode, Se a eliminación é correcta, este método pode devolver o nodo eliminado. Se falla, devolve nulo.
toString
Devolve a representación en cadea do obxecto. Polo xeral, devólvese "[Obxecto nativo]". O obxecto pódese volver implementar segundo as súas propias características.
1String XmlElement.toString();
Resultados de devolución:
- String, devolve a representación en cadea do obxecto
toJSON
Devolve unha representación en formato JSON do obxecto, devolvendo xeralmente unha colección de propiedades lexibles definidas polo obxecto.
1Value XmlElement.toJSON(String key = "");
Parámetros de chamada:
- key: Cadena, non usada
Resultados de devolución:
- Value, devolve un valor que contén JSON serializable