XMLList

Pacote	Nível superior
Classe	public final dynamic class XMLList
Herança	XMLList Object

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0, Flash Player 9, Flash Lite 4

A classe XMLList contém métodos para trabalhar com um ou mais elementos XML. Um objeto XMLList pode representar um ou mais objetos ou elementos XML (incluindo vários nós ou atributos), para que você possa chamar métodos nos elementos como um grupo ou nos elementos individuais da coleção.

Se um objeto XMLList tiver apenas um elemento XML, você poderá usar os métodos da classe XML no objeto XMLList diretamente. No exemplo a seguir, example.two é um objeto XMLList de comprimento 1 e, portanto, é possível chamar qualquer método XML nele.

 var example2 = <example><two>2</two></example>;

Se você tentar usar métodos da classe XML com um objeto XMLList contendo mais de um objeto XML, uma exceção será lançada. Como alternativa, faça a iteração sobre a coleção de XMLList (usando uma instrução for each..in, por exemplo) e aplique os métodos a cada objeto XML na coleção.

Veja os exemplos

Elementos da API relacionados

XML
for each..no
Namespace
QName

Propriedades públicas

Ocultar propriedades públicas herdadas

Mostrar propriedades públicas herdadas

	Propriedade		Definido por
		constructor : Object Uma referência ao objeto de classe ou à função de construtor de uma determinada ocorrência de objeto.	Object

Métodos públicos

Ocultar métodos públicos herdados

Mostrar métodos públicos herdados

	Método		Definido por
		XMLList(value:Object) Cria um novo objeto XMLList.	XMLList
		attribute(attributeName:*):XMLList Chama o método attribute() de cada objeto XML e retorna um objeto XMLList dos resultados.	XMLList
		attributes():XMLList Chama o método attributes() de cada objeto XML e retorna um objeto XMLList dos atributos de cada objeto XML.	XMLList
		child(propertyName:Object):XMLList Chama o método child() de cada objeto XML e retorna um objeto XMLList que contém os resultados em ordem.	XMLList
		children():XMLList Chama o método children() de cada objeto XML e retorna um objeto XMLList que contém os resultados.	XMLList
		comments():XMLList Chama o método comments() de cada objeto XML e retorna um XMLList de comentários.	XMLList
		contains(value:XML):Boolean Verifica se o objeto XMLList contém um objeto XML igual ao parâmetro de valor especificado.	XMLList
		copy():XMLList Retorna uma cópia do objeto XMLList especificado.	XMLList
		descendants(name:Object = *):XMLList Retorna todos os descendentes (filhos, netos, bisnetos e assim por diante) do objeto XML que possui o parâmetro "nome" especificado.	XMLList
		elements(name:Object = *):XMLList Chama o método elements() de cada objeto XML.	XMLList
		hasComplexContent():Boolean Verifica se o objeto XMLList tem conteúdo complexo.	XMLList
		hasOwnProperty(p:String):Boolean Verifica a propriedade especificada por p.	XMLList
		hasSimpleContent():Boolean Verifica se o objeto XMLList tem conteúdo simples.	XMLList
		isPrototypeOf(theClass:Object):Boolean Indica se uma ocorrência da classe Object está na cadeia de protótipos do objeto especificado como o parâmetro.	Object
		length():int Retorna o número de propriedades no objeto XMLList.	XMLList
		normalize():XMLList Mescla nós de texto adjacentes e elimina nós de texto vazios para todos os nós de texto em XMLList, todos os objetos XML contidos em XMLList e os descendentes de todos os objetos XML em XMLList.	XMLList
		parent():Object Retorna o pai do objeto XMLList se todos os itens no objeto XMLList tiverem o mesmo pai.	XMLList
		processingInstructions(name:String = "*"):XMLList Se um parâmetro "name" for fornecido, lista todos os filhos do objeto XMLList que contêm instruções de processamento com esse nome.	XMLList
		propertyIsEnumerable(p:String):Boolean Verifica se a propriedade p está no conjunto de propriedades que podem ser iteradas em uma instrução for..in aplicada ao objeto XMLList.	XMLList
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Define a disponibilidade de uma propriedade dinâmica para operações de repetição.	Object
		text():XMLList Chama o método text() de cada objeto XML e retorna um objeto XMLList que contém os resultados.	XMLList
		toLocaleString():String Retorna a representação da string deste objeto, formatado segundo as convenções específicas para a localidade.	Object
		toString():String Retorna uma representação de string de todos os objetos XML em um objeto XMLList.	XMLList
		toXMLString():String Retorna uma representação de string de todos os objetos XML em um objeto XMLList.	XMLList
		valueOf():XMLList Retorna o objeto XMLList.	XMLList

