Класс FileDialog

Все реализованные интерфейсы:
ImageObserver, MenuContainer, Serializable, Accessible
public class FileDialog
extends Dialog

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

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

С тех пор:
1.0
См. также:
Window.show(), Сериализованная форма

Вложенные классы

Вложенные классы/интерфейсы, объявленные в классе java.awt.Dialog

Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType

Вложенные классы/интерфейсы, объявленные в классе java.awt.Window

Window.AccessibleAWTWindow, Window.Type

Вложенные классы/интерфейсы, объявленные в классе java.awt.Container

Container.AccessibleAWTContainer

Вложенные классы/интерфейсы, объявленные в классе java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Поля

Модификатор и тип Поле Описание
static int LOAD

Это постоянное значение указывает, что назначение окна диалога выбора файла — найти файл для чтения.

static int SAVE

Это постоянное значение указывает, что назначение окна диалога выбора файла — найти файл для записи.

Поля, объявленные в классе java.awt.Dialog

DEFAULT_MODALITY_TYPE

Поля, объявленные в классе java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Поля, объявленные в интерфейсе java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Конструкторы

Конструктор Описание
FileDialog​(Dialog parent)

Создает диалоговое окно для загрузки файла.

FileDialog​(Dialog parent, String title)

Создает окно диалога выбора файла с указанным заголовком для загрузки файла.

FileDialog​(Dialog parent, String title, int mode)

Создает окно диалога выбора файла с указанным заголовком для загрузки или сохранения файла.

FileDialog​(Frame parent)

Создает диалоговое окно для загрузки файла.

FileDialog​(Frame parent, String title)

Создаёт окно диалога выбора файла с указанным заголовком для загрузки файла.

FileDialog​(Frame parent, String title, int mode)

Создаёт окно диалога выбора файла с указанным заголовком для загрузки или сохранения файла.

Методы

Модификатор и тип Метод Описание
void addNotify()

Создаёт виджет диалогового окна выбора файла.

String getDirectory()

Получает директорию этого диалогового окна выбора файла.

String getFile()

Получает выбранный файл этого диалогового окна выбора файла.

FilenameFilter getFilenameFilter()

Определяет фильтр имён файлов для этого диалогового окна выбора файла.

File[] getFiles()

Возвращает файлы, которые выбрал пользователь.

int getMode()

Указывает, предназначено ли это диалоговое окно выбора файла для загрузки из файла или для сохранения в файл.

boolean isMultipleMode()

Возвращает, разрешает ли диалоговое окно выбора файла выбор нескольких файлов.

protected String paramString()

Возвращает строку, представляющую состояние этого окна FileDialog.

void setDirectory​(String dir)

Устанавливает директорию этого окна диалога выбора файла на указанную директорию.

void setFile​(String file)

Устанавливает выбранный файл для этого окна диалога выбора файла на указанный файл.

void setFilenameFilter​(FilenameFilter filter)

Устанавливает фильтр имён файлов для этого окна диалога выбора файла на указанный фильтр.

void setMode​(int mode)

Устанавливает режим диалогового окна выбора файла.

void setMultipleMode​(boolean enable)

Включает или отключает выбор нескольких файлов для диалогового окна выбора файла.

void setTitle​(String title)

Устанавливает заголовок диалогового окна.

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

getAccessibleContext, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setModalityType, setResizable, setUndecorated, setVisible, show, toBack

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

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBackground, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setOpacity, setShape, setSize, setSize, setType, toFront

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

add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, setLayout, transferFocusDownCycle, update, validate, validateTree

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

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

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

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

Поля

LOAD

public static final int LOAD

Это константа, указывающая, что окно диалога файла предназначено для поиска файла для чтения.

См. также:
Значения константных полей

SAVE

public static final int SAVE

Это константа, указывающая, что окно диалога файла предназначено для поиска файла для записи.

См. также:
Значения константных полей

Конструкторы

FileDialog

public FileDialog(Frame parent)

Создаёт диалоговое окно для загрузки файла. Заголовок диалогового окна изначально пустой. Это удобный метод для FileDialog(parent, "", LOAD).

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

