    All Packages  Class Hierarchy  This Package  Previous  Next  Index

# Class java.awt.FileDialog

    java.lang.Object
       |
       +----java.awt.Component
               |
               +----java.awt.Container
                       |
                       +----java.awt.Window
                               |
                               +----java.awt.Dialog
                                       |
                                       +----java.awt.FileDialog

public class FileDialog
extends Dialog

The `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.

See Also:
  show

##

LOAD
  This constant value indicates that the purpose of the file dialog window is to locate a file from which to read.
SAVE
  This constant value indicates that the purpose of the file dialog window is to locate a file to which to write.

##

FileDialog(Frame)
  Creates a file dialog for loading a file.
FileDialog(Frame, String)
  Creates a file dialog window with the specified title for loading a file.
FileDialog(Frame, String, int)
  Creates a file dialog window with the specified title for loading or saving a file.

##

addNotify()
  Creates the file dialog's peer.
getDirectory()
  Gets the directory of this file dialog.
getFile()
  Gets the selected file of this file dialog.
getFilenameFilter()
  Determines this file dialog's filename filter.
getMode()
  Indicates whether this file dialog box is for loading from a file or for saving to a file.
paramString()
  Returns the parameter string representing the state of this file dialog window.
setDirectory(String)
  Sets the directory of this file dialog window to be the specified directory.
setFile(String)
  Sets the selected file for this file dialog window to be the specified file.
setFilenameFilter(FilenameFilter)
  Sets the filename filter for this file dialog window to the specified filter.
setMode(int)
  Sets the mode of the file dialog.

##

LOAD

     public 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.

SAVE

     public 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.

##

FileDialog

     public FileDialog(Frame parent)

  Creates a file dialog for loading a file. The title of the file dialog is initially empty.

  Parameters:
    parent - the owner of the dialog

FileDialog

     public FileDialog(Frame parent,
                       String title)

  Creates a file dialog window with the specified title for loading a file. The files shown are those in the current directory.

  Parameters:
    parent - the owner of the dialog.
    title - the title of the dialog.

FileDialog

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

  Creates a file dialog window with the specified title for loading or saving a file.

  If the value of `mode` is `LOAD`, then the file dialog is finding a file to read. If the value of `mode` is `SAVE`, the file dialog is finding a place to write a file.

  Parameters:
    parent - the owner of the dialog.
    title - the title of the dialog.
    mode - the mode of the dialog.
  See Also:
    LOAD, SAVE

##

addNotify

     public void addNotify()

  Creates the file dialog's peer. The peer allows us to change the look of the file dialog without changing its functionality.

  Overrides:
    addNotify in class Dialog

getMode

     public int getMode()

  Indicates whether this file dialog box is for loading from a file or for saving to a file.

  Returns:
    the mode of this file dialog window, either `FileDialog.LOAD` or `FileDialog.SAVE`.
  See Also:
    LOAD, SAVE, setMode

setMode

     public void setMode(int mode)

  Sets the mode of the file dialog.

  Parameters:
    mode - the mode for this file dialog, either `FileDialog.LOAD` or `FileDialog.SAVE`.
  Throws: IllegalArgumentException
    if an illegal file dialog mode is used.
  See Also:
    LOAD, SAVE, getMode

getDirectory

     public String getDirectory()

  Gets the directory of this file dialog.

  Returns:
    the directory of this file dialog.
  See Also:
    setDirectory

setDirectory

     public synchronized void setDirectory(String dir)

  Sets the directory of this file dialog window to be the specified directory.

  Parameters:
    dir - the specific directory.
  See Also:
    getDirectory

getFile

     public String getFile()

  Gets the selected file of this file dialog.

  Returns:
    the currently selected file of this file dialog window, or `null` if none is selected.
  See Also:
    setFile

setFile

     public synchronized void setFile(String file)

  Sets the selected file for this file dialog window to be the specified file. This file becomes the default file if it is set before the file dialog window is first shown.

  Parameters:
    file - the file being set.
  See Also:
    getFile

getFilenameFilter

     public FilenameFilter getFilenameFilter()

  Determines this file dialog's filename filter. A filename filter allows the user to specify which files appear in the file dialog window.

  Returns:
    this file dialog's filename filter.
  See Also:
    FilenameFilter, setFilenameFilter

setFilenameFilter

     public synchronized void setFilenameFilter(FilenameFilter filter)

  Sets the filename filter for this file dialog window to the specified filter.

  Parameters:
    filter - the specified filter.
  See Also:
    FilenameFilter, getFilenameFilter

paramString

     protected String paramString()

  Returns the parameter string representing the state of this file dialog window. This string is useful for debugging.

  Returns:
    the parameter string of this file dialog window.
  Overrides:
    paramString in class Dialog

    All Packages  Class Hierarchy  This Package  Previous  Next  Index