org.mdiutil.swing

Class JOptionalFileChooser

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JFileChooser

org.mdiutil.swing.JOptionalFileChooser

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

UnsortableFileChooser

public class JOptionalFileChooser
extends JFileChooser

A JFileChooser which is able to unselect files.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JFileChooser

JFileChooser.AccessibleJFileChooser

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.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 javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
JOptionalFileChooser() Constructor.
JOptionalFileChooser(File currentDirectory) Constructor.
JOptionalFileChooser(File currentDirectory, boolean isRestricted) Constructor.
JOptionalFileChooser(File currentDirectory, FileSystemView fsv) Constructor.
JOptionalFileChooser(FileSystemView fsv) Constructor.
JOptionalFileChooser(String currentDirectoryPath) Constructor.
JOptionalFileChooser(String currentDirectoryPath, boolean isRestricted) Constructor.
JOptionalFileChooser(String currentDirectoryPath, FileSystemView fsv) Constructor.

Method Summary

Modifier and Type	Method and Description
File	getSelectedFile() Returns the selected file.
File[]	getSelectedFiles() Returns a list of selected files if the file chooser is set to allow multiple selection.
String	getUnselectFileText() Return the text to show on the button for the "Unselect file" option.
boolean	hasOptionalFiles() Return true if the dialog support optional files.
boolean	isUnselected() Return true for a selection which unselected the file.
static void	main(String[] args)
void	setHasOptionalFiles(boolean hasOptionalFiles) Set if the dialog support optional files.
void	setUnselectFileText(String unselectFileText) Set the text to show on the button for the "Unselect file" option.
int	showDialog(Component parent, String approveButtonText) Pops a custom file chooser dialog with a custom approve button.
int	showOpenDialog(Component parent) Pops an Open file chooser dialog with a custom approve button.
int	showSaveDialog(Component parent) Pops a Save file chooser dialog with a custom approve button.

Methods inherited from class javax.swing.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, 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, updateUI

Methods inherited from class javax.swing.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 java.awt.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 java.awt.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, getPeer, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JOptionalFileChooser

public JOptionalFileChooser()

Constructor.

JOptionalFileChooser

public JOptionalFileChooser(FileSystemView fsv)

Constructor.

Parameters:

fsv - the file system view

JOptionalFileChooser

public JOptionalFileChooser(File currentDirectory)

Constructor.

Parameters:

currentDirectory - the current directory

JOptionalFileChooser

public JOptionalFileChooser(File currentDirectory,
                            FileSystemView fsv)

Constructor.

Parameters:

currentDirectory - the current directory

fsv - the file system view

JOptionalFileChooser

public JOptionalFileChooser(File currentDirectory,
                            boolean isRestricted)

Constructor.

Parameters:

currentDirectory - the current directory

isRestricted - true if the file chooser is restricted to the current directory

JOptionalFileChooser

public JOptionalFileChooser(String currentDirectoryPath)

Constructor.

Parameters:

currentDirectoryPath - the current directory path

JOptionalFileChooser

public JOptionalFileChooser(String currentDirectoryPath,
                            FileSystemView fsv)

Constructor.

Parameters:

currentDirectoryPath - the current directory path

fsv - the file system view

JOptionalFileChooser

public JOptionalFileChooser(String currentDirectoryPath,
                            boolean isRestricted)

Constructor.

Parameters:

currentDirectoryPath - the current directory path

isRestricted - true if the file chooser is restricted to the current directory

Method Detail

setHasOptionalFiles

public void setHasOptionalFiles(boolean hasOptionalFiles)

Set if the dialog support optional files. This option will allow to add a button in the UI which specifies the selection is empty.

Parameters:

hasOptionalFiles - true if the dialog support optional files

hasOptionalFiles

public boolean hasOptionalFiles()

Return true if the dialog support optional files. This option will allow to add a button in the UI which specifies the selection is empty.

Returns:

true if the dialog support optional files

setUnselectFileText

public void setUnselectFileText(String unselectFileText)

Set the text to show on the button for the "Unselect file" option.

Parameters:

unselectFileText - the text

showDialog

public int showDialog(Component parent,
                      String approveButtonText)
               throws HeadlessException

Pops a custom file chooser dialog with a custom approve button. Defer to the parent class to popup the file, and resets the "file unselected" file (useful if the hasOptionalFiles() is true.

Overrides:

showDialog in class JFileChooser

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.

showOpenDialog

public int showOpenDialog(Component parent)
                   throws HeadlessException

Pops an Open file chooser dialog with a custom approve button. Defer to the parent class to popup the file, and resets the "file unselected" file (useful if the hasOptionalFiles() is true.

Overrides:

showOpenDialog in class JFileChooser

Parameters:

parent - the parent component of the dialog; can be null

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.

showSaveDialog

public int showSaveDialog(Component parent)
                   throws HeadlessException

Pops a Save file chooser dialog with a custom approve button. Defer to the parent class to popup the file, and resets the "file unselected" file (useful if the hasOptionalFiles() is true.

Overrides:

showSaveDialog in class JFileChooser

Parameters:

parent - the parent component of the dialog; can be null

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.

getUnselectFileText

public String getUnselectFileText()

Return the text to show on the button for the "Unselect file" option.

Returns:

the text

getSelectedFile

public File getSelectedFile()

Returns the selected file. If the file has been unselected, it will return null.

Overrides:

getSelectedFile in class JFileChooser

Returns:

the selected file

isUnselected

public boolean isUnselected()

Return true for a selection which unselected the file.

Returns:

true for a selection which unselected the file

getSelectedFiles

public File[] getSelectedFiles()

Returns a list of selected files if the file chooser is set to allow multiple selection. If the file has been unselected, it will return null.

Overrides:

getSelectedFiles in class JFileChooser

Returns:

the list of selected file

main

public static void main(String[] args)