Параметры:
parent - владелец диалогового окна
С:
1.1

FileDialog

public FileDialog(Frame parent,
                  String title)

Создаёт окно диалога файла со заданным заголовком для загрузки файла. Отображаемые файлы — файлы в текущей директории. Это удобный метод для FileDialog(parent, title, LOAD).

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

Параметры:
parent - владелец диалогового окна
title - заголовок диалогового окна

FileDialog

public FileDialog(Frame parent,
                  String title,
                  int mode)

Создаёт окно диалога файла со заданным заголовком для загрузки или сохранения файла.

Если значение mode равно LOAD, то диалоговое окно файла ищет файл для чтения, и отображаются файлы в текущей директории. Если значение mode равно SAVE, то диалоговое окно файла ищет место для записи файла.

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

Параметры:
parent - владелец диалогового окна
title - заголовок диалогового окна
mode - режим диалогового окна; либо FileDialog.LOAD, либо FileDialog.SAVE
Исключения:
IllegalArgumentException - если задан недопустимый режим диалогового окна
См. также:
LOAD, SAVE

FileDialog

public FileDialog(Dialog parent)

Создаёт диалоговое окно для загрузки файла. Заголовок диалогового окна изначально пустой. Это удобный метод для FileDialog(parent, "", LOAD).

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

Параметры:
parent - владелец диалогового окна
Исключения:
IllegalArgumentException - если parent не из устройства экрана;
IllegalArgumentException - если parent равно null; это исключение всегда выбрасывается, когда GraphicsEnvironment.isHeadless возвращает true
С:
1.5
См. также:
GraphicsEnvironment.isHeadless()

FileDialog

public FileDialog(Dialog parent,
                  String title)

Создаёт окно диалога файла со заданным заголовком для загрузки файла. Отображаемые файлы — файлы в текущей директории. Это удобный метод для FileDialog(parent, title, LOAD).

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

Параметры:
parent - владелец диалогового окна
title - заголовок диалогового окна; значение null будет принято без выброса NullPointerException
Исключения:
IllegalArgumentException - если parent не из устройства экрана;
IllegalArgumentException - если parent равно null; это исключение всегда выбрасывается, когда GraphicsEnvironment.isHeadless возвращает true
С:
1.5
См. также:
GraphicsEnvironment.isHeadless()

FileDialog

public FileDialog(Dialog parent,
                  String title,
                  int mode)

Создаёт окно диалога файла со заданным заголовком для загрузки или сохранения файла.

Если значение mode равно LOAD, то диалоговое окно файла ищет файл для чтения, и отображаются файлы в текущей директории. Если значение mode равно SAVE, то диалоговое окно файла ищет место для записи файла.

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

Параметры:
parent - владелец диалогового окна
title - заголовок диалогового окна; значение null будет принято без выброса NullPointerException
mode - режим диалогового окна; либо FileDialog.LOAD, либо FileDialog.SAVE
Исключения:
IllegalArgumentException - если задан недопустимый режим диалогового окна;
IllegalArgumentException - если parent не из устройства экрана;
IllegalArgumentException - если parent равно null; это исключение всегда выбрасывается, когда GraphicsEnvironment.isHeadless возвращает true
С:
1.5
См. также:
GraphicsEnvironment.isHeadless(), LOAD, SAVE

Методы

setTitle

public void setTitle(String title)

Устанавливает заголовок диалогового окна.

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

Переопределяет:
setTitle в классе Dialog
Параметры:
title - заголовок, отображаемый в рамке диалогового окна; значение null приводит к пустому заголовку
См. также:
Dialog.getTitle()

addNotify

public void addNotify()

Создаёт компонент диалогового окна выбора файла. Компонент позволяет изменять внешний вид диалогового окна, не изменяя его функциональность.

Переопределяет:
addNotify в классе Dialog
См. также:
Component.isDisplayable(), Container.removeNotify()

getMode

public int getMode()

