Главная / Action Script 3
(Только AIR)
Пакетflash.filesystem
Классpublic class File
НаследованиеFile Inheritance FileReference Inheritance EventDispatcher Inheritance Object

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

Объект File представляет собой путь к файлу или каталогу. Это может быть существующий или еще не существующий файл или каталог. Так, можно задать путь к файлу или каталогу, который вы планируете создать.

Класс File предлагает некоторые свойства и методы для получения информации о файловой системе и для выполнения таких операций, как копирование файлов и каталогов.

Объекты File можно использовать с классом FileStream для чтения и записи файлов.

Класс File является расширением класса FileReference. Класс FileReference, встречающийся в программах Flash® Player и Adobe® AIR, является указателем на файл, но в класс File добавлены свойства и методы, не представленные в программе Flash Player (при проигрывании SWF-файла в обозревателе) из соображений безопасности.

См. также

FileStream
Работа с файлами данных


Общедоступные свойства
 СвойствоОпределено
  AIR-only applicationDirectory : File
[статические] [только для чтения] Папка с установленными файлами приложения.
File
  AIR-only applicationStorageDirectory : File
[статические] [только для чтения] Каталог для хранения данных приложения.
File
 Inheritedconstructor : Object
Ссылка на объект класса или функцию конструктора для данного экземпляра объекта.
Object
 InheritedcreationDate : Date
[только для чтения] Дата создания файла на локальном диске.
FileReference
 Inheritedcreator : String
[только для чтения] Тип создателя Macintosh для файла, который используется только в версиях OS, предшествующих Mac OS X.
FileReference
 Inheriteddata : ByteArray
[только для чтения] ByteArray, представляющий загруженный файл после успешного вызова метода load().
FileReference
  AIR-only desktopDirectory : File
[статические] [только для чтения] Каталог рабочего стола пользователя.
File
  AIR-only documentsDirectory : File
[статические] [только для чтения] Каталог с документами пользователя.
File
  AIR-only exists : Boolean
[только для чтения] Определяет, существует ли файл или каталог, на который дается ссылка.
File
 InheritedAIR-only extension : String
[только для чтения] Расширение имени файла.
FileReference
  AIR-only icon : Icon
[только для чтения] Объект Icon, содержащий значки, заданные для этого файла.
File
  AIR-only isDirectory : Boolean
[только для чтения] Указывает, ведет ли ссылка на каталог.
File
  AIR-only isHidden : Boolean
[только для чтения] Указывает, являются ли файл или каталог, на которые ведет ссылка, скрытыми. Значение true присваивается, если файл или каталог, на которые ведет ссылка, являются скрытыми, в противном случае присваивается значение false.
File
  AIR-only isPackage : Boolean
[только для чтения] Указывает, является ли каталог, на который ссылаются, пакетом.
File
  AIR-only isSymbolicLink : Boolean
[только для чтения] Указывает, является ли ссылка символьной.
File
  AIR-only lineEnding : String
[статические] [только для чтения] Последовательность символов закрытия строки, используемая домашней операционной системой.
File
 InheritedmodificationDate : Date
[только для чтения] Дата последнего изменения файла на локальном диске.
FileReference
 Inheritedname : String
[только для чтения] Имя файла на локальном диске.
FileReference
  AIR-only nativePath : String
Полный путь в представлении домашней операционной системы.
File
  AIR-only parent : File
[только для чтения] Каталог, содержащий файл или каталог, на который ссылается данный объект File.
File
 Inheritedprototype : Object
[статические] Ссылка на модель объекта класса или функции.
Object
  AIR-only separator : String
[статические] [только для чтения] Разделительный символ, используемый в домашней операционной системе.
File
 Inheritedsize : Number
[только для чтения] Размер файла на локальном диске в байтах.
FileReference
  AIR-only spaceAvailable : Number
[только для чтения] Доступное для использования пространство в данном местоположении File, в байтах.
File
  AIR-only systemCharset : String
[статические] [только для чтения] Кодировка по умолчанию, используемая домашней операционной системой.
File
 Inheritedtype : String
[только для чтения] Тип файла.
FileReference
  AIR-only url : String
URL-адрес данного пути к файлу.
File
  AIR-only userDirectory : File
[статические] [только для чтения] Каталог пользователя.
File
Общедоступные методы
 МетодОпределено
  
AIR-only File(path:String = null)
Функция конструктора для класса File.
File
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Регистрирует объект прослушивателя события в объекте EventDispatcher, в результате чего прослушиватель будет получать уведомления о событиях.
EventDispatcher
 Inherited
browse(typeFilter:Array = null):Boolean
Отображает диалоговое окно выбора файлов, позволяющее пользователю выбрать файл для отправки.
FileReference
  
Отображает для пользователя диалоговое окно выбора каталога.
File
  
AIR-only browseForOpen(title:String, typeFilter:Array = null):void
Отображает диалоговое окно "Открыть файл", где можно выбрать файл для открытия.
File
  
AIR-only browseForOpenMultiple(title:String, typeFilter:Array = null):void
Отображает диалоговое окно "Открыть файл", в котором можно выбрать один или несколько файлов для открытия.
File
  
Отображает диалоговое окно "Сохранить файл", в котором можно выбрать место назначения файла.
File
  
Отменяет все операции, ожидающие выполнения.
File
  
Канонизирует путь к файлу.
File
  
Возвращает копию данного объекта File.
File
  
AIR-only copyTo(newLocation:FileReference, overwrite:Boolean = false):void
Копирует файл или каталог из места, указанного данным объектом File, в место, заданное параметром newLocation.
File
  
AIR-only copyToAsync(newLocation:FileReference, overwrite:Boolean = false):void
Начинает копирование файла или каталога из места, заданного объектом File, в место, заданное параметром назначения.
File
  
Создает указанный каталог и все необходимые родительские каталоги.
File
  
[статические] Возвращает ссылку на новый временный каталог.
File
  
[статические] Возвращает ссылку на новый временный файл.
File
  
AIR-only deleteDirectory(deleteDirectoryContents:Boolean = false):void
Удаляет каталог.
File
  
AIR-only deleteDirectoryAsync(deleteDirectoryContents:Boolean = false):void
Удаляет каталог в асинхронном режиме.
File
  
Удаляет файл.
File
  
Удаляет файл в асинхронном режиме.
File
 Inherited
Передает событие в поток событий.
EventDispatcher
 Inherited
download(request:URLRequest, defaultFileName:String = null):void
Открывает диалоговое окно, позволяющее пользователю загрузить файл с удаленного сервера.
FileReference
  
Возвращает массив объектов File, связанных с файлами и каталогами, размещенными в каталоге, представленном данным объектом File.
File
  
В асинхронном режиме формирует массив объектов File, связанных с содержимым каталога, который представляется данным объектом File.
File
  
AIR-only getRelativePath(ref:FileReference, useDotDot:Boolean = false):String
Находит среди двух путей к файлу относительный путь.
File
  
[статические] Возвращается массив объектов File, в котором перечислены корневые каталоги файловой системы.
File
 Inherited
Проверяет наличие у объекта EventDispatcher прослушивателей событий, которые зарегистрированы для получения уведомлений о событиях определенного типа.
EventDispatcher
 Inherited
Показывает, определено ли заданное свойство для объекта.
Object
 Inherited
Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра.
Object
 Inherited
Начинает загрузку локального файла, выбранного пользователем.
FileReference
  
AIR-only moveTo(newLocation:FileReference, overwrite:Boolean = false):void
Перемещает файл или каталог из места, заданного объектом File, в место, заданное параметром назначения.
File
  
AIR-only moveToAsync(newLocation:FileReference, overwrite:Boolean = false):void
Перемещает файл или каталог из места, заданного объектом File, в место, заданное параметром newLocation.
File
  
Перемещает файл или каталог в корзину.
File
  
Перемещает файл или каталог в корзину в асинхронном режиме.
File
 Inherited
Показывает наличие заданного свойства и его перечисляемость.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Удаляет прослушиватель из объекта EventDispatcher.
EventDispatcher
  
Создает новый объект File с путем, связанным с путем данного объекта File, на основе параметра path (строки).
File
 Inherited
save(data:*, defaultFileName:String = null):void
Открывает диалоговое окно, позволяющее пользователю сохранить файл в локальной файловой системе.
FileReference
 Inherited
Задает доступность динамического свойства для операций цикла.
Object
 Inherited
Возвращает строковое представление заданного объекта.
Object
 Inherited
upload(request:URLRequest, uploadDataFieldName:String = "Filedata", testUpload:Boolean = false):void
Запускает отправку выбранного пользователем файла на удаленный сервер.
FileReference
 Inherited
Инициируют отправку файла в URL без кодировки.
FileReference
 Inherited
Возвращает элементарное значение заданного объекта.
Object
 Inherited
Проверяет, зарегистрирован ли прослушиватель событий в объекте EventDispatcher или в любом из его предков для получения уведомлений о событиях определенного типа.
EventDispatcher
События
 Событие Сводка Определено
 Inherited[многоадресное событие] Отправляется, когда проигрыватель Flash Player перемещается в фокус операционной системы и становится активным.EventDispatcher
  Вызывается при отмене асинхронной операции, ожидающей выполнения.File
  Вызывается при завершении асинхронной операции.File
 Inherited[многоадресное событие] Отправляется, когда проигрыватель Flash Player покидает фокус операционной системы и становится неактивным.EventDispatcher
  Вызывается, когда в результате запроса метода getDirectoryListingAsync() становится доступен список каталогов.File
 InheritedОтправляется, если вызов метода upload() или uploadUnencoded() пытается обратиться к данным через HTTP и Adobe AIR может обнаружить и вернуть код состояния для запроса.FileReference
 InheritedОтправляется, когда при отправке происходит ошибка и доступен код состояния HTTP, описывающий ошибку.FileReference
  Вызывается, когда при выполнении асинхронной операции над файлом происходит ошибка.File
 InheritedОтправка выполняется при запуске операции загрузки, сохранения или отправки файла.FileReference
 InheritedОтправка выполняется периодически во время операции загрузки, сохранения или отправки файла.FileReference
  Вызывается, когда операция нарушает ограничения безопасности.File
  Вызывается, когда пользователь выбирает файл или каталог из окна просмотра файлов или каталогов.File
  Вызывается, когда пользователь выбирает файлы из диалогового окна, открывшегося по запросу метода browseForOpenMultiple().File
 InheritedОтправляется после получения с сервера данных о успешном завершении отправки.FileReference
Сведения о свойстве
AIR-only applicationDirectoryсвойство
applicationDirectory:File  [только для чтения]

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

Папка с установленными файлами приложения.

Свойство url для этого объекта использует схему URL app (не схему file). Это означает, что строка url открывается записью"app:" (а не "file:"). Кроме того, если создается объект File, связанный с каталогом File.applicationStoreDirectory (это делается с помощью метода resolvePath()), то url объекта File также использует схему URL app (как в примере).

Примечание. В файлы или каталоги, использующие схему URL app, нельзя производить запись. Также нельзя удалять или создавать файлы и папки с путями, в которых используется схема URL app. Из соображений безопасности не следует модифицировать содержимое в каталоге приложения. Если требуется сохранить какие-то данные приложения, лучше использовать каталог хранения данных приложения (File.applicationStorageDirectory). Если необходимо дать каким-либо файлам в каталоге хранения данных приложения доступ к отдельным функциям приложений (API приложения AIR), можно поместить эти функции в изолированную программную среду безопасности ("песочницу").



Реализация
    public static function get applicationDirectory():File

См. также

AIR-only applicationStorageDirectoryсвойство 
applicationStorageDirectory:File  [только для чтения]

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

Каталог для хранения данных приложения.

Каждое приложение AIR имеет свой постоянный каталог для хранения данных, который создается при первом вызове File.applicationStorageDirectory. Этот каталог очень удобен для хранения данных приложения.

При установке приложения AIR программа удаления не удаляет файлы, хранящиеся в этом каталоге.

Свойство url для этого объекта использует схему URL app-storage (не схему file). Это означает, что строка url открывается записью"app-storage:" (а не "file:"). Кроме того, если создается объект File, связанный с каталогом File.applicationStoreDirectory (это делается с помощью метода resolvePath()), то url объекта File также использует схему URL app-storage (как в примере).



Реализация
    public static function get applicationStorageDirectory():File
AIR-only desktopDirectoryсвойство 
desktopDirectory:File  [только для чтения]

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

Каталог рабочего стола пользователя.



Реализация
    public static function get desktopDirectory():File

Пример
Как пользоваться примерами
AIR-only documentsDirectoryсвойство 
documentsDirectory:File  [только для чтения]

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

Каталог с документами пользователя.

В Windows это каталог "Мои документы" (например, C:\Documents and Settings\имя_пользователя\Мои документы). В Mac OS это /Users/имя_пользователя/Documents.



Реализация
    public static function get documentsDirectory():File
AIR-only existsсвойство 
exists:Boolean  [только для чтения]

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

Определяет, существует ли файл или каталог, на который дается ссылка. Значение true присваивается, если объект File указывает на существующий файл или каталог, в противном случае присваивается значение false.



Реализация
    public function get exists():Boolean

Пример
Как пользоваться примерами
AIR-only iconсвойство 
icon:Icon  [только для чтения]

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

Объект Icon, содержащий значки, заданные для этого файла. Объект Icon является массивом объектов BitmapData, связанных с различными состояниями значков.



Реализация
    public function get icon():Icon
AIR-only isDirectoryсвойство 
isDirectory:Boolean  [только для чтения]

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

Указывает, ведет ли ссылка на каталог. Значение true присваивается, если объект File указывает на каталог, в противном случае присваивается значение false.



Реализация
    public function get isDirectory():Boolean

Пример
Как пользоваться примерами
AIR-only isHiddenсвойство 
isHidden:Boolean  [только для чтения]

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

Указывает, являются ли файл или каталог, на которые ведет ссылка, скрытыми. Значение true присваивается, если файл или каталог, на которые указывает ссылка, являются скрытыми, в противном случае присваивается значение false.



Реализация
    public function get isHidden():Boolean

Пример
Как пользоваться примерами
AIR-only isPackageсвойство 
isPackage:Boolean  [только для чтения]

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

Указывает, является ли каталог, на который ссылаются, пакетом.

Значение trueприсваивается, если каталог, на который ссылаются, является пакетом, в противном случае присваивается значение false. Обратите внимание, что в классе File не предусмотрено прямое создание пакетов.



Реализация
    public function get isPackage():Boolean
AIR-only isSymbolicLinkсвойство 
isSymbolicLink:Boolean  [только для чтения]

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

Указывает, является ли ссылка символьной.

Значение true присваивается, если объект File указывает на каталог, в противном случае присваивается значение false. Обратите внимание, что в классе File не предусмотрено прямое создание символьных ссылок.

С помощью символьных ссылок один файл может ссылаться на другой файл или каталог на диске. Не путайте символьные ссылки с псевдонимами в Mac OS и ярлыками в Windows, это не одно и то же. Псевдонимы и ярлыки всегда считаются файлами (не каталогами), а чтение или запись псевдонимов и ярлыков никаким образом не изменяет файлы, на которые они указывают. Символьная ссылка, в свою очередь, повторяет поведение файла или каталога, на который она указывает. Она может считаться файлом или каталогом, а при чтении и записи символьной ссылки изменения будут производиться над самим файлом, на который она указывает, а не только над ссылкой.

Операционные системы Mac® OS® и Windows® Vista® поддерживают символьные ссылки. Кроме этого, в Windows свойство isSymbolicLink для объекта File, ссылающегося на точку соединения (используется в файловой системе NTFS) имеет значение true.



Реализация
    public function get isSymbolicLink():Boolean
AIR-only lineEndingсвойство 
lineEnding:String  [только для чтения]

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

Последовательность символов закрытия строки, используемая домашней операционной системой.

В Mac OS это знак перевода строки (шестнадцатеричный код символа 0x0A). В ОС Windows это знак возврата каретки (шестнадцатеричный код символа 0x0D) в сочетании со знаком перевода строки (шестнадцатеричный код символа 0x0A).



Реализация
    public static function get lineEnding():String
AIR-only nativePathсвойство 
nativePath:String  [чтение и запись]

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

Полный путь в представлении домашней операционной системы. В Mac OS в качестве разделителя в записи пути используется косая черта (/). Однако в Windows можно задать свойство nativePath, используя в качестве разделителя в записи пути прямую (/) или обратную (\) косую черту, а AIR автоматически заменит все прямые косые черты обратными.



Реализация
    public function get nativePath():String
    public function set nativePath(value:String):void

Выдает
SecurityError — Вызывающий оператор не находится в изолированной программной среде безопасности.
 
ArgumentError — Неверный синтаксис пути.
AIR-only parentсвойство 
parent:File  [только для чтения]

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

Каталог, содержащий файл или каталог, на который ссылается данный объект File.

Если файла или каталога не существует, свойство parent все равно будет возвращать объект File, указывающий на каталог, содержащий файл или каталог, даже если его не существует.

Это свойство идентично возвращаемому значению для функции resolvePath(".."), но при этом родителю корневого каталога присваивается значение null.



Реализация
    public function get parent():File
AIR-only separatorсвойство 
separator:String  [только для чтения]

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

Разделительный символ, используемый в домашней операционной системе.

В Mac OS это косая черта (/). В ОС Windows это обратная косая черта (\).

Примечание. При использовании обратной косой черты в строковом литерале нужно вводить ее дважды (например, "directory\\file.ext"). Две обратных косых черты в строковом литерале идентичны одной обратной косой черте в строке.



Реализация
    public static function get separator():String
AIR-only spaceAvailableсвойство 
spaceAvailable:Number  [только для чтения]

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

Доступное для использования пространство в данном местоположении File, в байтах.

Если объект File ссылается на каталог, spaceAvailable указывает на объем пространства в каталоге, доступный для использования файлами. Если объект File ссылается на файл, spaceAvailable указывает доступный объем увеличения файла. Если местоположение файла не существует, spaceAvailable имеет значение 0. Если объект File указывает на символическую ссылку, spaceAvailable указывает на доступное пространство в указанном символической ссылкой местоположении.

Как правило, доступное для файла или каталога пространство равно такому пространству в томе, содержащем этот файл или каталог. Однако при выделении доступного пространства могут учитываться квоты и ограничения, установленные для каталогов.

При добавлении файла или каталога в том, как правило, требуется больше места, чем фактический размер файла или содержимого каталога. Например, операционной системе может потребоваться дополнительное место для хранения информации указателей. Или секторам диска может потребоваться дополнительное пространство. К тому же, доступное пространство динамически изменяется. Поэтому выделение всего требуемого пространства для хранения файлов может быть невозможно.



Реализация
    public function get spaceAvailable():Number
AIR-only systemCharsetсвойство 
systemCharset:String  [только для чтения]

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

Кодировка по умолчанию, используемая домашней операционной системой.

Возможные значения включают "windows-1252" "shift-jis", "cn-gb", "iso-8859-1" и другие. Полный список см. в разделе Поддерживаемые наборы символов.

Это значение можно использовать с методами readMultiByte() и writeMultiByte() класса FileStream.



Реализация
    public static function get systemCharset():String

См. также

AIR-only urlсвойство 
url:String  [чтение и запись]

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

URL-адрес данного пути к файлу.

Если это ссылка на путь в каталог хранения данных приложения, схема URL будет "app-storage". Если это ссылка на путь в каталог приложения, схема URL будет "app". Во всех остальных случаях схема будет "file".

Для присвоения значения свойству url рекомендуется использовать знаки пробела (вместо "%20"). AIR автоматически кодирует строки (например, переводит пробелы в "%20").



Реализация
    public function get url():String
    public function set url(value:String):void

Выдает
ArgumentError — Неверный синтаксис URL-адреса.
 
SecurityError — Вызывающий оператор не находится в изолированной программной среде безопасности.

См. также

AIR-only userDirectoryсвойство 
userDirectory:File  [только для чтения]

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

Каталог пользователя.

В ОС Windows это родитель каталога "Мои документы" (например, C:\Мои документы\имя_пользователя). В Mac OS это /Users/имя_пользователя.



Реализация
    public static function get userDirectory():File
Сведения о конструкторе
AIR-only File()Конструктор
public function File(path:String = null)

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

Функция конструктора для класса File.

При передаче аргумента path объект File указывает на конкретный путь, а свойства nativePath и url отражают этот путь.

Параметры
path:String (default = null) — Путь к файлу. Можно задать путь двумя способами: с помощью URL-адреса или записав путь в характерном для конкретной платформы виде.

При вводе URL-адреса можно пользоваться следующими схемами URL: file, app или app-storage. Для параметра path, использующего запись URL, действительными являются следующие значения:

  • "app:/DesktopPathTest.xml"
  • "app-storage:/preferences.xml"
  • "file:///C:/Documents%20and%20Settings/ivan/Рабочий стол" (Рабочий стол на компьютере Ивана)
  • "file:///Users/ivan/Рабочий стол" (Рабочий стол на компьютере Mac Ивана)

Схемы URL app и app-storage весьма полезны, т.к. могут указать на подходящий файл как на компьютере Mac, так и на компьютере Windows. Тем не менее, в остальных двух примерах, в которых для указания на каталог рабочего стола пользователя используется схема URL file, предпочтительно передавать аргумент no path конструктору File(), а затем назначать File.desktopDirectory объекту File. Таким образом, доступ к каталогу рабочего стола не будет зависеть от платформы или от пользователя.

При задании пути на компьютере Windows разделителем в аргументе может выступать прямая или обратная косая черта, а на компьютере Мас — косая черта. Для параметра path, использующего родную запись пути, действительными являются следующие значения:

  • "C:/Documents and Settings/ivan/Desktop"
  • "/Users/ivan/Desktop"

Тем не менее, в этих двух примерах следует передавать аргумент no path конструктору File(), а затем назначить File.desktopDirectory объекту File. Таким образом доступ к каталогу "Рабочий стол" не будет зависеть от платформы или от пользователя.


Выдает
ArgumentError — Неверный синтаксис параметра path.

См. также

Сведения о методе
AIR-only browseForDirectory()метод
public function browseForDirectory(title:String):void

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

Отображает для пользователя диалоговое окно выбора каталога. При выборе каталога вызывается событие select. Свойство target события select является объектом File, указывающим на выбранный каталог.

Параметры

title:String — Строка, отображаемая в области заголовка диалогового окна.


События
cancel:Event — Вызывается при нажатии кнопки "Отмена" в диалоговом окне "Открыть файл".
 
select:Event — Вызывается при выборе каталога и закрытии диалогового окна выбора каталога.

См. также

AIR-only browseForOpen()метод 
public function browseForOpen(title:String, typeFilter:Array = null):void

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

Отображает диалоговое окно "Открыть файл", где можно выбрать файл для открытия.

При выборе файла вызывается событие select. Свойство target события select — это объект File, указывающий на выбранный файл.

Параметры

title:String — Строка, отображаемая в области заголовка диалогового окна.
 
typeFilter:Array (default = null) — Массив экземпляров FileFilter, который используется для фильтрации файлов, отображенных в диалоговом окне. Если данный параметр пропущен, то отображаются все файлы. Дополнительную информацию см. в описании класса FileFilter.


События
cancel:Event — Вызывается при нажатии кнопки "Отмена" в диалоговом окне "Открыть файл".
 
select:Event — Вызывается при выборе файла и закрытии диалогового окна "Открыть файл".

См. также

AIR-only browseForOpenMultiple()метод 
public function browseForOpenMultiple(title:String, typeFilter:Array = null):void

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

Отображает диалоговое окно "Открыть файл", в котором можно выбрать один или несколько файлов для открытия.

При выборе файлов вызывается событие selectMultiple. Свойство targetсобытия select является этим объектом File. В отличие от browseForOpen(), применение метода browseForOpenMultiple() не делает объект File ссылкой на выбранные файлы. Вместо этого конечное событие selectMultiple содержит массив выбранных файлов.

Параметры

title:String — Строка, отображаемая в области заголовка диалогового окна.
 
typeFilter:Array (default = null) — Массив экземпляров FileFilter, который используется для фильтрации файлов, отображенных в диалоговом окне. Если данный параметр пропущен, то отображаются все файлы. Дополнительную информацию см. в описании класса FileFilter.


События
cancel:Event — Вызывается при нажатии кнопки "Отмена" в диалоговом окне "Открыть файл".
 
selectMultiple:FileListEvent — Вызывается при выборе файлов и закрытии диалогового окна "Открыть файл".

См. также

AIR-only browseForSave()метод 
public function browseForSave(title:String):void

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

Отображает диалоговое окно "Сохранить файл", в котором можно выбрать место назначения файла.

При выборе файла вызывается событие select. Свойство target события select является объектом File, который указывает на выбранное место для сохранения файла.

Параметры

title:String — Строка, отображаемая в области заголовка диалогового окна.


События
cancel:Event — Вызывается при нажатии кнопки "Отмена" в диалоговом окне "Сохранить файл".
 
select:Event — Вызывается при выборе файла и закрытии диалогового окна "Сохранить файл".

См. также

AIR-only cancel()метод 
override public function cancel():void

Версии среды выполнения:  1.0

Отменяет все операции, ожидающие выполнения.

AIR-only canonicalize()метод 
public function canonicalize():void

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

Канонизирует путь к файлу.

Если объект File представляет собой существующий файл или каталог, при канонизации путь корректируется для соответствия регистра в имени реального файла или каталога. Если объект File — символьная ссылка, то при канонизации путь корректируется для соответствия файлу или каталогу, на который указывает ссылка, независимо от того, существует ли такой файл или каталог.

Кроме того, при канонизации в ОС Windows короткие имена файлов переводятся в длинные.

AIR-only clone()метод 
public function clone():File

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

Возвращает копию данного объекта File. Регистрации событий не копируются.

Примечание. Данный метод не копирует сам файл. Он просто создает копию экземпляра объекта File ActionScript JavaScript. Для копирования файла пользуйтесь методом copyTo().

Возвращает
File
AIR-only copyTo()метод 
public function copyTo(newLocation:FileReference, overwrite:Boolean = false):void

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

Перемещает файл или каталог из места, заданного объектом File, в место, заданное параметром newLocation. Процесс копирования создает все необходимые родительские каталоги (если возможно).

Параметры

newLocation:FileReference — Место назначения нового файла. Обратите внимание, что данный объект File определяет конечный (скопированный) файл или каталог, а не путь к текущему каталогу.
 
overwrite:Boolean (default = false) — При значении false невозможно выполнить копирование, если файл, заданный параметром target, уже существует. При значении true в ходе операции перезаписываются все существующие файлы или каталоги с таким же именем.


Выдает
IOError — Источник не существует; либо адресат существует, и overwrite равно false; либо источник не удалось скопировать в адресат; либо источник и адресат указывают на один файл или одну папку, и overwrite установлен на true. ОС Windows не позволяет копировать открытый файл или каталог, если открыт хотя бы один из содержащихся в нем файлов.

См. также

AIR-only copyToAsync()метод 
public function copyToAsync(newLocation:FileReference, overwrite:Boolean = false):void

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

Начинает копирование файла или каталога из места, указанного данным объектом File, в место, заданное параметром destination.

После завершения вызывается событие complete (в случае успешного выполнения) или ioError (в случае невозможности завершения). Процесс копирования создает все необходимые родительские каталоги (если возможно).

Параметры

newLocation:FileReference — Место назначения нового файла. Обратите внимание, что данный объект File определяет конечный (скопированный) файл или каталог, а не путь к текущему каталогу.
 
overwrite:Boolean (default = false) — При значении false невозможно выполнить копирование, если файл, заданный параметром target, уже существует. При значении true в ходе операции сначала стираются все существующие файлы или каталоги с таким же именем.


События
complete:Event — Вызывается при успешном копировании файла или каталога.
 
ioError:IOErrorEvent — Источник не существует; либо адресат существует, и overwrite равно false; либо источник не удалось скопировать в адресат; либо источник и адресат указывают на один файл или одну папку, и overwrite установлен на true. ОС Windows не позволяет копировать открытый файл или каталог, если открыт хотя бы один из содержащихся в нем файлов.

См. также

AIR-only createDirectory()метод 
public function createDirectory():void

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

Создает указанный каталог и все необходимые родительские каталоги. Если каталог уже существует, никаких действий не предпринимается.


Выдает
IOError — Каталог не существовал и не мог быть создан.
AIR-only createTempDirectory()метод 
public static function createTempDirectory():File

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

Возвращает ссылку на новый временный каталог. Это новый каталог в пути временного системного каталога.

Этот метод позволяет определить новый уникальный каталог, не запрашивая об этом систему.

Перед закрытием приложения рекомендуется удалять временные каталоги, так как они не удаляются автоматически.

Возвращает
File — Объект File, ссылающийся на новый временный каталог.

См. также

AIR-only createTempFile()метод 
public static function createTempFile():File

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

Возвращает ссылку на новый временный файл. Это новый файл в пути временного системного каталога.

Этот метод позволяет определить новый уникальный файл, не запрашивая об этом систему.

Перед закрытием приложения рекомендуется удалять временные файлы, так как они не удаляются автоматически.

Возвращает
File — Объект File, ссылающийся на новый временный файл.

См. также

AIR-only deleteDirectory()метод 
public function deleteDirectory(deleteDirectoryContents:Boolean = false):void

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

Удаляет каталог.

Параметры

deleteDirectoryContents:Boolean (default = false) — Указывает, можно ли удалять каталог, содержащий файлы или подкаталоги. При значении false вызов этого метода создает исключение, если каталог содержит файлы или подкаталоги.


Выдает
IOError — Каталог нельзя удалить, или он не существует. ОС Windows не позволяет удалять каталог, если открыт хотя бы один из содержащихся в нем файлов.

См. также

AIR-only deleteDirectoryAsync()метод 
public function deleteDirectoryAsync(deleteDirectoryContents:Boolean = false):void

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

Удаляет каталог в асинхронном режиме.

Параметры

deleteDirectoryContents:Boolean (default = false) — Указывает, можно ли удалять каталог, содержащий файлы или подкаталоги. При значении false объект File вызывает событие ioError, если каталог содержит файлы или подкаталоги.


События
complete:Event — Вызывается при успешном удалении каталога.
 
ioError:IOErrorEvent — Каталог не может быть удален или такого каталога не существует. ОС Windows не позволяет удалять каталог, если открыт хотя бы один из содержащихся в нем файлов.

См. также

AIR-only deleteFile()метод 
public function deleteFile():void

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

Удаляет файл.


Выдает
IOError — Файл не может быть удален или такого файла не существует. ОС Windows не позволяет удалять открытые файлы.

См. также

AIR-only deleteFileAsync()метод 
public function deleteFileAsync():void

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

Удаляет файл в асинхронном режиме.


События
complete:Event — Вызывается при успешном удалении файла.
 
ioError:IOErrorEvent — Файл не может быть удален или такого файла не существует. ОС Windows не позволяет удалять открытые файлы.

См. также

AIR-only getDirectoryListing()метод 
public function getDirectoryListing():Array

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

Возвращает массив объектов File, связанных с файлами и каталогами, размещенными в каталоге, представленном данным объектом File. При использовании этого метода не рассматривается содержимое подкаталогов.

