Класс FileSystemView

java.lang.Object

javax.swing.filechooser.FileSystemView

public abstract class FileSystemView extends Object

FileSystemView — шлюз JFileChooser к файловой системе. Поскольку API файлов JDK 1.1 не позволяет получить доступ к такой информации, как корневые разделы, информация о типе файла или биты скрытых файлов, этот класс предназначен для интуитивного восприятия как можно большего количества информации о файловой системе, специфичной для ОС.

Разработчики лицензии Java могут предоставить другую реализацию FileSystemView, чтобы лучше обрабатывать конкретную операционную систему.

Краткое описание конструкторов

Конструктор	Описание
`FileSystemView()`	Создаёт FileSystemView.

Краткое описание методов

Модификатор и тип	Метод	Описание
`File`	`createFileObject(File dir, String filename)`	Возвращает объект File, созданный в dir из данного имени файла.
`File`	`createFileObject(String path)`	Возвращает объект File, созданный из заданной строки пути.
`protected File`	`createFileSystemRoot(File f)`	Создаёт новый объект `File` для `f` с правильным поведением для корневого каталога файловой системы.
`abstract File`	`createNewFolder(File containingDir)`	Создаёт новую папку с именем папки по умолчанию.
`File`	`getChild(File parent, String fileName)`
`File[]`	`getChooserComboBoxFiles()`	Возвращает массив файлов, представляющих значения, которые будут отображаться в селекторе выбора файла.
`final File[]`	`getChooserShortcutPanelFiles()`	Возвращает массив файлов, представляющих значения, которые будут отображаться по умолчанию в панели ярлыков обозревателя файлов.
`File`	`getDefaultDirectory()`	Возвращает стандартный начальный каталог пользователя для обозревателя файлов.
`File[]`	`getFiles(File dir, boolean useFileHiding)`	Получает список отображаемых (т.е. не скрытых) файлов.
`static FileSystemView`	`getFileSystemView()`	Возвращает представление файловой системы.
`File`	`getHomeDirectory()`	Возвращает домашний каталог.
`File`	`getLinkLocation(File file)`	Возвращает обычный файл, на который ссылается указанный файл ссылки, если указанный файл является ссылкой, интерпретируемой оболочкой.
`File`	`getParentDirectory(File dir)`	Возвращает родительский каталог `dir`.
`File[]`	`getRoots()`	Возвращает все корневые разделы в этой системе.
`String`	`getSystemDisplayName(File f)`	Имя файла, каталога или папки, как оно отображается в обозревателе файлов системы.
`Icon`	`getSystemIcon(File f)`	Иконка для файла, каталога или папки, как она отображается в обозревателе файлов системы.
`Icon`	`getSystemIcon(File f, int width, int height)`	Возвращает иконку для файла, каталога или папки, как она отображается в обозревателе файлов системы для запрошенного размера.
`String`	`getSystemTypeDescription(File f)`	Описание типа файла, каталога или папки, как оно отображается в обозревателе файлов системы.
`boolean`	`isComputerNode(File dir)`	Используется классами пользовательского интерфейса для определения, нужно ли отображать специальную иконку для узла компьютера, например.
`boolean`	`isDrive(File dir)`	Используется классами пользовательского интерфейса для определения, нужно ли отображать специальную иконку для дисков или разделов, например, иконку «жесткий диск».
`boolean`	`isFileSystem(File f)`	Проверяет, представляет ли `f` реальный каталог или файл по сравнению со специальной папкой, такой как `"Desktop"`.
`boolean`	`isFileSystemRoot(File dir)`	Является ли dir корнем дерева в файловой системе, например, диск или раздел.
`boolean`	`isFloppyDrive(File dir)`	Используется классами пользовательского интерфейса для определения, нужно ли отображать специальную иконку для гибкого диска.
`boolean`	`isHiddenFile(File f)`	Возвращает, скрыт ли файл или нет.
`boolean`	`isLink(File file)`	Возвращает, обозначает ли указанный файл ссылку, интерпретируемую оболочкой, которая может быть получена с помощью `getLinkLocation(File)`.
`boolean`	`isParent(File folder, File file)`	В Windows файл может отображаться в нескольких папках, помимо родительского каталога в файловой системе.
`boolean`	`isRoot(File f)`	Определяет, является ли данный файл корнем в навигационном дереве(ах).
`Boolean`	`isTraversable(File f)`	Возвращает true, если к файлу (каталогу) можно получить доступ.

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Подробное описание конструкторов

FileSystemView

public FileSystemView()

Создаёт FileSystemView.

Подробное описание методов

getFileSystemView

public static FileSystemView getFileSystemView()

Возвращает представление файловой системы.

