Главная / Action Script 3
ПакетВерхний уровень
Классpublic final dynamic class XMLList
НаследованиеXMLList Inheritance Object

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Класс XMLList содержит методы для работы с одним или несколькими XML-элементами. Объект XMLList может представлять один или несколько объектов или элементов XML (включая несколько узлов или атрибутов). Поэтому можно вызывать методы по отношению к элементам в виде группы или к отдельным элементам в коллекции.

Если объект XMLList имеет только один элемент XML, методы класса XML можно применять к объекту XMLList напрямую. В следующем примере example.two — это объект XMLList длиной 1, и для него можно вызвать любой метод XML.

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

Если вы попытаетесь использовать методы класса XML в отношение объекта XMLList, содержащего более одного объекта XML, возникает исключение. Вместо этого следует выполнить итерацию в коллекции XMLList (например, с помощью оператора for each..in) и применить эти методы к каждому объекту XML в коллекции.

Посмотреть примеры

См. также

XML
for each..in
Namespace
QName


Общедоступные свойства
 СвойствоОпределено
 Inheritedconstructor : Object
Ссылка на объект класса или функцию конструктора для данного экземпляра объекта.
Object
 Inheritedprototype : Object
[статические] Ссылка на модель объекта класса или функции.
Object
Общедоступные методы
 МетодОпределено
  
Создает новый объект XMLList.
XMLList
  
attribute(attributeName:*):XMLList
Вызывает метод attribute() каждого объекта XML и возвращает объект XMLList, состоящий из результатов.
XMLList
  
Вызывает метод attributes() каждого объекта XML и возвращает объект XMLList, состоящий из атрибутов каждого объекта XML.
XMLList
  
child(propertyName:Object):XMLList
Вызывает метод child() каждого объекта XML и возвращает объект XMLList, содержащий упорядоченные результаты.
XMLList
  
Вызывает метод children() каждого объекта XML и возвращает объект XMLList, содержащий результаты.
XMLList
  
Вызывает метод comments() каждого объекта XML и возвращает объект XMLList, состоящий из комментариев.
XMLList
  
Проверяет наличие в объекте XMLList объекта XML, равного данному параметру value.
XMLList
  
Возвращает копию заданного объекта XMLList.
XMLList
  
Возвращает все потомки (дочерние объекты всех уровней) объекта XML, обладающие данным параметром имени.
XMLList
  
Вызывает метод elements() каждого объекта XML.
XMLList
  
Проверяет наличие в объекте XMLList сложного содержимого.
XMLList
  
Проверяет наличие свойства, заданного параметром p.
XMLList
  
Проверяет наличие в объекте XMLList простого содержимого.
XMLList
 Inherited
Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра.
Object
  
Возвращает число свойств в объекте XMLList.
XMLList
  
Выполняет слияние смежных текстовых узлов и удаляет пустые текстовые узлы для следующих объектов: всех текстовых узлов в объекте XMLList, всех объектов XML в объекте XMLList, а также потомков всех объектов XML в объекте XMLList.
XMLList
  
Возвращает родительский объект для объекта XMLList, если родительский объект у всех элементов в объекте XMLList общий.
XMLList
  
Если введен параметр имени, отображает список всех дочерних объектов для объекта XMLList, содержащих инструкции обработки с данным именем.
XMLList
  
Проверяет, находится ли "p" в наборе свойств, которые можно итерировать в операторе for..in, примененном к объекту XMLList.
XMLList
 Inherited
Задает доступность динамического свойства для операций цикла.
Object
  
Вызывает метод text() каждого объекта XML и возвращает объект XMLList, содержащий результаты.
XMLList
  
Возвращает строковое представление всех объектов XML в объекте XMLList.
XMLList
  
Возвращает строковое представление всех объектов XML в объекте XMLList.
XMLList
  
Возвращает объект XMLList.
XMLList
Сведения о конструкторе
XMLList()Конструктор
public function XMLList(value:Object)

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Создает новый объект XMLList.

Параметры
value:Object — Любой объект, который может быть преобразован в объект XMLList с помощью функции верхнего уровня XMLList().

См. также