Detalhes do construtor

()

Construtor

public function XMLList(value:Object)

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0, Flash Player 9

Cria um novo objeto XMLList.

Parâmetros

value:Object — Qualquer objeto que possa ser convertido em um objeto XMLList usando a função XMLList() de nível superior.

Elementos da API relacionados

função XMLList() de nível superior

Detalhes do método

attribute

()

método

AS3 function attribute(attributeName:*):XMLList

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0, Flash Player 9

Chama o método attribute() de cada objeto XML e retorna um objeto XMLList dos resultados. Os resultados correspondem ao parâmetro attributeName especificado. Se não houver correspondência, o método attribute() retornará um objeto XMLList vazio.

Parâmetros

attributeName:* — O nome do atributo que você deseja incluir em um objeto XMLList.

Retorna

XMLList — Um objeto XMLList de objetos XML correspondentes ou um objeto XMLList vazio.

Elementos da API relacionados

XML.attribute()
XML.attributes()

attributes

()

método

AS3 function attributes():XMLList

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0, Flash Player 9

Chama o método attributes() de cada objeto XML e retorna um objeto XMLList dos atributos de cada objeto XML.

Retorna

XMLList — Um objeto XMLList de atributos para cada objeto XML.

Elementos da API relacionados

XML.attribute()
XML.attributes()

child

()

método

AS3 function child(propertyName:Object):XMLList

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0, Flash Player 9

Chama o método child() de cada objeto XML e retorna um objeto XMLList que contém os resultados em ordem.

Parâmetros

propertyName:Object — O nome de elemento ou inteiro do filho XML.

Retorna

XMLList — Um objeto XMLList de nós-filho que correspondem ao parâmetro de entrada.

Elementos da API relacionados

XML.child()

children

()

método

AS3 function children():XMLList

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0, Flash Player 9

Chama o método children() de cada objeto XML e retorna um objeto XMLList que contém os resultados.

Retorna

XMLList — Um objeto XMLList dos filhos nos objetos XML.

Elementos da API relacionados

XML.children()

comments

()

método

AS3 function comments():XMLList

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0, Flash Player 9

Chama o método comments() de cada objeto XML e retorna um XMLList de comentários.

Retorna

XMLList — Um XMLList dos comentários nos objetos XML.

Elementos da API relacionados

XML.comments()

contains

()

método

AS3 function contains(value:XML):Boolean

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0, Flash Player 9

Verifica se o objeto XMLList contém um objeto XML igual ao parâmetro value especificado.

Parâmetros

value:XML — Um objeto XML a ser comparado com base no objeto XMLList atual.

Retorna

Boolean — Se XMLList contiver o objeto XML declarado no parâmetro value, true; caso contrário, false.

copy

()

método

AS3 function copy():XMLList

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0, Flash Player 9

Retorna uma cópia do objeto XMLList especificado. A cópia é uma duplicata da árvore de nós inteira. O objeto XML copiado não tem pai e retornará null se você tentar chamar o método parent().

Retorna

XMLList — A cópia do objeto XMLList.

descendants

()

método

AS3 function descendants(name:Object = *):XMLList

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0, Flash Player 9

Retorna todos os descendentes (filhos, netos, bisnetos e assim por diante) do objeto XML que possui o parâmetro name especificado. O parâmetro name pode ser um objeto QName, um tipo de dados String ou qualquer outro tipo de dados que seja subsequentemente convertido em um tipo de dados String.

Para retornar todos os descendentes, use o parâmetro de asterisco (*). Se nenhum parâmetro for transmitido, a string "*" será transmitida e retornará todos os descendentes do objeto XML.

Parâmetros

name:Object (default = *) — O nome do elemento a ser correspondido.

Retorna

XMLList — Um objeto XMLList dos descendentes (filhos, netos e assim por diante) correspondentes dos objetos XML na lista original. Se não houver descendentes, retornará um objeto XMLList vazio.

Elementos da API relacionados

XML.descendants()

elements

()

método

AS3 function elements(name:Object = *):XMLList

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0, Flash Player 9

Chama o método elements() de cada objeto XML. O parâmetro name é transmitido ao método descendants(). Se nenhum parâmetro for transmitido, a string "*" será transmitida ao método descendants().

Parâmetros

name:Object (default = *) — O nome dos elementos a serem correspondidos.

Retorna

XMLList — Um objeto XMLList dos elementos-filho correspondentes dos objetos XML.

Elementos da API relacionados

XML.elements()

hasComplexContent

()

método

AS3 function hasComplexContent():Boolean

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0, Flash Player 9

Verifica se o objeto XMLList tem conteúdo complexo. Será considerado que um objeto XMLList contém conteúdo completo se não estiver vazio e se uma das condições a seguir for verdadeira:

O objeto XMLList contém um único item XML com conteúdo complexo.
O objeto XMLList contém elementos.

Retorna

Boolean — Se o objeto XMLList contiver conteúdo complexo, true; caso contrário, false.

Elementos da API relacionados

hasSimpleContent()
XML.hasComplexContent()
XML.hasSimpleContent()

hasOwnProperty

()

método

AS3 function hasOwnProperty(p:String):Boolean

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0, Flash Player 9

Verifica a propriedade especificada por p.

Parâmetros

p:String — A propriedade a ser correspondida.

Retorna

Boolean — Se o parâmetro existir, true; caso contrário, false.

hasSimpleContent

()

método

AS3 function hasSimpleContent():Boolean

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0, Flash Player 9

Verifica se o objeto XMLList tem conteúdo simples. Será considerado que um objeto XMLList contém conteúdo simples se uma ou mais das condições a seguir for verdadeira:

O objeto XMLList está vazio
O objeto XMLList contém um único item XML com conteúdo simples
O objeto XMLList não contém elementos

Retorna

Boolean — Se XMLList contiver conteúdo simples, true; caso contrário, false.

Elementos da API relacionados

hasComplexContent()
XML.hasComplexContent()
XML.hasSimpleContent()

length

()

método

AS3 function length():int

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0, Flash Player 9

Retorna o número de propriedades no objeto XMLList.

Retorna

int — O número de propriedades no objeto XMLList.

normalize

()

método

AS3 function normalize():XMLList

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0, Flash Player 9

Mescla nós de texto adjacentes e elimina nós de texto vazios para todos os nós de texto em XMLList, todos os objetos XML contidos em XMLList e os descendentes de todos os objetos XML em XMLList.

Retorna

XMLList — O objeto XMLList normalizado.

parent

()

método

AS3 function parent():Object

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0, Flash Player 9

Retorna o pai do objeto XMLList se todos os itens no objeto XMLList tiverem o mesmo pai. Se o objeto XMLList não tiver pai ou tiver pais diferentes, o método retornará undefined.

Retorna

Object — Retorna o objeto XML pai.

processingInstructions

()

método

AS3 function processingInstructions(name:String = "*"):XMLList

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0, Flash Player 9

Se um parâmetro name for fornecido, lista todos os filhos do objeto XMLList que contêm instruções de processamento com esse nome. Sem parâmetros, o método lista todos os filhos do objeto XMLList que contêm instruções de processamento.

Parâmetros

name:String (default = "*") — O nome das instruções de processamento a serem correspondidas.

Retorna

XMLList — Um objeto XMLList contendo as instruções de processamento para cada objeto XML.

Elementos da API relacionados

XML.processingInstructions()

propertyIsEnumerable

()

método

AS3 function propertyIsEnumerable(p:String):Boolean

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0, Flash Player 9

Verifica se a propriedade p está no conjunto de propriedades que podem ser iteradas em uma instrução for..in aplicada ao objeto XMLList. Isso apenas será true se toNumber(p) for maior do que ou igual a 0 e menor do que o comprimento do objeto XMLList.

Parâmetros

p:String — O índice de uma propriedade a ser verificada.

Retorna