Указывает, предназначено ли это диалоговое окно для загрузки файла или для сохранения файла.

Возвращает:
режим этого окна диалогового выбора файла: FileDialog.LOAD или FileDialog.SAVE
См. также:
LOAD, SAVE, setMode(int)

setMode

public void setMode(int mode)

Устанавливает режим диалогового окна. Если mode не является допустимым значением, будет выброшено исключение, и mode не будет установлено.

Параметры:
mode - режим этого диалогового окна выбора файла: FileDialog.LOAD или FileDialog.SAVE
Исключения:
IllegalArgumentException - если задан недопустимый режим диалогового окна выбора файла
С:
1.1
См. также:
LOAD, SAVE, getMode()

getDirectory

public String getDirectory()

Получает каталог этого диалогового окна выбора файла.

Возвращает:
каталог (возможно null или недопустимый) этого FileDialog
См. также:
setDirectory(java.lang.String)

setDirectory

public void setDirectory(String dir)

Устанавливает каталог этого диалогового окна выбора файла на указанный каталог. Указание null или недопустимого каталога подразумевает определение реализации по умолчанию. Однако эта по умолчанию не будет реализована, пока пользователь не выберет файл. До этого момента getDirectory() вернёт значение, переданное в этот метод.

Указание "" в качестве каталога полностью эквивалентно указанию null в качестве каталога.

Параметры:
dir - указанный каталог
См. также:
getDirectory()

getFile

public String getFile()

Получает выбранный файл этого диалогового окна выбора файла. Если пользователь выбрал CANCEL, возвращаемый файл null.

Возвращает:
текущий выбранный файл этого диалогового окна выбора файла или null, если ни один не выбран
См. также:
setFile(java.lang.String)

getFiles

public File[] getFiles()

Возвращает файлы, выбранные пользователем.

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

Возвращает:
файлы, выбранные пользователем, или пустой массив, если пользователь отменяет диалоговое окно выбора файла.
С:
1.7
См. также:
setFile(String), getFile()

setFile

public void setFile(String file)

Устанавливает выбранный файл для этого диалогового окна выбора файла в указанный файл. Этот файл становится файлом по умолчанию, если он установлен до первого отображения диалогового окна выбора файла.

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

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

Указание "" в качестве файла полностью эквивалентно указанию null в качестве файла.

Параметры:
file - устанавливаемый файл
См. также:
getFile(), getFiles()

setMultipleMode

public void setMultipleMode(boolean enable)

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

Параметры:
enable - если true, многократный выбор файлов включен; false - отключен.
С:
1.7
См. также:
isMultipleMode()

isMultipleMode

public boolean isMultipleMode()

Возвращает, разрешает ли диалоговое окно выбора файлов выбор нескольких файлов.

Возвращает:
true если диалоговое окно выбора файлов разрешает выбор нескольких файлов; false в противном случае.
С:
1.7
См. также:
setMultipleMode(boolean)

getFilenameFilter

public FilenameFilter getFilenameFilter()

Определяет фильтр имён файлов этого диалогового окна выбора файла. Фильтр имён файлов позволяет пользователю указать, какие файлы появятся в окне диалогового выбора файла. Фильтры имён файлов не работают в справочной реализации Sun для Microsoft Windows.

Возвращает:
фильтр имён файлов этого диалогового окна выбора файла
См. также:
FilenameFilter, setFilenameFilter(java.io.FilenameFilter)

setFilenameFilter

public void setFilenameFilter(FilenameFilter filter)

Устанавливает фильтр имён файлов для этого диалогового окна выбора файла на указанный фильтр. Фильтры имён файлов не работают в справочной реализации Sun для Microsoft Windows.

Параметры:
filter - указанный фильтр
См. также:
FilenameFilter, getFilenameFilter()

paramString

protected String paramString()

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

Переопределяет:
paramString в классе Dialog
Возвращает:
строку параметров этого диалогового окна выбора файла

© 1993, 2020, 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/11/docs/api/java.desktop/java/awt/FileDialog.html

Spec-Zone .ru
спецификации, руководства, описания, API