Package adams.gui.chooser

Interface FileChooser

    • Method Detail

      • setDragEnabled

        void setDragEnabled​(boolean b)
        Sets the dragEnabled property, which must be true to enable automatic drag handling (the first part of drag and drop) on this component. The transferHandler property needs to be set to a non-null value for the drag to do anything. The default value of the dragEnabled property is false.

        When automatic drag handling is enabled, most look and feels begin a drag-and-drop operation whenever the user presses the mouse button over an item and then moves the mouse a few pixels. Setting this property to true can therefore have a subtle effect on how selections behave.

        Some look and feels might not support automatic drag and drop; they will ignore this property. You can work around such look and feels by modifying the component to directly call the exportAsDrag method of a TransferHandler.

        Parameters:
        b - the value to set the dragEnabled property to
        Throws:
        HeadlessException - if b is true and GraphicsEnvironment.isHeadless() returns true
        Since:
        1.4
        See Also:
        GraphicsEnvironment.isHeadless(), getDragEnabled(), JComponent.setTransferHandler(javax.swing.TransferHandler), TransferHandler

      • getDragEnabled

        boolean getDragEnabled()
        Gets the value of the dragEnabled property.
        Returns:
        the value of the dragEnabled property
        Since:
        1.4
        See Also:
        setDragEnabled(boolean)

      • getSelectedFile

        File getSelectedFile()
        Returns the selected file. This can be set either by the programmer via setSelectedFile or by a user action, such as either typing the filename into the UI or selecting the file from a list in the UI.
        Returns:
        the selected file
        See Also:
        setSelectedFile(java.io.File)

      • setSelectedFile

        void setSelectedFile​(File file)
        Sets the selected file. If the file's parent directory is not the current directory, changes the current directory to be the file's parent directory.
        Parameters:
        file - the selected file
        See Also:
        getSelectedFile()

      • getSelectedFiles

        File[] getSelectedFiles()
        Returns a list of selected files if the file chooser is set to allow multiple selection.
        Returns:
        an array of selected Files

      • setSelectedFiles

        void setSelectedFiles​(File[] selectedFiles)
        Sets the list of selected files if the file chooser is set to allow multiple selection.
        Parameters:
        selectedFiles - an array Files to be selected

      • setCurrentDirectory

        void setCurrentDirectory​(File dir)
        Sets the current directory. Passing in null sets the file chooser to point to the user's default directory. This default depends on the operating system. It is typically the "My Documents" folder on Windows, and the user's home directory on Unix. If the file passed in as currentDirectory is not a directory, the parent of the file will be used as the currentDirectory. If the parent is not traversable, then it will walk up the parent tree until it finds a traversable directory, or hits the root of the file system.
        Parameters:
        dir - the current directory to point to
        See Also:
        getCurrentDirectory()

      • changeToParentDirectory

        void changeToParentDirectory()
        Changes the directory to be set to the parent of the current directory.
        See Also:
        getCurrentDirectory()

      • rescanCurrentDirectory

        void rescanCurrentDirectory()
        Tells the UI to rescan its files list from the current directory.

      • ensureFileIsVisible

        void ensureFileIsVisible​(File f)
        Makes sure that the specified file is viewable, and not hidden.
        Parameters:
        f - a File object

      • showOpenDialog

        int showOpenDialog​(Component parent)
            throws HeadlessException
        Pops up an "Open File" file chooser dialog. Note that the text that appears in the approve button is determined by the L&F.
        Parameters:
        parent - the parent component of the dialog, can be null; see showDialog for details
        Returns:
        the return state of the file chooser on popdown:
        • JFileChooser.CANCEL_OPTION
        • JFileChooser.APPROVE_OPTION
        • JFileChooser.ERROR_OPTION if an error occurs or the dialog is dismissed
        Throws:
        HeadlessException - if GraphicsEnvironment.isHeadless() returns true.
        See Also:
        GraphicsEnvironment.isHeadless(), showDialog(java.awt.Component, java.lang.String)

      • showSaveDialog

        int showSaveDialog​(Component parent)
            throws HeadlessException
        Pops up a "Save File" file chooser dialog. Note that the text that appears in the approve button is determined by the L&F.
        Parameters:
        parent - the parent component of the dialog, can be null; see showDialog for details
        Returns:
        the return state of the file chooser on popdown:
        • JFileChooser.CANCEL_OPTION
        • JFileChooser.APPROVE_OPTION
        • JFileChooser.ERROR_OPTION if an error occurs or the dialog is dismissed
        Throws:
        HeadlessException - if GraphicsEnvironment.isHeadless() returns true.
        See Also:
        GraphicsEnvironment.isHeadless(), showDialog(java.awt.Component, java.lang.String)

      • showDialog

        int showDialog​(Component parent,
               String approveButtonText)
        throws HeadlessException
        Pops a custom file chooser dialog with a custom approve button. For example, the following code pops up a file chooser with a "Run Application" button (instead of the normal "Save" or "Open" button): 
         filechooser.showDialog(parentFrame, "Run Application");
        Alternatively, the following code does the same thing: 
            JFileChooser chooser = new JFileChooser(null);
    chooser.setApproveButtonText("Run Application");
    chooser.showDialog(parentFrame, null);

        The parent argument determines two things: the frame on which the open dialog depends and the component whose position the look and feel should consider when placing the dialog. If the parent is a Frame object (such as a JFrame) then the dialog depends on the frame and the look and feel positions the dialog relative to the frame (for example, centered over the frame). If the parent is a component, then the dialog depends on the frame containing the component, and is positioned relative to the component (for example, centered over the component). If the parent is null, then the dialog depends on no visible window, and it's placed in a look-and-feel-dependent position such as the center of the screen.

        Parameters:
        parent - the parent component of the dialog; can be null
        approveButtonText - the text of the ApproveButton
        Returns:
        the return state of the file chooser on popdown:
        • JFileChooser.CANCEL_OPTION
        • JFileChooser.APPROVE_OPTION
        • JFileChooser.ERROR_OPTION if an error occurs or the dialog is dismissed
        Throws:
        HeadlessException - if GraphicsEnvironment.isHeadless() returns true.
        See Also:
        GraphicsEnvironment.isHeadless()

      • getControlButtonsAreShown

        boolean getControlButtonsAreShown()
        Returns the value of the controlButtonsAreShown property.
        Returns:
        the value of the controlButtonsAreShown property
        Since:
        1.3
        See Also:
        setControlButtonsAreShown(boolean)

      • setControlButtonsAreShown

        void setControlButtonsAreShown​(boolean b)
        Sets the property that indicates whether the approve and cancel buttons are shown in the file chooser. This property is true by default. Look and feels that always show these buttons will ignore the value of this property. This method fires a property-changed event, using the string value of CONTROL_BUTTONS_ARE_SHOWN_CHANGED_PROPERTY as the name of the property.
        Parameters:
        b - false if control buttons should not be shown; otherwise, true
        Since:
        1.3
        See Also:
        getControlButtonsAreShown(), JFileChooser.CONTROL_BUTTONS_ARE_SHOWN_CHANGED_PROPERTY

      • getDialogType

        int getDialogType()
        Returns the type of this dialog. The default is JFileChooser.OPEN_DIALOG.
        Returns:
        the type of dialog to be displayed:
        • JFileChooser.OPEN_DIALOG
        • JFileChooser.SAVE_DIALOG
        • JFileChooser.CUSTOM_DIALOG
        See Also:
        setDialogType(int)

      • setDialogType

        void setDialogType​(int dialogType)
        Sets the type of this dialog. Use OPEN_DIALOG when you want to bring up a file chooser that the user can use to open a file. Likewise, use SAVE_DIALOG for letting the user choose a file for saving. Use CUSTOM_DIALOG when you want to use the file chooser in a context other than "Open" or "Save". For instance, you might want to bring up a file chooser that allows the user to choose a file to execute. Note that you normally would not need to set the JFileChooser to use CUSTOM_DIALOG since a call to setApproveButtonText does this for you. The default dialog type is JFileChooser.OPEN_DIALOG.
        Parameters:
        dialogType - the type of dialog to be displayed:
        • JFileChooser.OPEN_DIALOG
        • JFileChooser.SAVE_DIALOG
        • JFileChooser.CUSTOM_DIALOG
        Throws:
        IllegalArgumentException - if dialogType is not legal
        See Also:
        getDialogType(), setApproveButtonText(java.lang.String)

      • setDialogTitle

        void setDialogTitle​(String dialogTitle)
        Sets the string that goes in the JFileChooser window's title bar.
        Parameters:
        dialogTitle - the new String for the title bar
        See Also:
        getDialogTitle()

      • getDialogTitle

        String getDialogTitle()
        Gets the string that goes in the JFileChooser's titlebar.
        Returns:
        the string from the JFileChooser window's title bar
        See Also:
        setDialogTitle(java.lang.String)

      • getApproveButtonMnemonic

        int getApproveButtonMnemonic()
        Returns the approve button's mnemonic.
        Returns:
        an integer value for the mnemonic key
        See Also:
        setApproveButtonMnemonic(int)

      • setApproveButtonMnemonic

        void setApproveButtonMnemonic​(int mnemonic)
        Sets the approve button's mnemonic using a numeric keycode.
        Parameters:
        mnemonic - an integer value for the mnemonic key
        See Also:
        getApproveButtonMnemonic()

      • setApproveButtonMnemonic

        void setApproveButtonMnemonic​(char mnemonic)
        Sets the approve button's mnemonic using a character.
        Parameters:
        mnemonic - a character value for the mnemonic key
        See Also:
        getApproveButtonMnemonic()

      • getAcceptAllFileFilter

        FileFilter getAcceptAllFileFilter()
        Returns the AcceptAll file filter. For example, on Microsoft Windows this would be All Files (*.*).
        Returns:
        the AcceptAll file filter

      • isAcceptAllFileFilterUsed

        boolean isAcceptAllFileFilterUsed()
        Returns whether the AcceptAll FileFilter is used.
        Returns:
        true if the AcceptAll FileFilter is used
        Since:
        1.3
        See Also:
        setAcceptAllFileFilterUsed(boolean)

      • setAcceptAllFileFilterUsed

        void setAcceptAllFileFilterUsed​(boolean b)
        Determines whether the AcceptAll FileFilter is used as an available choice in the choosable filter list. If false, the AcceptAll file filter is removed from the list of available file filters. If true, the AcceptAll file filter will become the actively used file filter.
        Parameters:
        b - a boolean which determines whether the AcceptAll file filter is an available choice in the choosable filter list
        Since:
        1.3
        See Also:
        isAcceptAllFileFilterUsed(), getAcceptAllFileFilter(), setFileFilter(javax.swing.filechooser.FileFilter)

      • setAccessory

        void setAccessory​(JComponent newAccessory)
        Sets the accessory component. An accessory is often used to show a preview image of the selected file; however, it can be used for anything that the programmer wishes, such as extra custom file chooser controls.

        Note: if there was a previous accessory, you should unregister any listeners that the accessory might have registered with the file chooser.

        Parameters:
        newAccessory - the accessory component to be set

      • setFileSelectionMode

        void setFileSelectionMode​(int mode)
        Sets the JFileChooser to allow the user to just select files, just select directories, or select both files and directories. The default is JFilesChooser.FILES_ONLY.
        Parameters:
        mode - the type of files to be displayed:
        • JFileChooser.FILES_ONLY
        • JFileChooser.DIRECTORIES_ONLY
        • JFileChooser.FILES_AND_DIRECTORIES
        Throws:
        IllegalArgumentException - if mode is an illegal file selection mode
        See Also:
        getFileSelectionMode()

      • getFileSelectionMode

        int getFileSelectionMode()
        Returns the current file-selection mode. The default is JFilesChooser.FILES_ONLY.
        Returns:
        the type of files to be displayed, one of the following:
        • JFileChooser.FILES_ONLY
        • JFileChooser.DIRECTORIES_ONLY
        • JFileChooser.FILES_AND_DIRECTORIES
        See Also:
        setFileSelectionMode(int)

      • isFileSelectionEnabled

        boolean isFileSelectionEnabled()
        Convenience call that determines if files are selectable based on the current file selection mode.
        Returns:
        true if files are selectable, false otherwise
        See Also:
        setFileSelectionMode(int), getFileSelectionMode()

      • isDirectorySelectionEnabled

        boolean isDirectorySelectionEnabled()
        Convenience call that determines if directories are selectable based on the current file selection mode.
        Returns:
        true if directories are selectable, false otherwise
        See Also:
        setFileSelectionMode(int), getFileSelectionMode()

      • setMultiSelectionEnabled

        void setMultiSelectionEnabled​(boolean b)
        Sets the file chooser to allow multiple file selections.
        Parameters:
        b - true if multiple files may be selected
        See Also:
        isMultiSelectionEnabled()

      • isMultiSelectionEnabled

        boolean isMultiSelectionEnabled()
        Returns true if multiple files can be selected.
        Returns:
        true if multiple files can be selected
        See Also:
        setMultiSelectionEnabled(boolean)

      • isFileHidingEnabled

        boolean isFileHidingEnabled()
        Returns true if hidden files are not shown in the file chooser; otherwise, returns false.
        Returns:
        the status of the file hiding property
        See Also:
        setFileHidingEnabled(boolean)

      • setFileHidingEnabled

        void setFileHidingEnabled​(boolean b)
        Sets file hiding on or off. If true, hidden files are not shown in the file chooser. The job of determining which files are shown is done by the FileView.
        Parameters:
        b - the boolean value that determines whether file hiding is turned on
        See Also:
        isFileHidingEnabled()

      • setFileFilter

        void setFileFilter​(FileFilter filter)
        Sets the current file filter. The file filter is used by the file chooser to filter out files from the user's view.
        Parameters:
        filter - the new current file filter to use
        See Also:
        getFileFilter()

      • setFileView

        void setFileView​(FileView fileView)
        Sets the file view to be used to retrieve UI information, such as the icon that represents a file or the type description of a file.
        Parameters:
        fileView - a FileView to be used to retrieve UI information
        See Also:
        getFileView()

      • getIcon

        Icon getIcon​(File f)
        Returns the icon for this file or type of file, depending on the system.
        Parameters:
        f - the File
        Returns:
        the Icon for this file, or type of file
        See Also:
        FileView.getIcon(java.io.File)

      • isTraversable

        boolean isTraversable​(File f)
        Returns true if the file (directory) can be visited. Returns false if the directory cannot be traversed.
        Parameters:
        f - the File
        Returns:
        true if the file/directory can be traversed, otherwise false
        See Also:
        FileView.isTraversable(java.io.File)

      • accept

        boolean accept​(File f)
        Returns true if the file should be displayed.
        Parameters:
        f - the File
        Returns:
        true if the file should be displayed, otherwise false
        See Also:
        FileFilter.accept(java.io.File)

      • setFileSystemView

        void setFileSystemView​(FileSystemView fsv)
        Sets the file system view that the JFileChooser uses for accessing and creating file system resources, such as finding the floppy drive and getting a list of root drives.
        Parameters:
        fsv - the new FileSystemView
        See Also:
        FileSystemView

      • approveSelection

        void approveSelection()
        Called by the UI when the user hits the Approve button (labeled "Open" or "Save", by default). This can also be called by the programmer. This method causes an action event to fire with the command string equal to APPROVE_SELECTION.
        See Also:
        JFileChooser.APPROVE_SELECTION

      • cancelSelection

        void cancelSelection()
        Called by the UI when the user chooses the Cancel button. This can also be called by the programmer. This method causes an action event to fire with the command string equal to CANCEL_SELECTION.
        See Also:
        JFileChooser.CANCEL_SELECTION

      • isJComponent

        boolean isJComponent()
        Returns whether the file chooser is a JComponent and can be embedded in other components.
        Returns:
        true if JComponent-derived