Возвращает
Array — Массив объектов File.

См. также

AIR-only getDirectoryListingAsync()метод 
public function getDirectoryListingAsync():void

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

В асинхронном режиме формирует массив объектов File, связанных с содержимым каталога, который представляется данным объектом File.


События
ioError:ErrorEvent — У вас нет прав для чтения данного каталога или его не существует.
 
directoryListing:FileListEvent — Содержимое каталога успешно пересчитано. Событие contents обладает свойством files, что является конечным массивом объектов File.

См. также

AIR-only getRelativePath()метод 
public function getRelativePath(ref:FileReference, useDotDot:Boolean = false):String

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

Находит среди двух путей к файлу относительный путь.

Относительный путь — это список компонентов, которые могут быть добавлены (разрешены по отношению) к этой ссылке для обнаружения второй (параметрической) ссылки. Для записи возвращенного относительного пути используется разделитель "/".

В других случаях относительные пути могут содержать ссылки "..", но такие пути не могут превышать предельного объема.

Параметры

ref:FileReference — Объект File, относительно которого задан путь.
 
useDotDot:Boolean (default = false) — Указывает, может ли конечный относительный путь использовать компоненты "..".

Возвращает
String — Относительный путь между этим файлом (или каталогом) и файлом (или каталогом) ref, если возможно; в противном случае — null.

Выдает
ArgumentError — Ссылка имеет значение null.
 
SecurityError — Вызывающий оператор не находится в изолированной программной среде безопасности.
AIR-only getRootDirectories()метод 
public static function getRootDirectories():Array

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

Возвращается массив объектов File, в котором перечислены корневые каталоги файловой системы.

Например, в ОС Windows это список томов, таких как C: и D:. Пустой том, например CD- или DVD-привод, в который не установлен диск, не учитывается в массиве.

Возвращает
Array — Массив объектов File, в котором перечислены корневые каталоги.
AIR-only moveTo()метод 
public function moveTo(newLocation:FileReference, overwrite:Boolean = false):void

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

Перемещает файл или каталог из места, заданного объектом File, в место, заданное параметром destination.

Для переименования файла задайте параметр destination, чтобы он указывал на путь в каталог, содержащий файл, но с другим именем файла.

Процесс перемещения создает все необходимые родительские каталоги (если возможно).

Параметры

newLocation:FileReference — Место назначения для перемещения. Этот объект указывает путь к конечному (перемещенному) файлу или каталогу, а не к исходному каталогу.
 
overwrite:Boolean (default = false) — При значении false перемещение не выполняется, если целевой файл уже существует. При значении true в ходе операции сначала стираются все существующие файлы или каталоги с таким же именем.


Выдает
IOError — Источник не существует; либо адресат существует, и overwrite установлен на false; либо исходный файл или каталог не мог быть перемещен в целевое местоположение; либо источник и адресат указывают на один файл или одну папку, и overwrite установлен на true. ОС Windows не позволяет перемещать открытый файл или каталог, если открыт хотя бы один из содержащихся в нем файлов.

См. также

AIR-only moveToAsync()метод 
public function moveToAsync(newLocation:FileReference, overwrite:Boolean = false):void

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

Перемещает файл или каталог из места, заданного объектом File, в место, заданное параметром newLocation.

Для переименования файла задайте параметр destination, чтобы он указывал на путь в каталог, содержащий файл, но с другим именем файла.

Процесс перемещения создает все необходимые родительские каталоги (если возможно).

Параметры

newLocation:FileReference — Место назначения для перемещения. Этот объект указывает путь к конечному (перемещенному) файлу или каталогу, а не к исходному каталогу.
 
overwrite:Boolean (default = false) — При значении false перемещение не выполняется, если целевой файл уже существует. При значении true в ходе операции сначала стираются все существующие файлы или каталоги с таким же именем.


События
complete:Event — Вызывается при успешном перемещении файла или каталога.
 
ioError:IOErrorEvent — Источник не существует; либо адресат существует, и overwrite равно false; либо источник не удалось переместить в адресат; либо источник и адресат указывают на один файл или одну папку, и overwrite установлен на true. ОС Windows не позволяет перемещать открытый файл или каталог, если открыт хотя бы один из содержащихся в нем файлов.

См. также

AIR-only moveToTrash()метод 
public function moveToTrash():void

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

Перемещает файл или каталог в корзину.


Выдает
IOError — Операционная система не разрешила выполнить операцию, либо файла или каталога не существует. ОС Windows не позволяет перемещать открытый файл или каталог, если открыт хотя бы один из содержащихся в нем файлов.

См. также

AIR-only moveToTrashAsync()метод 
public function moveToTrashAsync():void

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

Перемещает файл или каталог в корзину в асинхронном режиме.


События
ioError:IOErrorEvent — Операционная система не разрешила выполнить операцию, либо файла или каталога не существует. ОС Windows не позволяет перемещать открытый файл или каталог, если открыт хотя бы один из содержащихся в нем файлов.
 
complete:Event — Вызывается при успешном перемещении файла или каталога в корзину.

См. также

AIR-only resolvePath()метод 
public function resolvePath(path:String):File

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

Создает новый объект File с путем, связанным с путем данного объекта File, на основе параметра path (строки).

В качестве параметра path можно использовать относительный или абсолютный путь.

