Class JFileDataStoreChooser

  • All Implemented Interfaces:
    ImageObserver, MenuContainer, Serializable, Accessible

    public class JFileDataStoreChooser
    extends JFileChooser
    A file chooser dialog to get user choices for data stores.

    Examples of use:

    
     // prompt the user for a shapefile
     File file = JFileDataStoreChooser.showOpenFile("shp", parentFrame);
     if (file != null) {
        ...
     }
    
     // prompt the user for a given data format
    
     
    Since:
    2.6
    Author:
    Jody Garnett
    See Also:
    Serialized Form
    • Nested Class Summary

      • Nested classes/interfaces inherited from class JFileChooser

        JFileChooser.AccessibleJFileChooser
      • Nested classes/interfaces inherited from class JComponent

        JComponent.AccessibleJComponent
      • Nested classes/interfaces inherited from class Container

        Container.AccessibleAWTContainer
      • Nested classes/interfaces inherited from class Component

        Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
    • Field Summary

      • Fields inherited from class JFileChooser

        ACCEPT_ALL_FILE_FILTER_USED_CHANGED_PROPERTY, accessibleContext, ACCESSORY_CHANGED_PROPERTY, APPROVE_BUTTON_MNEMONIC_CHANGED_PROPERTY, APPROVE_BUTTON_TEXT_CHANGED_PROPERTY, APPROVE_BUTTON_TOOL_TIP_TEXT_CHANGED_PROPERTY, APPROVE_OPTION, APPROVE_SELECTION, CANCEL_OPTION, CANCEL_SELECTION, CHOOSABLE_FILE_FILTER_CHANGED_PROPERTY, CONTROL_BUTTONS_ARE_SHOWN_CHANGED_PROPERTY, CUSTOM_DIALOG, DIALOG_TITLE_CHANGED_PROPERTY, DIALOG_TYPE_CHANGED_PROPERTY, DIRECTORIES_ONLY, DIRECTORY_CHANGED_PROPERTY, ERROR_OPTION, FILE_FILTER_CHANGED_PROPERTY, FILE_HIDING_CHANGED_PROPERTY, FILE_SELECTION_MODE_CHANGED_PROPERTY, FILE_SYSTEM_VIEW_CHANGED_PROPERTY, FILE_VIEW_CHANGED_PROPERTY, FILES_AND_DIRECTORIES, FILES_ONLY, MULTI_SELECTION_ENABLED_CHANGED_PROPERTY, OPEN_DIALOG, SAVE_DIALOG, SELECTED_FILE_CHANGED_PROPERTY, SELECTED_FILES_CHANGED_PROPERTY
      • Fields inherited from class JComponent

        listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
      • Fields inherited from class Component

        BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
      • Fields inherited from interface ImageObserver

        ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
    • Constructor Summary

      Constructors 
      Constructor Description
      JFileDataStoreChooser​(String extension)
      Create a dialog that filters for files with the specified extension.
      JFileDataStoreChooser​(String[] extensions)
      Create a dialog that filters for files with the specified extensions.
      JFileDataStoreChooser​(List<String> extensions)
      Create a dialog that filters for files with the specified extensions.
      JFileDataStoreChooser​(Map<String,​String> fileAssociations)
      Creates a dialog based on the given file associations.
      JFileDataStoreChooser​(FileDataStoreFactorySpi format)
      Creates a dialog that filters for files matching the specified data format.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static void main​(String[] arg)
      Demonstrates the file data store dialog by prompting for a shapefile
      void setSaveFile​(File file)
      Consider the provided file as a candidate for a new filename.
      static File showOpenFile​(String[] extensions, Component parent)
      Show a file open dialog that filters for files with the given extensions.
      static File showOpenFile​(String[] extensions, File initialDir, Component parent)
      Show a file open dialog that filters for files with the given extensions.
      static File showOpenFile​(String extension, Component parent)
      Show a file open dialog that filters for files with the given extension.
      static File showOpenFile​(String extension, File initialDir, Component parent)
      Show a file open dialog that filters for files with the given extension.
      static File showOpenFile​(FileDataStoreFactorySpi format, Component parent)
      Show a file open dialog that filters for files that match a given file data store format
      static File showOpenFile​(FileDataStoreFactorySpi format, File initialDir, Component parent)
      Show a file open dialog that filters for files that match a given file data store format
      • Methods inherited from class JFileChooser

        accept, addActionListener, addChoosableFileFilter, approveSelection, cancelSelection, changeToParentDirectory, createDialog, ensureFileIsVisible, fireActionPerformed, getAcceptAllFileFilter, getAccessibleContext, getAccessory, getActionListeners, getApproveButtonMnemonic, getApproveButtonText, getApproveButtonToolTipText, getChoosableFileFilters, getControlButtonsAreShown, getCurrentDirectory, getDescription, getDialogTitle, getDialogType, getDragEnabled, getFileFilter, getFileSelectionMode, getFileSystemView, getFileView, getIcon, getName, getSelectedFile, getSelectedFiles, getTypeDescription, getUI, getUIClassID, isAcceptAllFileFilterUsed, isDirectorySelectionEnabled, isFileHidingEnabled, isFileSelectionEnabled, isMultiSelectionEnabled, isTraversable, paramString, removeActionListener, removeChoosableFileFilter, rescanCurrentDirectory, resetChoosableFileFilters, setAcceptAllFileFilterUsed, setAccessory, setApproveButtonMnemonic, setApproveButtonMnemonic, setApproveButtonText, setApproveButtonToolTipText, setControlButtonsAreShown, setCurrentDirectory, setDialogTitle, setDialogType, setDragEnabled, setFileFilter, setFileHidingEnabled, setFileSelectionMode, setFileSystemView, setFileView, setMultiSelectionEnabled, setSelectedFile, setSelectedFiles, setup, showDialog, showOpenDialog, showSaveDialog, updateUI
      • Methods inherited from class JComponent

        addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
      • Methods inherited from class Container

        add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree
      • Methods inherited from class Component

        action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
      • Methods inherited from class Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • JFileDataStoreChooser

        public JFileDataStoreChooser​(String extension)
        Create a dialog that filters for files with the specified extension.
        Parameters:
        extension - the file extension, with or without the leading '.'
      • JFileDataStoreChooser

        public JFileDataStoreChooser​(List<String> extensions)
        Create a dialog that filters for files with the specified extensions.
        Parameters:
        extensions - the file extensions, with or without the leading '.'
      • JFileDataStoreChooser

        public JFileDataStoreChooser​(String[] extensions)
        Create a dialog that filters for files with the specified extensions.
        Parameters:
        extensions - the file extensions, with or without the leading '.'
      • JFileDataStoreChooser

        public JFileDataStoreChooser​(Map<String,​String> fileAssociations)
        Creates a dialog based on the given file associations.
        
         Map<String, String> assoc = new HashMap<>();
         assoc.put(".foo", "Foo data files (*.foo)");
         assoc.put(".bar", "Bar data files (*.bar)");
         JFileDataStoreChooser chooser = new JFileDataStoreChooser(assoc);
         
        Parameters:
        fileAssociations - a Map where keys are extensions (with or wirhout the leading dot) and values are descriptions.
      • JFileDataStoreChooser

        public JFileDataStoreChooser​(FileDataStoreFactorySpi format)
        Creates a dialog that filters for files matching the specified data format.
        Parameters:
        format - data file format
    • Method Detail

      • showOpenFile

        public static File showOpenFile​(String extension,
                                        Component parent)
                                 throws HeadlessException
        Show a file open dialog that filters for files with the given extension.
        Parameters:
        extension - file extension, with or without leading '.'
        parent - parent GUI component (may be null)
        Returns:
        the selected file or null if the user cancelled the selection
        Throws:
        HeadlessException - if run in an unsupported environment
      • showOpenFile

        public static File showOpenFile​(String extension,
                                        File initialDir,
                                        Component parent)
                                 throws HeadlessException
        Show a file open dialog that filters for files with the given extension.
        Parameters:
        extension - file extension, with or without leading '.'
        initialDir - initial directory to display; if null the initial directory will be the user's default directory
        parent - parent GUI component (may be null)
        Returns:
        the selected file or null if the user cancelled the selection
        Throws:
        HeadlessException - if run in an unsupported environment
      • showOpenFile

        public static File showOpenFile​(String[] extensions,
                                        Component parent)
                                 throws HeadlessException
        Show a file open dialog that filters for files with the given extensions.
        Parameters:
        extensions - array of file extension, with or without leading '.'
        parent - parent GUI component (may be null)
        Returns:
        the selected file or null if the user cancelled the selection
        Throws:
        HeadlessException - if run in an unsupported environment
      • showOpenFile

        public static File showOpenFile​(String[] extensions,
                                        File initialDir,
                                        Component parent)
                                 throws HeadlessException
        Show a file open dialog that filters for files with the given extensions.
        Parameters:
        extensions - array of file extension, with or without leading '.'
        initialDir - initial directory to display; if null the initial directory will be the user's default directory
        parent - parent GUI component (may be null)
        Returns:
        the selected file or null if the user cancelled the selection
        Throws:
        HeadlessException - if run in an unsupported environment
      • showOpenFile

        public static File showOpenFile​(FileDataStoreFactorySpi format,
                                        Component parent)
                                 throws HeadlessException
        Show a file open dialog that filters for files that match a given file data store format
        Parameters:
        format - the file data store format
        parent - parent GUI component (may be null)
        Returns:
        the selected file or null if the user cancelled the selection
        Throws:
        HeadlessException - if run in an unsupported environment
      • showOpenFile

        public static File showOpenFile​(FileDataStoreFactorySpi format,
                                        File initialDir,
                                        Component parent)
                                 throws HeadlessException
        Show a file open dialog that filters for files that match a given file data store format
        Parameters:
        format - the file data store format
        initialDir - initial directory to display; if null the initial directory will be the user's default directory
        parent - parent GUI component (may be null)
        Returns:
        the selected file or null if the user cancelled the selection
        Throws:
        HeadlessException - if run in an unsupported environment
      • main

        public static void main​(String[] arg)
        Demonstrates the file data store dialog by prompting for a shapefile
        Parameters:
        arg - ignored
      • setSaveFile

        public void setSaveFile​(File file)
        Consider the provided file as a candidate for a new filename. A number will be appended to the filename if there is a conflict.
        Parameters:
        file - the candidate file name