|
JavaTM 2 Platform Standard Edition |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.awt.Component | +--java.awt.Container | +--javax.swing.JComponent | +--javax.swing.JFileChooser
JFileChooser provides a simple mechanism for the user to chooser a file. The following pops up a file chooser in the users home directory that only sees .jpg and .gif images: JFileChooser chooser = new JFileChooser(); // Note: source for ExtensionFileFilter can be found in the SwingSet demo ExtensionFileFilter filter = new ExtensionFileFilter(); filter.addExtension("jpg"); filter.addExtension("gif"); filter.setDescription("JPG & GIF Images"); chooser.setFileFilter(filter); int returnVal = chooser.showOpenDialog(parent); if(returnVal == JFileChooser.APPROVE_OPTION) { System.out.println("You chose to open this file: " + chooser.getSelectedFile().getName()); }
Inner Class Summary | |
protected class |
JFileChooser.AccessibleJFileChooser
The class used to obtain the accessible context for this object. |
Inner classes inherited from class javax.swing.JComponent |
JComponent.AccessibleJComponent |
Field Summary | |
protected AccessibleContext |
accessibleContext
|
static String |
ACCESSORY_CHANGED_PROPERTY
Says that a different accessory component is in use. |
static String |
APPROVE_BUTTON_MNEMONIC_CHANGED_PROPERTY
Identifies change in the mnemonic for the approve (yes, ok) button . |
static String |
APPROVE_BUTTON_TEXT_CHANGED_PROPERTY
Identifies change in the text on the approve (yes, ok) button. |
static String |
APPROVE_BUTTON_TOOL_TIP_TEXT_CHANGED_PROPERTY
Identifies change in the tooltip text for the approve (yes, ok) button . |
static int |
APPROVE_OPTION
Return value if approve (yes, ok) is chosen. |
static String |
APPROVE_SELECTION
Instruction to approve the current selection (Same as pressing yes or ok.) |
static int |
CANCEL_OPTION
Return value if cancel is chosen. |
static String |
CANCEL_SELECTION
Instruction to cancel the current selection. |
static String |
CHOOSABLE_FILE_FILTER_CHANGED_PROPERTY
Identifies a change in the list of predefined file filters the user can choose from |
static int |
CUSTOM_DIALOG
Type value indicating that the FileChooser supports a developer sepcified file operation. |
static String |
DIALOG_TITLE_CHANGED_PROPERTY
Identifies a change in the dialog title. |
static String |
DIALOG_TYPE_CHANGED_PROPERTY
Identifies a change in the type of files displayed (files only, directories only, or both files and directories. |
static int |
DIRECTORIES_ONLY
Instruction to display only directories. |
static String |
DIRECTORY_CHANGED_PROPERTY
Identifies user's directory change. |
static int |
ERROR_OPTION
Return value if an error occured. |
static String |
FILE_FILTER_CHANGED_PROPERTY
User changed the kind of files to display. |
static String |
FILE_HIDING_CHANGED_PROPERTY
Identifies a change in the display-hidden-files property. |
static String |
FILE_SELECTION_MODE_CHANGED_PROPERTY
Identifies a change in the kind of selection (single, multiple, etc.). |
static String |
FILE_SYSTEM_VIEW_CHANGED_PROPERTY
Says that a different object is being used to find available drives on the system. |
static String |
FILE_VIEW_CHANGED_PROPERTY
Says that a different object is being used to retrieve file information. |
static int |
FILES_AND_DIRECTORIES
Instruction to display both files and directories. |
static int |
FILES_ONLY
Instruction to display only files. |
static String |
MULTI_SELECTION_ENABLED_CHANGED_PROPERTY
Enables multiple-file selections. |
static int |
OPEN_DIALOG
Type value indicating that the FileChooser supports an "Open" file operation. |
static int |
SAVE_DIALOG
Type value indicating that the FileChooser supports a "Save" file operation. |
static String |
SELECTED_FILE_CHANGED_PROPERTY
Identifes change in user's single-file selection. |
static String |
SELECTED_FILES_CHANGED_PROPERTY
Identifes change in user's multiple-file selection. |
Fields inherited from class javax.swing.JComponent |
accessibleContext,
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 |
Constructor Summary | |
JFileChooser()
Creates a JFileChooser pointing to the user's home directory. |
|
JFileChooser(File currentDirectory)
Creates a JFileChooser using the given File as the path. |
|
JFileChooser(File currentDirectory,
FileSystemView fsv)
Creates a JFileChooser using the given current directory and FileSystemView |
|
JFileChooser(FileSystemView fsv)
Creates a JFileChooser using the given FileSystemView |
|
JFileChooser(String currentDirectoryPath)
Creates a JFileChooser using the given path. |
|
JFileChooser(String currentDirectoryPath,
FileSystemView fsv)
Creates a JFileChooser using the given current directory path and FileSystemView |
Method Summary | |
boolean |
accept(File f)
Returns true if the file should be displayed. |
void |
addActionListener(ActionListener l)
adds an ActionListener to the button |
void |
addChoosableFileFilter(FileFilter filter)
Adds a filter to the list of user choosable file filters. |
void |
approveSelection()
Called by the UI when the user hits the approve (AKA "Open" or "Save") button. |
void |
cancelSelection()
Called by the UI when the user hits the cancel button. |
void |
changeToParentDirectory()
Changes the directory to be set to the parent of the current directory. |
void |
ensureFileIsVisible(File f)
Make sure that the specified file is viewable, and not hidden. |
protected void |
fireActionPerformed(String command)
Notify all listeners that have registered interest for notification on this event type. |
FileFilter |
getAcceptAllFileFilter()
Returns the AcceptAll file filter (e.g. |
AccessibleContext |
getAccessibleContext()
Get the AccessibleContext associated with this JFileChooser |
JComponent |
getAccessory()
Return the accessory component. |
int |
getApproveButtonMnemonic()
Returns the approve button's mnemonic. |
String |
getApproveButtonText()
Returns the text used in the ApproveButton in the FileChooserUI. |
String |
getApproveButtonToolTipText()
Returns the tooltip text used in the ApproveButton. |
FileFilter[] |
getChoosableFileFilters()
Gets the list of user choosable file filters |
File |
getCurrentDirectory()
Returns the current directory. |
String |
getDescription(File f)
Returns the file description. |
String |
getDialogTitle()
Gets the string that goes in the FileChooser's titlebar. |
int |
getDialogType()
Returns the type of this dialog. |
FileFilter |
getFileFilter()
Returns the currently selected file filter. |
int |
getFileSelectionMode()
Returns the current file-selection mode. |
FileSystemView |
getFileSystemView()
Returns the file system view. |
FileView |
getFileView()
Returns the current file view. |
Icon |
getIcon(File f)
Returns the icon for this file or type of file, depending on the system. |
String |
getName(File f)
Returns the file name. |
File |
getSelectedFile()
Returns the selected file. |
File[] |
getSelectedFiles()
Returns a list of selected files if the filechooser is set to allow multi-selection. |
String |
getTypeDescription(File f)
Returns the file type. |
FileChooserUI |
getUI()
Gets the UI object which implements the L&F for this component. |
String |
getUIClassID()
Returns a string that specifies the name of the L&F class that renders this component. |
boolean |
isDirectorySelectionEnabled()
Convenience call that determines if directories are selectable based on the current file selection mode |
boolean |
isFileHidingEnabled()
If true, hidden files are not shown in the filechooser |
boolean |
isFileSelectionEnabled()
Convenience call that determines if files are selectable based on the current file selection mode |
boolean |
isMultiSelectionEnabled()
Returns true if multiple files can be selected. |
boolean |
isTraversable(File f)
Returns true if the file (directory) can be visited. |
protected String |
paramString()
Returns a string representation of this JFileChooser. |
void |
removeActionListener(ActionListener l)
removes an ActionListener from the button |
boolean |
removeChoosableFileFilter(FileFilter f)
Removes a filter from the list of user choosable file filters. |
void |
rescanCurrentDirectory()
Tells the UI to rescan it's files list from the current directory. |
void |
resetChoosableFileFilters()
Resets the choosable file filter list to its starting state. |
void |
setAccessory(JComponent newAccessory)
Sets the accessory component. |
void |
setApproveButtonMnemonic(char mnemonic)
Sets the approve button's mnemonic using a character. |
void |
setApproveButtonMnemonic(int mnemonic)
Sets the approve button's mnemonic using a numeric keycode. |
void |
setApproveButtonText(String approveButtonText)
Sets the text used in the ApproveButton in the FileChooserUI. |
void |
setApproveButtonToolTipText(String toolTipText)
Sets the tooltip text used in the ApproveButton. |
void |
setCurrentDirectory(File dir)
Sets the current directory. |
void |
setDialogTitle(String dialogTitle)
Sets the string that goes in the FileChooser window's title bar. |
void |
setDialogType(int dialogType)
Sets the type of this dialog. |
void |
setFileFilter(FileFilter filter)
Sets the current File Filter. |
void |
setFileHidingEnabled(boolean b)
Sets file hiding on or off. |
void |
setFileSelectionMode(int mode)
Sets the FileChooser to allow the user to just select files, just select directories, or select both files and directories. |
void |
setFileSystemView(FileSystemView fsv)
Sets the file system view which the JFileChooser uses to access and create file system resouces, such as finding the floppy drive and getting a list of root drives. |
void |
setFileView(FileView fileView)
Sets the file view to used to retrieve UI information, such as the icon that represents a file or the type description of a file. |
void |
setMultiSelectionEnabled(boolean b)
Sets the filechooser to allow multiple file selections. |
void |
setSelectedFile(File file)
Sets the selected file. |
void |
setSelectedFiles(File[] selectedFiles)
Sets the list of selected files if the filechooser is set to allow multi-selection. |
protected void |
setup(FileSystemView view)
Perform common constructor initialization and setup |
int |
showDialog(Component parent,
String approveButtonText)
Pops a custom file chooser dialog with a custom ApproveButton. |
int |
showOpenDialog(Component parent)
Pops up an "Open File" file chooser dialog. |
int |
showSaveDialog(Component parent)
Pops up a "Save File" file chooser dialog. |
void |
updateUI()
Notification from the UIFactory that the L&F has changed. |
Methods inherited from class java.awt.Container |
add,
add,
add,
add,
add,
addContainerListener,
addImpl,
countComponents,
deliverEvent,
doLayout,
findComponentAt,
findComponentAt,
getComponent,
getComponentAt,
getComponentAt,
getComponentCount,
getComponents,
getLayout,
insets,
invalidate,
isAncestorOf,
layout,
list,
list,
locate,
minimumSize,
paintComponents,
preferredSize,
print,
printComponents,
processContainerEvent,
processEvent,
remove,
remove,
removeAll,
removeContainerListener,
setCursor,
setLayout,
validate,
validateTree |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Field Detail |
public static final int OPEN_DIALOG
public static final int SAVE_DIALOG
public static final int CUSTOM_DIALOG
public static final int CANCEL_OPTION
public static final int APPROVE_OPTION
public static final int ERROR_OPTION
public static final int FILES_ONLY
public static final int DIRECTORIES_ONLY
public static final int FILES_AND_DIRECTORIES
public static final String CANCEL_SELECTION
public static final String APPROVE_SELECTION
public static final String APPROVE_BUTTON_TEXT_CHANGED_PROPERTY
public static final String APPROVE_BUTTON_TOOL_TIP_TEXT_CHANGED_PROPERTY
public static final String APPROVE_BUTTON_MNEMONIC_CHANGED_PROPERTY
public static final String DIRECTORY_CHANGED_PROPERTY
public static final String SELECTED_FILE_CHANGED_PROPERTY
public static final String SELECTED_FILES_CHANGED_PROPERTY
public static final String MULTI_SELECTION_ENABLED_CHANGED_PROPERTY
public static final String FILE_SYSTEM_VIEW_CHANGED_PROPERTY
public static final String FILE_VIEW_CHANGED_PROPERTY
public static final String FILE_HIDING_CHANGED_PROPERTY
public static final String FILE_FILTER_CHANGED_PROPERTY
public static final String FILE_SELECTION_MODE_CHANGED_PROPERTY
public static final String ACCESSORY_CHANGED_PROPERTY
public static final String DIALOG_TITLE_CHANGED_PROPERTY
public static final String DIALOG_TYPE_CHANGED_PROPERTY
public static final String CHOOSABLE_FILE_FILTER_CHANGED_PROPERTY
protected AccessibleContext accessibleContext
Constructor Detail |
public JFileChooser()
public JFileChooser(String currentDirectoryPath)
path
- a String giving the path to a file or directorypublic JFileChooser(File currentDirectory)
directory
- a File object specifying the path to a file
or directorypublic JFileChooser(FileSystemView fsv)
public JFileChooser(File currentDirectory, FileSystemView fsv)
public JFileChooser(String currentDirectoryPath, FileSystemView fsv)
Method Detail |
protected void setup(FileSystemView view)
public File getSelectedFile()
setSelectedFile(java.io.File)
public void setSelectedFile(File file)
selectedFile
- the selected filegetSelectedFile()
public File[] getSelectedFiles()
public void setSelectedFiles(File[] selectedFiles)
public File getCurrentDirectory()
setCurrentDirectory(java.io.File)
public void setCurrentDirectory(File dir)
currentDirectory
- the current directory to point togetCurrentDirectory()
public void changeToParentDirectory()
getCurrentDirectory()
public void rescanCurrentDirectory()
public void ensureFileIsVisible(File f)
f
- a File objectpublic int showOpenDialog(Component parent)
public int showSaveDialog(Component parent)
public int showDialog(Component parent, String approveButtonText)
approveButtonText
- the text of the ApproveButtonpublic int getDialogType()
setDialogType(int)
public void setDialogType(int dialogType)
dialogType
- the type of dialog to be displayed:
OPEN_DIALOG, SAVE_DIALOG, CUSTOM_DIALOGgetDialogType()
,
setApproveButtonText(java.lang.String)
public void setDialogTitle(String dialogTitle)
getDialogTitle()
public String getDialogTitle()
setDialogTitle(java.lang.String)
public void setApproveButtonToolTipText(String toolTipText)
setApproveButtonText(java.lang.String)
,
setDialogType(int)
,
showDialog(java.awt.Component, java.lang.String)
public String getApproveButtonToolTipText()
setApproveButtonText(java.lang.String)
,
setDialogType(int)
,
showDialog(java.awt.Component, java.lang.String)
public int getApproveButtonMnemonic()
setApproveButtonMnemonic(int)
public void setApproveButtonMnemonic(int mnemonic)
an
- int value for the mnemonic keygetApproveButtonMnemonic()
public void setApproveButtonMnemonic(char mnemonic)
an
- char value for the mnemonic keygetApproveButtonMnemonic()
public void setApproveButtonText(String approveButtonText)
approveButtonText
- the text used in the ApproveButtongetApproveButtonText()
,
setDialogType(int)
,
showDialog(java.awt.Component, java.lang.String)
public String getApproveButtonText()
setApproveButtonText(java.lang.String)
,
setDialogType(int)
,
showDialog(java.awt.Component, java.lang.String)
public FileFilter[] getChoosableFileFilters()
public void addChoosableFileFilter(FileFilter filter)
filter
- the FileFilter to add to the choosable file
filter listpublic boolean removeChoosableFileFilter(FileFilter f)
public void resetChoosableFileFilters()
public FileFilter getAcceptAllFileFilter()
public JComponent getAccessory()
setAccessory(javax.swing.JComponent)
public void setAccessory(JComponent newAccessory)
public void setFileSelectionMode(int mode)
dialogType
- the type of dialog to be displayed:
FILES_ONLY, DIRECTORIES_ONLY, FILES_AND_DIRECTORIESgetFileSelectionMode()
public int getFileSelectionMode()
an
- int indicating the type of dialog to be displayed:
FILES_ONLY, DIRECTORIES_ONLY, FILES_AND_DIRECTORIESsetFileSelectionMode(int)
public boolean isFileSelectionEnabled()
setFileSelectionMode(int)
,
getFileSelectionMode()
public boolean isDirectorySelectionEnabled()
setFileSelectionMode(int)
,
getFileSelectionMode()
public void setMultiSelectionEnabled(boolean b)
isMultiSelectionEnabled()
public boolean isMultiSelectionEnabled()
setMultiSelectionEnabled(boolean)
public boolean isFileHidingEnabled()
setFileHidingEnabled(boolean)
public void setFileHidingEnabled(boolean b)
b
- the boolean value that determines whether file hiding is
turned on or not.isFileHidingEnabled()
public void setFileFilter(FileFilter filter)
filter
- the new current file filter to usegetFileFilter()
public FileFilter getFileFilter()
setFileFilter(javax.swing.filechooser.FileFilter)
,
addChoosableFileFilter(javax.swing.filechooser.FileFilter)
public void setFileView(FileView fileView)
getFileView()
public FileView getFileView()
public String getName(File f)
FileView.getName(java.io.File)
public String getDescription(File f)
FileView.getDescription(java.io.File)
public String getTypeDescription(File f)
public Icon getIcon(File f)
FileView.getIcon(java.io.File)
public boolean isTraversable(File f)
FileView.isTraversable(java.io.File)
public boolean accept(File f)
FileFilter.accept(java.io.File)
public void setFileSystemView(FileSystemView fsv)
FileSystemView
public FileSystemView getFileSystemView()
setFileSystemView(javax.swing.filechooser.FileSystemView)
public void approveSelection()
public void cancelSelection()
public void addActionListener(ActionListener l)
public void removeActionListener(ActionListener l)
protected void fireActionPerformed(String command)
EventListenerList
public void updateUI()
JComponent.updateUI()
public String getUIClassID()
JComponent.getUIClassID()
,
UIDefaults.getUI(javax.swing.JComponent)
public FileChooserUI getUI()
protected String paramString()
null
.public AccessibleContext getAccessibleContext()
|
JavaTM 2 Platform Standard Edition |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |