ImageObserver, MenuContainer, Serializable, Accessible
public class FileDialog extends Dialog
FileDialog class displays a dialog window from which the user can select a file. Since it is a modal dialog, when the application calls its show method to display the dialog, it blocks the rest of the application until the user has chosen a file.
Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType
Window.AccessibleAWTWindow, Window.Type
Container.AccessibleAWTContainer
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
| Modifier and Type | Field | Description |
|---|---|---|
static final int |
LOAD |
This constant value indicates that the purpose of the file dialog window is to locate a file from which to read. |
static final int |
SAVE |
This constant value indicates that the purpose of the file dialog window is to locate a file to which to write. |
DEFAULT_MODALITY_TYPE
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
| Constructor | Description |
|---|---|
FileDialog |
Creates a file dialog for loading a file. |
FileDialog |
Creates a file dialog window with the specified title for loading a file. |
FileDialog |
Creates a file dialog window with the specified title for loading or saving a file. |
FileDialog |
Creates a file dialog for loading a file. |
FileDialog |
Creates a file dialog window with the specified title for loading a file. |
FileDialog |
Creates a file dialog window with the specified title for loading or saving a file. |
| Modifier and Type | Method | Description |
|---|---|---|
void |
addNotify() |
Creates the file dialog's peer. |
String |
getDirectory() |
Gets the directory of this file dialog. |
String |
getFile() |
Gets the selected file of this file dialog. |
FilenameFilter |
getFilenameFilter() |
Determines this file dialog's filename filter. |
File[] |
getFiles() |
Returns files that the user selects. |
int |
getMode() |
Indicates whether this file dialog box is for loading from a file or for saving to a file. |
boolean |
isMultipleMode() |
Returns whether the file dialog allows the multiple file selection. |
protected String |
paramString() |
Returns a string representing the state of this FileDialog window. |
void |
setDirectory |
Sets the directory of this file dialog window to be the specified directory. |
void |
setFile |
Sets the selected file for this file dialog window to be the specified file. |
void |
setFilenameFilter |
Sets the filename filter for this file dialog window to the specified filter. |
void |
setMode |
Sets the mode of the file dialog. |
void |
setMultipleMode |
Enables or disables multiple file selection for the file dialog. |
void |
setTitle |
Sets the title of the Dialog. |
getAccessibleContext, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setModalityType, setResizable, setUndecorated, setVisible, show, toBack
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
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
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
public static final int LOAD
public static final int SAVE
public FileDialog(Frame parent)
FileDialog(parent, "", LOAD). Note: Some platforms may not support showing the user-specified title in a file dialog. In this situation, either no title will be displayed in the file dialog's title bar or, on some systems, the file dialog's title bar will not be displayed.
parent - the owner of the dialogpublic FileDialog(Frame parent, String title)
FileDialog(parent, title, LOAD). Note: Some platforms may not support showing the user-specified title in a file dialog. In this situation, either no title will be displayed in the file dialog's title bar or, on some systems, the file dialog's title bar will not be displayed.
parent - the owner of the dialogtitle - the title of the dialogpublic FileDialog(Frame parent, String title, int mode)
If the value of mode is LOAD, then the file dialog is finding a file to read, and the files shown are those in the current directory. If the value of mode is SAVE, the file dialog is finding a place to write a file.
Note: Some platforms may not support showing the user-specified title in a file dialog. In this situation, either no title will be displayed in the file dialog's title bar or, on some systems, the file dialog's title bar will not be displayed.
parent - the owner of the dialogtitle - the title of the dialogmode - the mode of the dialog; either FileDialog.LOAD or FileDialog.SAVE
IllegalArgumentException - if an illegal file dialog mode is suppliedpublic FileDialog(Dialog parent)
FileDialog(parent, "", LOAD). Note: Some platforms may not support showing the user-specified title in a file dialog. In this situation, either no title will be displayed in the file dialog's title bar or, on some systems, the file dialog's title bar will not be displayed.
parent - the owner of the dialogIllegalArgumentException - if the parent's GraphicsConfiguration is not from a screen device;IllegalArgumentException - if parent is null; this exception is always thrown when GraphicsEnvironment.isHeadless returns true
public FileDialog(Dialog parent, String title)
FileDialog(parent, title, LOAD). Note: Some platforms may not support showing the user-specified title in a file dialog. In this situation, either no title will be displayed in the file dialog's title bar or, on some systems, the file dialog's title bar will not be displayed.
parent - the owner of the dialogtitle - the title of the dialog; a null value will be accepted without causing a NullPointerException to be thrownIllegalArgumentException - if the parent's GraphicsConfiguration is not from a screen device;IllegalArgumentException - if parent is null; this exception is always thrown when GraphicsEnvironment.isHeadless returns true
public FileDialog(Dialog parent, String title, int mode)
If the value of mode is LOAD, then the file dialog is finding a file to read, and the files shown are those in the current directory. If the value of mode is SAVE, the file dialog is finding a place to write a file.
Note: Some platforms may not support showing the user-specified title in a file dialog. In this situation, either no title will be displayed in the file dialog's title bar or, on some systems, the file dialog's title bar will not be displayed.
parent - the owner of the dialogtitle - the title of the dialog; a null value will be accepted without causing a NullPointerException to be thrownmode - the mode of the dialog; either FileDialog.LOAD or FileDialog.SAVE
IllegalArgumentException - if an illegal file dialog mode is supplied;IllegalArgumentException - if the parent's GraphicsConfiguration is not from a screen device;IllegalArgumentException - if parent is null; this exception is always thrown when GraphicsEnvironment.isHeadless returns true
public void setTitle(String title)
Note: Some platforms may not support showing the user-specified title in a file dialog. In this situation, either no title will be displayed in the file dialog's title bar or, on some systems, the file dialog's title bar will not be displayed.
public void addNotify()
public int getMode()
FileDialog.LOAD or FileDialog.SAVE
public void setMode(int mode)
mode is not a legal value, an exception will be thrown and mode will not be set.mode - the mode for this file dialog, either FileDialog.LOAD or FileDialog.SAVE
IllegalArgumentException - if an illegal file dialog mode is suppliedpublic String getDirectory()
null or invalid) directory of this FileDialog
public void setDirectory(String dir)
null or an invalid directory implies an implementation-defined default. This default will not be realized, however, until the user has selected a file. Until this point, getDirectory() will return the value passed into this method. Specifying "" as the directory is exactly equivalent to specifying null as the directory.
dir - the specified directorypublic String getFile()
CANCEL, the returned file is null.null if none is selectedpublic File[] getFiles()
If the user cancels the file dialog, then the method returns an empty array.
public void setFile(String file)
When the dialog is shown, the specified file is selected. The kind of selection depends on the file existence, the dialog type, and the native platform. E.g., the file could be highlighted in the file list, or a file name editbox could be populated with the file name.
This method accepts either a full file path, or a file name with an extension if used together with the setDirectory method.
Specifying "" as the file is exactly equivalent to specifying null as the file.
file - the file being setpublic void setMultipleMode(boolean enable)
enable - if true, multiple file selection is enabled; false - disabled.public boolean isMultipleMode()
true if the file dialog allows the multiple file selection; false otherwise.public FilenameFilter getFilenameFilter()
public void setFilenameFilter(FilenameFilter filter)
filter - the specified filterprotected String paramString()
FileDialog window. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.paramString in class Dialog
© 1993, 2023, 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/21/docs/api/java.desktop/java/awt/FileDialog.html