Spec-Zone.ru › OpenJDK 17

Класс FileDialog

java.lang.Object
java.awt.Component
java.awt.Container
java.awt.Window
java.awt.Dialog
java.awt.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 final int LOAD
Это константа, указывающая, что целью диалогового окна для выбора файла является чтение из него.
static final 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()
Создаёт виджет (peer) диалогового окна для выбора файла.
String getDirectory()
Возвращает директорию текущего диалогового окна для выбора файла.
String getFile()
Возвращает выбранный файл в диалоговом окне для выбора файла.
FilenameFilter getFilenameFilter()
Определяет фильтр имён файлов для текущего диалогового окна для выбора файла.
File[] getFiles()
Возвращает файлы, которые пользователь выбрал.
int getMode()
Указывает, предназначено ли это диалоговое окно для загрузки файла или для сохранения файла.
boolean isMultipleMode()
Возвращает, разрешает ли диалоговое окно для выбора файла выбор нескольких файлов.
protected String paramString()
Возвращает строку, представляющую состояние текущего диалогового окна.
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's GraphicsConfiguration не с устройства экрана;
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's GraphicsConfiguration не с устройства экрана;
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's GraphicsConfiguration не с устройства экрана;
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 или недопустимый) этого диалогового окна
См. также:
  • setDirectory(java.lang.String)

setDirectory

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

Указание "" в качестве директории эквивалентно указанию null в качестве директории.

Parameters:
dir - указанная директория
See Also:
  • getDirectory()

getFile

public String getFile()
Получает выбранный файл в этом окне диалога выбора файла. Если пользователь выбрал CANCEL, возвращаемый файл null.
Returns:
текущий выбранный файл этого окна диалога выбора файла или null, если файл не выбран
See Also:
  • setFile(java.lang.String)

getFiles

public File[] getFiles()
Возвращает файлы, выбранные пользователем.

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

Returns:
выбранные пользователем файлы или пустой массив, если пользователь отменяет диалог выбора файла.
Since:
1.7
See Also:
  • setFile(String)
  • getFile()

setFile

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

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

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

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

Parameters:
file - устанавливаемый файл
See Also:
  • getFile()
  • getFiles()

setMultipleMode

public void setMultipleMode(boolean enable)
Включает или выключает возможность выбора нескольких файлов в диалоге выбора файла.
Parameters:
enable - если true, многократный выбор файлов включён; false - выключен.
Since:
1.7
See Also:
  • isMultipleMode()

isMultipleMode

public boolean isMultipleMode()
Возвращает, позволяет ли диалог выбора файла выбирать несколько файлов.
Returns:
true если диалог выбора файла позволяет выбрать несколько файлов; false в противном случае.
Since:
1.7
See Also:
  • setMultipleMode(boolean)

getFilenameFilter

public FilenameFilter getFilenameFilter()
Определяет фильтр имен файлов для этого диалога выбора файла. Фильтр имен файлов позволяет пользователю указать, какие файлы будут отображаться в окне диалога выбора файла. Фильтры имен файлов не работают в справочной реализации Sun для Microsoft Windows.
Returns:
Фильтр имен файлов этого диалога выбора файла
See Also:
  • FilenameFilter
  • setFilenameFilter(java.io.FilenameFilter)

setFilenameFilter

public void setFilenameFilter(FilenameFilter filter)
Устанавливает фильтр имен файлов для этого окна диалога выбора файла в указанный фильтр. Фильтры имен файлов не работают в справочной реализации Sun для Microsoft Windows.
Parameters:
filter - указанный фильтр
See Also:
  • FilenameFilter
  • getFilenameFilter()

paramString

protected String paramString()
Возвращает строку, представляющую состояние этого окна FileDialog. Этот метод предназначен только для отладки, и содержимое и формат возвращаемой строки могут варьироваться в разных реализациях. Возвращаемая строка может быть пустой, но не null.
Overrides:
paramString в классе Dialog
Returns:
строка параметров этого окна диалога выбора файла

© 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/java/awt/FileDialog.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API