Сведения о методе
attribute()метод
AS3 function attribute(attributeName:*):XMLList

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Вызывает метод attribute() каждого объекта XML и возвращает объект XMLList, состоящий из результатов. Результаты соответствуют заданному параметру attributeName. Если совпадения нет, метод attribute() возвращает пустой объект XMLList.

Параметры

attributeName:* — Название атрибута, который требуется включить в объект XMLList.

Возвращает
XMLList — Объект XMLList из совпадающих объектов XML или пустой объект XMLList.

См. также

attributes()метод 
AS3 function attributes():XMLList

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Вызывает метод attributes() каждого объекта XML и возвращает объект XMLList, состоящий из атрибутов каждого объекта XML.

Возвращает
XMLList — Объект XMLList с атрибутами каждого объекта XML.

См. также

child()метод 
AS3 function child(propertyName:Object):XMLList

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Вызывает метод child() каждого объекта XML и возвращает объект XMLList, содержащий упорядоченные результаты.

Параметры

propertyName:Object — Имя элемента или целого числа дочернего XML.

Возвращает
XMLList — Объект XMLList с дочерними узлами, соответствующими введенному параметру.

См. также

children()метод 
AS3 function children():XMLList

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Вызывает метод children() каждого объекта XML и возвращает объект XMLList, содержащий результаты.

Возвращает
XMLList — Объект XMLList с дочерними объектами объектов XML.

См. также

comments()метод 
AS3 function comments():XMLList

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Вызывает метод comments() каждого объекта XML и возвращает объект XMLList, состоящий из комментариев.

Возвращает
XMLList — XMLList с комментариями в объектах XML.

См. также

contains()метод 
AS3 function contains(value:XML):Boolean

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Проверяет наличие в объекте XMLList объекта XML, равного заданному параметру value.

Параметры

value:XML — Объект XML, сравниваемый с текущим объектом XMLList.

Возвращает
Boolean — Если XMLList содержит объект XML, объявленный в параметреvalue, то присваивается значение true; в противном случае — значение false.

См. также

copy()метод 
AS3 function copy():XMLList

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Возвращает копию заданного объекта XMLList. Копия — это дубликат всего дерева узлов. Скопированный объект XML не имеет родителя и возвращает null, если Вы пытаетесь вызвать метод parent().

Возвращает
XMLList — Копия объекта XMLList.

См. также

descendants()метод 
AS3 function descendants(name:Object = *):XMLList

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Возвращает всех потомков (дочерние объекты всех уровней) объекта XML, обладающих данным параметром имени. Параметр name может представлять собой объект QName, тип данных String или любой другой тип данных, который затем преобразуется в тип данных String.

Чтобы показать всех потомков, воспользуйтесь параметром "звездочки" (*). Если параметр не задан, передается строка "*" и отображаются все потомки объекта XML.

Параметры

name:Object (default = *) — Имя совпадающего элемента.

Возвращает
XMLList — Объект XMLList совпадающих потомков (дочерних объектов всех уровней) объектов XML в исходном списке. Если потомков не существует, возвращается пустой объект XMLList.

См. также

elements()метод 
AS3 function elements(name:Object = *):XMLList

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Вызывает метод elements() каждого объекта XML. Параметр name передается методу descendants(). Если параметр не задан, строка "*" передается методу descendants().

Параметры

name:Object (default = *) — Имя совпадающих элементов.

Возвращает
XMLList — Объект XMLList совпадающих дочерних элементов объектов XML.

См. также

hasComplexContent()метод 
AS3 function hasComplexContent():Boolean

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Проверяет наличие в объекте XMLList сложного содержимого. Объект XMLList считается имеющим сложное содержимое, если он не является пустым и верно одно из следующих условий:

Возвращает
Boolean — Если объект XMLList содержит сложное содержимое, то выбирается значение true; в противном случае выбирается значение false.

См. также

hasOwnProperty()метод 
AS3 function hasOwnProperty(p:String):Boolean

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Проверяет наличие свойства, заданного параметром p.

Параметры

p:String — Совпадающее свойство.

Возвращает
Boolean — Если параметр существует, указывается значение true; в противном случае выбирается значение false.

См. также

hasSimpleContent()метод 
AS3 function hasSimpleContent():Boolean

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Проверяет наличие в объекте XMLList простого содержимого. Объект XMLList считается имеющим сложное содержимое, если выполняется одно или несколько следующих условий:

Возвращает
Boolean — Если XMLList содержит сложное содержимое, то выбирается значение true; в противном случае выбирается значение false.

См. также

length()метод 
AS3 function length():int

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Возвращает число свойств в объекте XMLList.

Возвращает
int — Число свойств в объекте XMLList.

См. также

normalize()метод 
AS3 function normalize():XMLList

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Выполняет слияние смежных текстовых узлов и удаляет пустые текстовые узлы для следующих объектов: всех текстовых узлов в объекте XMLList, всех объектов XML в объекте XMLList, а также потомков всех объектов XML в объекте XMLList.

Возвращает
XMLList — Нормализованный объект XMLList.

См. также

parent()метод 
AS3 function parent():Object

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Возвращает родительский объект для объекта XMLList, если родительский объект у всех элементов в объекте XMLList общий. Если объект XMLList лишен родительского объекта или имеет другие родительские объекты, метод возвращает значение undefined.

Возвращает
Object — Возвращает родительский объект XML.

См. также

processingInstructions()метод 
AS3 function processingInstructions(name:String = "*"):XMLList

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Если параметр name введен, отображает список всех дочерних объектов для объекта XMLList, содержащих инструкции обработки с данным именем. Если параметры не указаны, метод перечисляет все дочерние объекты объекта XMLList, содержащего инструкции по обработке.

Параметры

name:String (default = "*") — Имя совпадающих инструкций по обработке.

Возвращает
XMLList — Объект XMLList содержащий инструкции по обработке для каждого объекта XML.

См. также

propertyIsEnumerable()метод 
AS3 function propertyIsEnumerable(p:String):Boolean

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Проверяет, находится ли p в наборе свойств, которые можно итерировать в операторе for..in, примененном к объекту XMLList. Значение true присваивается только в том случае, когда параметр toNumber(p)больше или равен 0 и не превышает длины объекта XMLList.

Параметры

p:String — Индекс проверяемого свойства.

Возвращает
Boolean — Если это свойство можно итерировать в операторе for..in, выбирается значение true; в противном случае указывается значение false.

См. также

text()метод 
AS3 function text():XMLList

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Вызывает метод text() каждого объекта XML и возвращает объект XMLList, содержащий результаты.

Возвращает
XMLList — Возвращает объект XMLList всех свойств XML объекта XMLList, представляющих текстовые узлы XML.

См. также

toString()метод 
AS3 function toString():String

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Возвращает строковое представление всех объектов XML в объекте XMLList. Правила этого преобразования зависят от наличия простого или сложного содержимого в объекте XML:

Чтобы каждый раз возвращать весь объект XML, воспользуйтесь методом toXMLString().

Возвращает
String — Строковое представление объекта XML.

См. также


Пример

В следующем примере показано, что возвращает метод toString(), когда объект XML имеет простое содержимое:
var test:XML = <type name="Joe">example</type>;
trace(test.toString()); //example

В следующем примере показано, что возвращает метод toString(), когда объект XML имеет сложное содержимое:
var test:XML = 
<type name="Joe">
    <base name="Bob"></base>
    example
</type>;
trace(test.toString());
  // <type name="Joe">
  // <base name="Bob"/>
  // example
  // </type> 
toXMLString()метод 
AS3 function toXMLString():String

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Возвращает строковое представление всех объектов XML в объекте XMLList. В отличие от метода toString() метод toXMLString() всегда возвращает начальный тег, атрибуты и конечный тег объекта XML независимо от того, имеет ли объект XML простое или сложное содержимое. (Метод toString() приводит к удалению этих компонентов в объектах XML, имеющих простое содержимое.)

Возвращает
String — Строковое представление объекта XML.

См. также

valueOf()метод 
AS3 function valueOf():XMLList

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Возвращает объект XMLList.

Возвращает
XMLList — Возвращает текущий объект XMLList.

См. также

Примеры Как пользоваться примерами
XMLListExample.as

В следующем примере создается свойство XML books и добавляются несколько элементов с тегами book publisher и name в узел books. Затем вызывается метод showBooksByPublisher(), который обрабатывает XMLList и возвращает все элементы с издателем 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());
            }
        }
    }
}