При указании относительного пути, заданный path добавляется в конец пути объекта File. Однако использование ".." в записи path может возвратить путь, не являющийся дочерним путем объекта File. Полученная ссылка необязательно должна ссылаться на действительное место расположения файловой системы.

При указании абсолютной ссылки на файл метод возвращает объект File, указывающий на этот путь. В абсолютной ссылке на файл должен использоваться допустимый синтаксис пути, присущий операционной системе пользователя (например, "C:\\test" в Windows). Не используйте URL-адрес (например, "file:///c:/test") в качестве параметра path.

Все полученные пути нормализуются следующим образом:

В Mac OS в качестве разделителя в записи пути используется левая косая черта (/). В Windows можно использовать как левую (/), так и правую косую черту (\).

Параметры

path:String — Путь, который нужно добавить в конец пути данного объекта File (если параметр path представляет относительный путь); или возвращаемый путь (если параметр path представляет абсолютный путь).

Возвращает
File — Новый объект File, указывающий на получившийся путь.
Сведения о событии
AIR-only cancel Событие
Тип объекта события: flash.events.Event
свойство Event.type = flash.events.Event.CANCEL

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

Вызывается при отмене асинхронной операции, ожидающей выполнения.

Константа Event.CANCEL определяет значение свойства type объекта события cancel.

Данное событие имеет следующие свойства.

СвойствоЗначение
bubblesfalse
cancelablefalse; нет поведения по умолчанию для отмены.
currentTargetОбъект, активно обрабатывающий объект Event с помощью прослушивателя событий.
targetСсылка на объект, для которого отменена операция.
AIR-only complete Событие  
Тип объекта события: flash.events.Event
свойство Event.type = flash.events.Event.COMPLETE

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

Вызывается при завершении асинхронной операции.

Константа Event.COMPLETE определяет значение свойства type объекта complete.

Данное событие имеет следующие свойства.

СвойствоЗначение
bubblesfalse
cancelablefalse; нет поведения по умолчанию для отмены.
currentTargetОбъект, активно обрабатывающий объект Event с помощью прослушивателя событий.
targetСетевой объект, который завершил загрузку.
AIR-only directoryListing Событие  
Тип объекта события: flash.events.FileListEvent
свойство FileListEvent.type = flash.events.FileListEvent.DIRECTORY_LISTING

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

Вызывается, когда в результате запроса метода getDirectoryListingAsync() становится доступен список каталогов.

Константа FileListEvent.DIRECTORY_LISTING определяет значение свойства type объекта события directoryListing.

Данное событие имеет следующие свойства.

СвойствоЗначение
bubblesfalse
cancelablefalse; нет поведения по умолчанию для отмены.
filesМассив объектов File, представляющий найденные файлы и каталоги.
targetОбъект FileListEvent.

См. также

AIR-only ioError Событие  
Тип объекта события: flash.events.IOErrorEvent
свойство IOErrorEvent.type = flash.events.IOErrorEvent.IO_ERROR

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

Вызывается, когда при выполнении асинхронной операции над файлом происходит ошибка.

Задает значение свойства type для объекта события ioError.

Данное событие имеет следующие свойства.

СвойствоЗначение
bubblesfalse
cancelablefalse; нет поведения по умолчанию для отмены.
currentTargetОбъект, активно обрабатывающий объект Event с помощью прослушивателя событий.
targetСетевой объект, с которым произошла ошибка ввода/вывода.
textТекст, отображаемый в качестве сообщения об ошибке.
AIR-only securityError Событие  
Тип объекта события: flash.events.SecurityErrorEvent
свойство SecurityErrorEvent.type = flash.events.SecurityErrorEvent.SECURITY_ERROR

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

Вызывается, когда операция нарушает ограничения безопасности.

Константа SecurityErrorEvent.SECURITY_ERROR определяет значение свойства type для объекта события securityError.

Данное событие имеет следующие свойства.

СвойствоЗначение
bubblesfalse
cancelablefalse; нет поведения по умолчанию для отмены.
currentTargetОбъект, активно обрабатывающий объект Event с помощью прослушивателя событий.
targetСетевой объект, сообщающий об ошибке безопасности.
textТекст, отображаемый в качестве сообщения об ошибке.
AIR-only select Событие  
Тип объекта события: flash.events.Event
свойство Event.type = flash.events.Event.SELECT

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

Вызывается, когда пользователь выбирает файл или каталог из окна просмотра файлов или каталогов.

Константа Event.SELECT определяет значение свойства type объекта события select.

Данное событие имеет следующие свойства.

СвойствоЗначение
bubblesfalse
cancelablefalse; нет поведения по умолчанию для отмены.
currentTargetОбъект, активно обрабатывающий объект Event с помощью прослушивателя событий.
targetОбъект, в котором выделен элемент.
AIR-only selectMultiple Событие  
Тип объекта события: flash.events.FileListEvent
свойство FileListEvent.type = flash.events.FileListEvent.SELECT_MULTIPLE

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

Вызывается, когда пользователь выбирает файлы из диалогового окна, открывшегося по вызову метода browseForOpenMultiple().

Константа FileListEvent.SELECT_MULTIPLE определяет значение свойства type объекта события selectMultiple.
СвойствоЗначение
bubblesfalse
cancelablefalse; нет поведения по умолчанию для отмены.
filesМассив объектов File, представляющий выделенные файлы.
targetОбъект FileListEvent.

См. также