Boolean — Se a propriedade puder ser iterada em uma instrução for..in, true; caso contrário, false.

text

()

método

AS3 function text():XMLList

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0, Flash Player 9

Chama o método text() de cada objeto XML e retorna um objeto XMLList que contém os resultados.

Retorna

XMLList — Um objeto XMLList de todas as propriedades XML do objeto XMLList que representam nós de texto XML.

Elementos da API relacionados

XML.text()

toString

()

método

AS3 function toString():String

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0, Flash Player 9

Retorna uma representação de string de todos os objetos XML em um objeto XMLList. As regras para essa conversão dependem de o objeto XML ter conteúdo simples ou complexo:

Se o objeto XML tiver conteúdo simples, toString() retornará o conteúdo de string do objeto XML removendo o seguinte: a marca inicial, atributos, declarações de namespace e a marca final.

Se o objeto XML tiver conteúdo complexo, toString() retornará uma string codificada em XML representando o objeto XML inteiro, incluindo a marca inicial, os atributos, as declarações de namespace e a marca final.

Para sempre retornar o objeto XML inteiro, use o método toXMLString().

Retorna

String — A representação de string do objeto XML.

Elementos da API relacionados

hasComplexContent()
hasSimpleContent()
toXMLString()

Exemplo ( Como usar este exemplo )

O exemplo a seguir mostra o que o método toString() retorna quando o objeto XML tem conteúdo simples:

var test:XML = <type name="Joe">example</type>;
trace(test.toString()); //example

O exemplo a seguir mostra o que o método toString() retorna quando o objeto XML tem conteúdo complexo:

var test:XML = 
<type name="Joe">
    <base name="Bob"></base>
    example
</type>;
trace(test.toString());
  // <type name="Joe">
  // <base name="Bob"/>
  // example
  // </type>

toXMLString

()

método

AS3 function toXMLString():String

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0, Flash Player 9

Retorna uma representação de string de todos os objetos XML em um objeto XMLList. Ao contrário do método toString(), toXMLString() sempre retorna a marca inicial, os atributos e a marca final do objeto XML, independentemente do objeto XML ter conteúdo simples ou complexo. (O método toString() remove esses itens para objetos XML que têm conteúdo simples.)

Retorna

String — A representação de string do objeto XML.

Elementos da API relacionados

toString()

valueOf

()

método

AS3 function valueOf():XMLList

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0, Flash Player 9

Retorna o objeto XMLList.

Retorna

XMLList — Retorna o objeto XMLList atual.

Exemplos Como usar este exemplo

XMLListExample.as

O exemplo a seguir cria uma propriedade XML denominada books e adiciona vários itens com marcas book publisher e name em um nó denominado books. Em seguida, o método showBooksByPublisher() é chamado, empregando XMLList e retornando cada item correspondente ao editor "Addison-Wesley".

package {
    import flash.display.Sprite;

    public class XMLListExample extends Sprite {
        private var books:XML;

        public function XMLListExample() {
            books =    <books>
                        <book publisher="Addison-Wesley" name="Design Patterns" />
                        <book publisher="Addison-Wesley" name="The Pragmatic Programmer" />
                        <book publisher="Addison-Wesley" name="Test Driven Development" />
                        <book publisher="Addison-Wesley" name="Refactoring to Patterns" />
                        <book publisher="O'Reilly Media" name="The Cathedral & the Bazaar" />
                        <book publisher="O'Reilly Media" name="Unit Test Frameworks" />
                    </books>;

            showBooksByPublisher("Addison-Wesley");
        }

        private function showBooksByPublisher(name:String):void {
            var results:XMLList = books.book.(@publisher == name);
            showList(results);
        }

        private function showList(list:XMLList):void {
            var item:XML;
            for each(item in list) {
                trace("item: " + item.toXMLString());
            }
        }
    }
}

Aspectos jurídicos | Política de privacidade on-line

XMLList - AS3

Pacotesx

Elementos de linguagem

Apêndices

Classes x

XMLList

attribute

attributes

child

children

comments

contains

copy

descendants

elements

hasComplexContent

hasOwnProperty

hasSimpleContent

length

normalize

parent

processingInstructions

propertyIsEnumerable

text

toString

toXMLString

valueOf