Возвращает:: представление файловой системы

isRoot

public boolean isRoot(File f)

Определяет, является ли заданный файл корневым в навигационной древовидной структуре. Примеры: Windows 98 имеет один корень, папку Рабочий стол. DOS имеет один корень на букву диска, C:\, D:\, и т. д. Unix имеет один корень, каталог "/". Реализация по умолчанию получает информацию из класса ShellFolder.

Параметры:

f - объект File представляющий каталог

Возвращает:

true если f является корнем в навигационной древовидной структуре.

См. также:

isFileSystemRoot(java.io.File)

isTraversable

public Boolean isTraversable(File f)

Возвращает true, если файл (каталог) может быть посещён. Возвращает false, если каталог не может быть просмотрен.

Параметры:

f - File

Возвращает:

true если файл/каталог может быть просмотрен, иначе false

С:

1.4

См. также:

getSystemDisplayName

public String getSystemDisplayName(File f)

Имя файла, каталога или папки, как оно отображается в проводнике системы. Пример из Windows: каталог "M:\" отображается как "CD-ROM (M:)". Реализация по умолчанию получает информацию из класса ShellFolder.

Параметры:

f - объект File

Возвращает:

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

С:

1.4

См. также:

JFileChooser.getName(java.io.File)

getSystemTypeDescription

public String getSystemTypeDescription(File f)

Описание типа файла, каталога или папки, как оно отображается в проводнике системы. Пример из Windows: папка "Рабочий стол" описывается как "Рабочий стол". Переопределите для платформ с собственными реализациями ShellFolder.

Параметры:

f - объект File

Возвращает:

описание типа файла, как оно отображается стандартным файловым выбором, или null, если нет доступной нативной информации.

С:

1.4

См. также:

JFileChooser.getTypeDescription(java.io.File)

getSystemIcon

public Icon getSystemIcon(File f)

Иконка файла, каталога или папки, как она отображается в проводнике системы. Пример из Windows: каталог "M:\" отображается с иконкой CD-ROM.

Реализация по умолчанию получает информацию из класса ShellFolder.

Параметры:

f - объект File

Возвращает:

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

С:

1.4

См. также:

JFileChooser.getIcon(java.io.File)

getSystemIcon

public Icon getSystemIcon(File f, int width, int height)

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

Пример:

     FileSystemView fsv = FileSystemView.getFileSystemView();
     Icon icon = fsv.getSystemIcon(new File("application.exe"), 64, 64);
     JLabel label = new JLabel(icon);

Требования к реализации:

Доступные иконки могут быть платформозависимыми, поэтому доступные размеры определяются платформой. Поэтому точное соответствие запрошенному размеру может быть невозможно. Возвращаемая иконка может быть многоразмерной изображением иконки, что позволяет лучше поддерживать среды High DPI с различными коэффициентами масштабирования.

Параметры:

f - объект File для которого будет получена иконка

width - ширина иконки в системе координат пользователя.

height - высота иконки в системе координат пользователя.

Возвращает:

иконка, как она отображается стандартным файловым выбором, или null для не существующего или недоступного файла.

Исключения:

IllegalArgumentException - если передан неверный параметр, например, отрицательный размер или null ссылка на файл.

С:

См. также:

isParent

public boolean isParent(File folder, File file)

В Windows файл может отображаться в нескольких папках помимо его родительского каталога в файловой системе. Например, папка «Рабочий стол» может не совпадать с file.getParentFile().

Параметры:: folder - объект File представляющий каталог или специальную папку; file - объект File
Возвращает:: true если folder является каталогом или специальной папкой и содержит file.
С:: 1.4

getChild

public File getChild(File parent, String fileName)

Параметры:: parent - объект File представляющий каталог или специальную папку; fileName - имя файла или папки, которое существует в parent
Возвращает:: объект File. Обычно он создаётся с помощью new File(parent, fileName) за исключением случаев, когда родительская и дочерняя папки являются специальными папками, в этом случае File является оболочкой, содержащей объект ShellFolder.
С:: 1.4

isFileSystem

public boolean isFileSystem(File f)

Проверяет, представляет ли f реальный каталог или файл, а не специальную папку, например, "Desktop". Классы пользовательского интерфейса используют это для определения, можно ли выбрать папку при выборе каталога.

Параметры:: f - объект File
Возвращает:: true если f является реальным файлом или каталогом.
С:: 1.4

createNewFolder

public abstract File createNewFolder(File containingDir) throws IOException

Создаёт новую папку с именем по умолчанию.

Параметры:: containingDir - объект File обозначающий каталог, содержащий новую папку
Возвращает:: объект File обозначающий вновь созданную папку
Исключения:: IOException - если новая папка не может быть создана

isHiddenFile

public boolean isHiddenFile(File f)

Возвращает, является ли файл скрытым или нет.

Параметры:: f - объект File
Возвращает:: true, если данный File обозначает скрытый файл

isFileSystemRoot

public boolean isFileSystemRoot(File dir)

Является ли dir корнем древа в файловой системе, например, диск или раздел. Пример: Возвращает true для "C:\" в Windows 98.

Параметры:

dir - объект File представляющий каталог

Возвращает:

true если f является корнем файловой системы

С:

1.4

См. также:

isRoot(java.io.File)

isDrive

public boolean isDrive(File dir)

Используется классами UI для определения необходимости отображения специальной иконки для дисков или разделов, например, иконки "жёсткий диск". Реализация по умолчанию не может этого определить, поэтому всегда возвращает false.

Параметры:: dir - каталог
Возвращает:: false всегда
С:: 1.4

isFloppyDrive

public boolean isFloppyDrive(File dir)

Используется классами UI для определения необходимости отображения специальной иконки для дискеты. Подразумевает isDrive(dir). Реализация по умолчанию не может этого определить, поэтому всегда возвращает false.

Параметры:: dir - каталог
Возвращает:: false всегда
С:: 1.4

isComputerNode

public boolean isComputerNode(File dir)

Используется классами UI для определения необходимости отображения специальной иконки для узла компьютера, например, «Мой компьютер» или сетевого сервера. Реализация по умолчанию не может этого определить, поэтому всегда возвращает false.

Параметры:: dir - каталог
Возвращает:: false всегда
С:: 1.4

getRoots

public File[] getRoots()

Возвращает все корневые разделы в этой системе. Например, в Windows это папка "Рабочий стол", а в DOS — это диски от A: до Z:.

Возвращает:: массив объектов File, представляющих все корневые разделы в этой системе

getHomeDirectory

public File getHomeDirectory()

Возвращает домашний каталог.

Возвращает:: домашний каталог

getDefaultDirectory

public File getDefaultDirectory()

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

Возвращает:: объект File , представляющий стандартную папку запуска
С:: 1.4

createFileObject

public File createFileObject(File dir, String filename)

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

Параметры:: dir — абстрактное имя пути, обозначающее каталог; filename — представление String пути
Возвращает:: объект File , созданный из dir и filename

createFileObject

public File createFileObject(String path)

Возвращает объект File, созданный из заданной строки пути.

Параметры:: path — представление String пути
Возвращает:: объект File , созданный из заданного path

getFiles

public File[] getFiles(File dir, boolean useFileHiding)

Получает список отображаемых (т.е. не скрытых) файлов.

Параметры:: dir — корневой каталог файлов, которые нужно вернуть; useFileHiding — определить, возвращать ли скрытые файлы
Возвращает:: массив объектов File , представляющих файлы и каталоги в данном dir. Он включает скрытые файлы, если useFileHiding равно false.

getParentDirectory

public File getParentDirectory(File dir)

Возвращает родительский каталог dir.

Параметры:: dir — запрашиваемый File
Возвращает:: родительский каталог dir, или null, если dir равно null

getChooserComboBoxFiles

public File[] getChooserComboBoxFiles()

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

Возвращает:: массив объектов File. Возвращаемый массив может быть пустым, если нет соответствующих прав доступа.
С:: 9

getChooserShortcutPanelFiles

public final File[] getChooserShortcutPanelFiles()

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

Возвращает:: массив объектов File. Возвращаемый массив может быть пустым, если нет соответствующих прав доступа.
С:: 12

isLink

public boolean isLink(File file)

Возвращает значение, указывающее, обозначает ли указанный файл ссылку интерпретируемую оболочкой, которую можно получить с помощью getLinkLocation(File).

Параметры:

file — файл

Возвращает:

является ли это ссылкой

Исключения:

NullPointerException — если file равно null

SecurityException — если у вызывающего кода нет необходимых разрешений

С:

См. также:

getLinkLocation(File)

getLinkLocation

public File getLinkLocation(File file) throws FileNotFoundException

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

Параметры:: file — файл
Возвращает:: связанный файл или null
Исключения:: FileNotFoundException — если связанный файл не существует; NullPointerException — если file равно null; SecurityException — если у вызывающего кода нет необходимых разрешений
С:: 9

createFileSystemRoot

protected File createFileSystemRoot(File f)

Создаёт новый объект File для f с правильным поведением для корневого каталога файловой системы.

Параметры:: f — объект File , представляющий корневой каталог файловой системы, например "/" в Unix или "C:\" в Windows.
Возвращает:: новый объект File
С:: 1.4

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.desktop/javax/swing/filechooser/FileSystemView.html