Class JFileChooser
- All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible
JFileChooser
provides a simple mechanism for the user to
choose a file.
For information about using JFileChooser
, see
How to Use File Choosers,
a section in The Java Tutorial.
The following code pops up a file chooser for the user's home directory that sees only .jpg and .gif images:
JFileChooser chooser = new JFileChooser(); FileNameExtensionFilter filter = new FileNameExtensionFilter( "JPG & GIF Images", "jpg", "gif"); 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()); }
Warning: Swing is not thread safe. For more information see Swing's Threading Policy.
- Since:
- 1.2
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected class
This class implements accessibility support for theJFileChooser
class.Nested classes/interfaces declared in class JComponent
JComponent.AccessibleJComponent
Modifier and TypeClassDescriptionclass
Inner class of JComponent used to provide default support for accessibility.Nested classes/interfaces declared in class Container
Container.AccessibleAWTContainer
Modifier and TypeClassDescriptionprotected class
Inner class of Container used to provide default support for accessibility.Nested classes/interfaces declared in class Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
Modifier and TypeClassDescriptionprotected class
Inner class of Component used to provide default support for accessibility.static enum
Enumeration of the common ways the baseline of a component can change as the size changes.protected class
Inner class for blitting offscreen surfaces to a component.protected class
Inner class for flipping buffers on a component. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Identifies whether the AcceptAllFileFilter is used or not.protected AccessibleContext
AccessibleContext
associated with thisJFileChooser
static final String
Says that a different accessory component is in use (for example, to preview files).static final String
Identifies change in the mnemonic for the approve (yes, ok) button.static final String
Identifies change in the text on the approve (yes, ok) button.static final String
Identifies change in the tooltip text for the approve (yes, ok) button.static final int
Return value if approve (yes, ok) is chosen.static final String
Instruction to approve the current selection (same as pressing yes or ok).static final int
Return value if cancel is chosen.static final String
Instruction to cancel the current selection.static final String
Identifies a change in the list of predefined file filters the user can choose from.static final String
Instruction to display the control buttons.static final int
Type value indicating that theJFileChooser
supports a developer-specified file operation.static final String
Identifies a change in the dialog title.static final String
Identifies a change in the type of files displayed (files only, directories only, or both files and directories).static final int
Instruction to display only directories.static final String
Identifies user's directory change.static final int
Return value if an error occurred.static final String
User changed the kind of files to display.static final String
Identifies a change in the display-hidden-files property.static final String
Identifies a change in the kind of selection (single, multiple, etc.).static final String
Says that a different object is being used to find available drives on the system.static final String
Says that a different object is being used to retrieve file information.static final int
Instruction to display both files and directories.static final int
Instruction to display only files.static final String
Enables multiple-file selections.static final int
Type value indicating that theJFileChooser
supports an "Open" file operation.static final int
Type value indicating that theJFileChooser
supports a "Save" file operation.static final String
Identifies change in user's single-file selection.static final String
Identifies change in user's multiple-file selection.Fields declared in class JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
Modifier and TypeFieldDescriptionprotected EventListenerList
A list of event listeners for this component.static final String
The comment to display when the cursor is over the component, also known as a "value tip", "flyover help", or "flyover label".protected ComponentUI
The look and feel delegate for this component.static final int
Constant used by some of the APIs to mean that no condition is defined.static final int
Constant used forregisterKeyboardAction
that means that the command should be invoked when the receiving component is an ancestor of the focused component or is itself the focused component.static final int
Constant used forregisterKeyboardAction
that means that the command should be invoked when the component has the focus.static final int
Constant used forregisterKeyboardAction
that means that the command should be invoked when the receiving component is in the window that has the focus or is itself the focused component.Fields declared in class Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
Modifier and TypeFieldDescriptionstatic final float
Ease-of-use constant forgetAlignmentY
.static final float
Ease-of-use constant forgetAlignmentY
andgetAlignmentX
.static final float
Ease-of-use constant forgetAlignmentX
.static final float
Ease-of-use constant forgetAlignmentX
.static final float
Ease-of-use constant forgetAlignmentY()
.Fields declared in interface ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
Modifier and TypeFieldDescriptionstatic final int
This flag in the infoflags argument to imageUpdate indicates that an image which was being tracked asynchronously was aborted before production was complete.static final int
This flag in the infoflags argument to imageUpdate indicates that a static image which was previously drawn is now complete and can be drawn again in its final form.static final int
This flag in the infoflags argument to imageUpdate indicates that an image which was being tracked asynchronously has encountered an error.static final int
This flag in the infoflags argument to imageUpdate indicates that another complete frame of a multi-frame image which was previously drawn is now available to be drawn again.static final int
This flag in the infoflags argument to imageUpdate indicates that the height of the base image is now available and can be taken from the height argument to the imageUpdate callback method.static final int
This flag in the infoflags argument to imageUpdate indicates that the properties of the image are now available.static final int
This flag in the infoflags argument to imageUpdate indicates that more pixels needed for drawing a scaled variation of the image are available.static final int
This flag in the infoflags argument to imageUpdate indicates that the width of the base image is now available and can be taken from the width argument to the imageUpdate callback method. -
Constructor Summary
ConstructorsConstructorDescriptionConstructs aJFileChooser
pointing to the user's default directory.JFileChooser
(File currentDirectory) Constructs aJFileChooser
using the givenFile
as the path.JFileChooser
(File currentDirectory, FileSystemView fsv) Constructs aJFileChooser
using the given current directory andFileSystemView
.JFileChooser
(String currentDirectoryPath) Constructs aJFileChooser
using the given path.JFileChooser
(String currentDirectoryPath, FileSystemView fsv) Constructs aJFileChooser
using the given current directory path andFileSystemView
.Constructs aJFileChooser
using the givenFileSystemView
. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns true if the file should be displayed.void
Adds anActionListener
to the file chooser.void
addChoosableFileFilter
(FileFilter filter) Adds a filter to the list of user choosable file filters.void
Called by the UI when the user hits the Approve button (labeled "Open" or "Save", by default).void
Called by the UI when the user chooses the Cancel button.void
Changes the directory to be set to the parent of the current directory.protected JDialog
createDialog
(Component parent) Creates and returns a newJDialog
wrappingthis
centered on theparent
in theparent
's frame.void
Makes sure that the specified file is viewable, and not hidden.protected void
fireActionPerformed
(String command) Notifies all listeners that have registered interest for notification on this event type.Returns theAcceptAll
file filter.Gets the AccessibleContext associated with this JFileChooser.Returns the accessory component.Returns an array of all the action listeners registered on this file chooser.int
Returns the approve button's mnemonic.Returns the text used in theApproveButton
in theFileChooserUI
.Returns the tooltip text used in theApproveButton
.Gets the list of user choosable file filters.boolean
Returns the value of thecontrolButtonsAreShown
property.Returns the current directory.Returns the file description.Gets the string that goes in theJFileChooser
's titlebar.int
Returns the type of this dialog.boolean
Gets the value of thedragEnabled
property.Returns the currently selected file filter.int
Returns the current file-selection mode.Returns the file system view.Returns the current file view.Returns the icon for this file or type of file, depending on the system.Returns the filename.Returns the selected file.File[]
Returns a list of selected files if the file chooser is set to allow multiple selection.Returns the file type.getUI()
Gets the UI object which implements the L&F for this component.Returns a string that specifies the name of the L&F class that renders this component.boolean
Returns whether theAcceptAll FileFilter
is used.boolean
Convenience call that determines if directories are selectable based on the current file selection mode.boolean
Returns true if hidden files are not shown in the file chooser; otherwise, returns false.boolean
Convenience call that determines if files are selectable based on the current file selection mode.boolean
Returns true if multiple files can be selected.boolean
Returns true if the file (directory) can be visited.protected String
Returns a string representation of thisJFileChooser
.void
Removes anActionListener
from the file chooser.boolean
Removes a filter from the list of user choosable file filters.void
Tells the UI to rescan its files list from the current directory.void
Resets the choosable file filter list to its starting state.void
setAcceptAllFileFilterUsed
(boolean b) Determines whether theAcceptAll FileFilter
is used as an available choice in the choosable filter list.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 theApproveButton
in theFileChooserUI
.void
setApproveButtonToolTipText
(String toolTipText) Sets the tooltip text used in theApproveButton
.void
setControlButtonsAreShown
(boolean b) Sets the property that indicates whether the approve and cancel buttons are shown in the file chooser.void
setCurrentDirectory
(File dir) Sets the current directory.void
setDialogTitle
(String dialogTitle) Sets the string that goes in theJFileChooser
window's title bar.void
setDialogType
(int dialogType) Sets the type of this dialog.void
setDragEnabled
(boolean b) Sets thedragEnabled
property, which must betrue
to enable automatic drag handling (the first part of drag and drop) on this component.void
setEnabled
(boolean enabled) Sets whether or not this component is enabled.void
setFileFilter
(FileFilter filter) Sets the current file filter.void
setFileHidingEnabled
(boolean b) Sets file hiding on or off.void
setFileSelectionMode
(int mode) Sets theJFileChooser
to allow the user to just select files, just select directories, or select both files and directories.void
Sets the file system view that theJFileChooser
uses for accessing and creating file system resources, such as finding the floppy drive and getting a list of root drives.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.void
setMultiSelectionEnabled
(boolean b) Sets the file chooser 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 file chooser is set to allow multiple selection.protected void
setup
(FileSystemView view) Performs common constructor initialization and setup.int
showDialog
(Component parent, String approveButtonText) Pops a custom file chooser dialog with a custom approve button.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()
Resets the UI property to a value from the current look and feel.Methods declared in class JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, 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, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
Modifier and TypeMethodDescriptionvoid
addAncestorListener
(AncestorListener listener) Registerslistener
so that it will receiveAncestorEvents
when it or any of its ancestors move or are made visible or invisible.void
Notifies this component that it now has a parent component.void
Adds aVetoableChangeListener
to the listener list.void
computeVisibleRect
(Rectangle visibleRect) Returns theComponent
's "visible rect rectangle" - the intersection of the visible rectangles for this component and all of its ancestors.boolean
contains
(int x, int y) Gives the UI delegate an opportunity to define the precise shape of this component for the sake of mouse processing.Returns the instance ofJToolTip
that should be used to display the tooltip.void
disable()
Deprecated.void
enable()
Deprecated.As of JDK version 1.1, replaced byjava.awt.Component.setEnabled(boolean)
.void
firePropertyChange
(String propertyName, boolean oldValue, boolean newValue) Support for reporting bound property changes for boolean properties.void
firePropertyChange
(String propertyName, int oldValue, int newValue) Support for reporting bound property changes for integer properties.protected void
fireVetoableChange
(String propertyName, Object oldValue, Object newValue) Supports reporting constrained property changes.getActionForKeyStroke
(KeyStroke aKeyStroke) Returns the object that will perform the action registered for a given keystroke.final ActionMap
Returns theActionMap
used to determine whatAction
to fire for particularKeyStroke
binding.float
OverridesContainer.getAlignmentX
to return the horizontal alignment.float
OverridesContainer.getAlignmentY
to return the vertical alignment.Returns an array of all the ancestor listeners registered on this component.boolean
Gets theautoscrolls
property.int
getBaseline
(int width, int height) Returns the baseline.Returns an enum indicating how the baseline of the component changes as the size changes.Returns the border of this component ornull
if no border is currently set.Stores the bounds of this component into "return value"rv
and returnsrv
.final Object
getClientProperty
(Object key) Returns the value of the property with the specified key.protected Graphics
Returns the graphics object used to paint this component.ReturnsJPopupMenu
that assigned for this component.int
getConditionForKeyStroke
(KeyStroke aKeyStroke) Returns the condition that determines whether a registered action occurs in response to the specified keystroke.int
Returns the state of graphics debugging.static Locale
Returns the default locale used to initialize each JComponent's locale property upon creation.getFontMetrics
(Font font) Gets theFontMetrics
for the specifiedFont
.Returns this component's graphics context, which lets you draw on a component.int
Returns the current height of this component.boolean
Returns true if the JPopupMenu should be inherited from the parent.final InputMap
Returns theInputMap
that is used when the component has focus.final InputMap
getInputMap
(int condition) Returns theInputMap
that is used duringcondition
.Returns the input verifier for this component.If a border has been set on this component, returns the border's insets; otherwise callssuper.getInsets
.Returns anInsets
object containing this component's inset values.<T extends EventListener>
T[]getListeners
(Class<T> listenerType) Returns an array of all the objects currently registered asFooListener
s upon thisJComponent
.getLocation
(Point rv) Stores the x,y origin of this component into "return value"rv
and returnsrv
.If the maximum size has been set to a non-null
value just returns it.If the minimum size has been set to a non-null
value just returns it.Deprecated.As of 1.4, replaced byFocusTraversalPolicy
.getPopupLocation
(MouseEvent event) Returns the preferred location to display the popup menu in this component's coordinate system.If thepreferredSize
has been set to a non-null
value just returns it.Returns theKeyStrokes
that will initiate registered actions.Returns theJRootPane
ancestor for this component.Stores the width/height of this component into "return value"rv
and returnsrv
.getToolTipLocation
(MouseEvent event) Returns the tooltip location in this component's coordinate system.Returns the tooltip string that has been set withsetToolTipText
.getToolTipText
(MouseEvent event) Returns the string to be used as the tooltip for event.Returns the top-level ancestor of this component (the containingWindow
) ornull
if this component has not been added to any container.Gets thetransferHandler
property.boolean
Returns the value that indicates whether the input verifier for the current focus owner will be called before this component requests focus.Returns an array of all the vetoable change listeners registered on this component.Returns theComponent
's "visible rectangle" - the intersection of this component's visible rectangle,new Rectangle(0, 0, getWidth(), getHeight())
, and all of its ancestors' visible rectangles.int
getWidth()
Returns the current width of this component.int
getX()
Returns the current x coordinate of the component's origin.int
getY()
Returns the current y coordinate of the component's origin.void
Requests that this Component get the input focus, and that this Component's top-level ancestor become the focused Window.void
hide()
Deprecated.boolean
Returns whether this component should use a buffer to paint.static boolean
Returns true if this component is lightweight, that is, if it doesn't have a native window system peer.boolean
Deprecated.As of 1.4, replaced byComponent.setFocusTraversalKeys(int, Set)
andContainer.setFocusCycleRoot(boolean)
.boolean
isOpaque()
Returns true if this component is completely opaque.boolean
Returns true if this component tiles its children -- that is, if it can guarantee that the children will not overlap.final boolean
Returnstrue
if the current painting operation on this component is part of aprint
operation.protected boolean
Returnstrue
if a paint triggered on a child component should cause painting to originate from this Component, or one of its ancestors.boolean
Returns true if the component is currently painting a tile.boolean
Returnstrue
if thisJComponent
should get focus; otherwise returnsfalse
.boolean
If this method returns true,revalidate
calls by descendants of this component will cause the entire tree beginning with this root to be validated.void
Invoked by Swing to draw components.protected void
Paints the component's border.protected void
Paints this component's children.protected void
Calls the UI delegate's paint method, if the UI delegate is non-null
.void
paintImmediately
(int x, int y, int w, int h) Paints the specified region in this component and all of its descendants that overlap the region, immediately.void
Paints the specified region now.void
Invoke this method to print the component to the specifiedGraphics
.void
Invoke this method to print the component.protected void
Prints the component's border.protected void
Prints this component's children.protected void
This is invoked during a printing operation.protected void
Processes any key events that the component itself recognizes.protected boolean
processKeyBinding
(KeyStroke ks, KeyEvent e, int condition, boolean pressed) Invoked to process the key bindings forks
as the result of theKeyEvent
e
.protected void
OverridesprocessKeyEvent
to process events.protected void
Processes mouse events occurring on this component by dispatching them to any registeredMouseListener
objects, refer toComponent.processMouseEvent(MouseEvent)
for a complete description of this method.protected void
Processes mouse motion events, such as MouseEvent.MOUSE_DRAGGED.final void
putClientProperty
(Object key, Object value) Adds an arbitrary key/value "client property" to this component.void
registerKeyboardAction
(ActionListener anAction, String aCommand, KeyStroke aKeyStroke, int aCondition) This method is now obsolete, please use a combination ofgetActionMap()
andgetInputMap()
for similar behavior.void
registerKeyboardAction
(ActionListener anAction, KeyStroke aKeyStroke, int aCondition) This method is now obsolete, please use a combination ofgetActionMap()
andgetInputMap()
for similar behavior.void
removeAncestorListener
(AncestorListener listener) Unregisterslistener
so that it will no longer receiveAncestorEvents
.void
Notifies this component that it no longer has a parent component.void
Removes aVetoableChangeListener
from the listener list.void
repaint
(long tm, int x, int y, int width, int height) Adds the specified region to the dirty region list if the component is showing.void
Adds the specified region to the dirty region list if the component is showing.boolean
Deprecated.As of 1.4, replaced byFocusTraversalPolicy.getDefaultComponent(Container).requestFocus()
void
Requests that thisComponent
gets the input focus.boolean
requestFocus
(boolean temporary) Requests that thisComponent
gets the input focus.boolean
Requests that thisComponent
gets the input focus.protected boolean
requestFocusInWindow
(boolean temporary) Requests that thisComponent
gets the input focus.void
Unregisters all the bindings in the first tierInputMaps
andActionMap
.void
reshape
(int x, int y, int w, int h) Deprecated.As of JDK 5, replaced byComponent.setBounds(int, int, int, int)
.void
Supports deferred automatic layout.void
scrollRectToVisible
(Rectangle aRect) Forwards thescrollRectToVisible()
message to theJComponent
's parent.final void
Sets theActionMap
toam
.void
setAlignmentX
(float alignmentX) Sets the horizontal alignment.void
setAlignmentY
(float alignmentY) Sets the vertical alignment.void
setAutoscrolls
(boolean autoscrolls) Sets theautoscrolls
property.void
setBackground
(Color bg) Sets the background color of this component.void
Sets the border of this component.void
setComponentPopupMenu
(JPopupMenu popup) Sets theJPopupMenu
for thisJComponent
.void
setDebugGraphicsOptions
(int debugOptions) Enables or disables diagnostic information about every graphics operation performed within the component or one of its children.static void
Sets the default locale used to initialize each JComponent's locale property upon creation.void
setDoubleBuffered
(boolean aFlag) Sets whether this component should use a buffer to paint.void
setFocusTraversalKeys
(int id, Set<? extends AWTKeyStroke> keystrokes) Sets the focus traversal keys for a given traversal operation for this Component.void
Sets the font for this component.void
setForeground
(Color fg) Sets the foreground color of this component.void
setInheritsPopupMenu
(boolean value) Sets whether or notgetComponentPopupMenu
should delegate to the parent if this component does not have aJPopupMenu
assigned to it.final void
setInputMap
(int condition, InputMap map) Sets theInputMap
to use under the conditioncondition
tomap
.void
setInputVerifier
(InputVerifier inputVerifier) Sets the input verifier for this component.void
setMaximumSize
(Dimension maximumSize) Sets the maximum size of this component to a constant value.void
setMinimumSize
(Dimension minimumSize) Sets the minimum size of this component to a constant value.void
setNextFocusableComponent
(Component aComponent) Deprecated.As of 1.4, replaced byFocusTraversalPolicy
void
setOpaque
(boolean isOpaque) If true the component paints every pixel within its bounds.void
setPreferredSize
(Dimension preferredSize) Sets the preferred size of this component.void
setRequestFocusEnabled
(boolean requestFocusEnabled) Provides a hint as to whether or not thisJComponent
should get focus.void
setToolTipText
(String text) Registers the text to display in a tool tip.void
setTransferHandler
(TransferHandler newHandler) Sets theTransferHandler
, which provides support for transfer of data into and out of this component via cut/copy/paste and drag and drop.protected void
setUI
(ComponentUI newUI) Sets the look and feel delegate for this component.void
setVerifyInputWhenFocusTarget
(boolean verifyInputWhenFocusTarget) Sets the value to indicate whether input verifier for the current focus owner will be called before this component requests focus.void
setVisible
(boolean aFlag) Makes the component visible or invisible.void
unregisterKeyboardAction
(KeyStroke aKeyStroke) This method is now obsolete.void
Callspaint
.Methods declared in 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
Modifier and TypeMethodDescriptionAppends the specified component to the end of this container.Adds the specified component to this container at the given position.void
Adds the specified component to the end of this container.void
Adds the specified component to this container with the specified constraints at the specified index.Adds the specified component to this container.void
Adds the specified container listener to receive container events from this container.protected void
Adds the specified component to this container at the specified index.void
Adds a PropertyChangeListener to the listener list.void
addPropertyChangeListener
(String propertyName, PropertyChangeListener listener) Adds a PropertyChangeListener to the listener list for a specific property.void
Sets theComponentOrientation
property of this container and all components contained within it.boolean
areFocusTraversalKeysSet
(int id) Returns whether the Set of focus traversal keys for the given focus traversal operation has been explicitly defined for this Container.int
Deprecated.As of JDK version 1.1, replaced by getComponentCount().void
Deprecated.As of JDK version 1.1, replaced bydispatchEvent(AWTEvent e)
void
doLayout()
Causes this container to lay out its components.findComponentAt
(int x, int y) Locates the visible child component that contains the specified position.Locates the visible child component that contains the specified point.getComponent
(int n) Gets the nth component in this container.getComponentAt
(int x, int y) Locates the component that contains the x,y position.Gets the component that contains the specified point.int
Gets the number of components in this panel.Gets all the components in this container.int
getComponentZOrder
(Component comp) Returns the z-order index of the component inside the container.Returns an array of all the container listeners registered on this container.getFocusTraversalKeys
(int id) Returns the Set of focus traversal keys for a given traversal operation for this Container.Returns the focus traversal policy that will manage keyboard traversal of this Container's children, or null if this Container is not a focus cycle root.Gets the layout manager for this container.getMousePosition
(boolean allowChildren) Returns the position of the mouse pointer in thisContainer
's coordinate space if theContainer
is under the mouse pointer, otherwise returnsnull
.insets()
Deprecated.As of JDK version 1.1, replaced bygetInsets()
.void
Invalidates the container.boolean
Checks if the component is contained in the component hierarchy of this container.boolean
Returns whether this Container is the root of a focus traversal cycle.boolean
isFocusCycleRoot
(Container container) Returns whether the specified Container is the focus cycle root of this Container's focus traversal cycle.final boolean
Returns whether this container provides focus traversal policy.boolean
Returns whether the focus traversal policy has been explicitly set for this Container.void
layout()
Deprecated.As of JDK version 1.1, replaced bydoLayout()
.void
list
(PrintStream out, int indent) Prints a listing of this container to the specified output stream.void
list
(PrintWriter out, int indent) Prints out a list, starting at the specified indentation, to the specified print writer.locate
(int x, int y) Deprecated.As of JDK version 1.1, replaced bygetComponentAt(int, int)
.Deprecated.As of JDK version 1.1, replaced bygetMinimumSize()
.void
Paints each of the components in this container.Deprecated.As of JDK version 1.1, replaced bygetPreferredSize()
.void
Prints each of the components in this container.protected void
Processes container events occurring on this container by dispatching them to any registered ContainerListener objects.protected void
Processes events on this container.void
remove
(int index) Removes the component, specified byindex
, from this container.void
Removes the specified component from this container.void
Removes all the components from this container.void
Removes the specified container listener so it no longer receives container events from this container.void
setComponentZOrder
(Component comp, int index) Moves the specified component to the specified z-order index in the container.void
setFocusCycleRoot
(boolean focusCycleRoot) Sets whether this Container is the root of a focus traversal cycle.void
Sets the focus traversal policy that will manage keyboard traversal of this Container's children, if this Container is a focus cycle root.final void
setFocusTraversalPolicyProvider
(boolean provider) Sets whether this container will be used to provide focus traversal policy.void
setLayout
(LayoutManager mgr) Sets the layout manager for this container.void
Transfers the focus down one focus traversal cycle.void
validate()
Validates this container and all of its subcomponents.protected void
Recursively descends the container tree and recomputes the layout for any subtrees marked as needing it (those marked as invalid).Methods declared in 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, 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
Modifier and TypeMethodDescriptionboolean
Deprecated.As of JDK version 1.1, should register this component as ActionListener on component which fires action events.void
Adds the specified popup menu to the component.void
Adds the specified component listener to receive component events from this component.void
Adds the specified focus listener to receive focus events from this component when this component gains input focus.void
Adds the specified hierarchy bounds listener to receive hierarchy bounds events from this component when the hierarchy to which this container belongs changes.void
Adds the specified hierarchy listener to receive hierarchy changed events from this component when the hierarchy to which this container belongs changes.void
Adds the specified input method listener to receive input method events from this component.void
Adds the specified key listener to receive key events from this component.void
Adds the specified mouse listener to receive mouse events from this component.void
Adds the specified mouse motion listener to receive mouse motion events from this component.void
Adds the specified mouse wheel listener to receive mouse wheel events from this component.bounds()
Deprecated.As of JDK version 1.1, replaced bygetBounds()
.int
checkImage
(Image image, int width, int height, ImageObserver observer) Returns the status of the construction of a screen representation of the specified image.int
checkImage
(Image image, ImageObserver observer) Returns the status of the construction of a screen representation of the specified image.protected AWTEvent
coalesceEvents
(AWTEvent existingEvent, AWTEvent newEvent) Potentially coalesce an event being posted with an existing event.boolean
Checks whether this component "contains" the specified point, where the point's x and y coordinates are defined to be relative to the coordinate system of this component.createImage
(int width, int height) Creates an off-screen drawable image to be used for double buffering.createImage
(ImageProducer producer) Creates an image from the specified image producer.createVolatileImage
(int width, int height) Creates a volatile off-screen drawable image to be used for double buffering.createVolatileImage
(int width, int height, ImageCapabilities caps) Creates a volatile off-screen drawable image, with the given capabilities.protected final void
disableEvents
(long eventsToDisable) Disables the events defined by the specified event mask parameter from being delivered to this component.final void
Dispatches an event to this component or one of its sub components.void
enable
(boolean b) Deprecated.As of JDK version 1.1, replaced bysetEnabled(boolean)
.protected final void
enableEvents
(long eventsToEnable) Enables the events defined by the specified event mask parameter to be delivered to this component.void
enableInputMethods
(boolean enable) Enables or disables input method support for this component.void
firePropertyChange
(String propertyName, byte oldValue, byte newValue) Reports a bound property change.void
firePropertyChange
(String propertyName, char oldValue, char newValue) Reports a bound property change.void
firePropertyChange
(String propertyName, double oldValue, double newValue) Reports a bound property change.void
firePropertyChange
(String propertyName, float oldValue, float newValue) Reports a bound property change.void
firePropertyChange
(String propertyName, long oldValue, long newValue) Reports a bound property change.void
firePropertyChange
(String propertyName, short oldValue, short newValue) Reports a bound property change.protected void
firePropertyChange
(String propertyName, Object oldValue, Object newValue) Support for reporting bound property changes for Object properties.Gets the background color of this component.Gets the bounds of this component in the form of aRectangle
object.Gets the instance ofColorModel
used to display the component on the output device.Returns an array of all the component listeners registered on this component.Retrieves the language-sensitive orientation that is to be used to order the elements or text within this component.Gets the cursor set in the component.Gets theDropTarget
associated with thisComponent
.Returns the Container which is the focus cycle root of this Component's focus traversal cycle.Returns an array of all the focus listeners registered on this component.boolean
Returns whether focus traversal keys are enabled for this Component.getFont()
Gets the font of this component.Gets the foreground color of this component.Gets theGraphicsConfiguration
associated with thisComponent
.Returns an array of all the hierarchy bounds listeners registered on this component.Returns an array of all the hierarchy listeners registered on this component.boolean
Returns whether or not paint messages received from the operating system should be ignored.Gets the input context used by this component for handling the communication with input methods when text is entered in this component.Returns an array of all the input method listeners registered on this component.Gets the input method request handler which supports requests from input methods for this component.Returns an array of all the key listeners registered on this component.Gets the locale of this component.Gets the location of this component in the form of a point specifying the component's top-left corner.Gets the location of this component in the form of a point specifying the component's top-left corner in the screen's coordinate space.Returns an array of all the mouse listeners registered on this component.Returns an array of all the mouse motion listeners registered on this component.Returns the position of the mouse pointer in thisComponent
's coordinate space if theComponent
is directly under the mouse pointer, otherwise returnsnull
.Returns an array of all the mouse wheel listeners registered on this component.getName()
Gets the name of the component.Gets the parent of this component.Returns an array of all the property change listeners registered on this component.getPropertyChangeListeners
(String propertyName) Returns an array of all the listeners which have been associated with the named property.getSize()
Returns the size of this component in the form of aDimension
object.Gets the toolkit of this component.final Object
Gets this component's locking object (the object that owns the thread synchronization monitor) for AWT component-tree and layout operations.boolean
Deprecated.As of JDK version 1.1, replaced by processFocusEvent(FocusEvent).boolean
handleEvent
(Event evt) Deprecated.As of JDK version 1.1 replaced by processEvent(AWTEvent).boolean
hasFocus()
Returnstrue
if thisComponent
is the focus owner.boolean
imageUpdate
(Image img, int infoflags, int x, int y, int w, int h) Repaints the component when the image has changed.boolean
inside
(int x, int y) Deprecated.As of JDK version 1.1, replaced by contains(int, int).boolean
Returns whether the background color has been explicitly set for this Component.boolean
Returns whether the cursor has been explicitly set for this Component.boolean
Determines whether this component is displayable.boolean
Determines whether this component is enabled.boolean
Returns whether this Component can be focused.boolean
Returnstrue
if thisComponent
is the focus owner.boolean
Deprecated.As of 1.4, replaced byisFocusable()
.boolean
Returns whether the font has been explicitly set for this Component.boolean
Returns whether the foreground color has been explicitly set for this Component.boolean
A lightweight component doesn't have a native toolkit peer.boolean
Returns true if the maximum size has been set to a non-null
value otherwise returns false.boolean
Returns whether or notsetMinimumSize
has been invoked with a non-null value.boolean
Returns true if the preferred size has been set to a non-null
value otherwise returns false.boolean
Determines whether this component is showing on screen.boolean
isValid()
Determines whether this component is valid.boolean
Determines whether this component should be visible when its parent is visible.boolean
Deprecated.As of JDK version 1.1, replaced by processKeyEvent(KeyEvent).boolean
Deprecated.As of JDK version 1.1, replaced by processKeyEvent(KeyEvent).void
list()
Prints a listing of this component to the standard system output streamSystem.out
.void
list
(PrintStream out) Prints a listing of this component to the specified output stream.void
list
(PrintWriter out) Prints a listing to the specified print writer.location()
Deprecated.As of JDK version 1.1, replaced bygetLocation()
.boolean
Deprecated.As of JDK version 1.1, replaced by processFocusEvent(FocusEvent).boolean
Deprecated.As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).boolean
Deprecated.As of JDK version 1.1, replaced by processMouseMotionEvent(MouseEvent).boolean
mouseEnter
(Event evt, int x, int y) Deprecated.As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).boolean
Deprecated.As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).boolean
Deprecated.As of JDK version 1.1, replaced by processMouseMotionEvent(MouseEvent).boolean
Deprecated.As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).void
move
(int x, int y) Deprecated.As of JDK version 1.1, replaced bysetLocation(int, int)
.void
Deprecated.As of JDK version 1.1, replaced by transferFocus().void
Paints this component and all of its subcomponents.boolean
Deprecated.As of JDK version 1.1, replaced by dispatchEvent(AWTEvent).boolean
prepareImage
(Image image, int width, int height, ImageObserver observer) Prepares an image for rendering on this component at the specified width and height.boolean
prepareImage
(Image image, ImageObserver observer) Prepares an image for rendering on this component.protected void
Processes component events occurring on this component by dispatching them to any registeredComponentListener
objects.protected void
Processes focus events occurring on this component by dispatching them to any registeredFocusListener
objects.protected void
Processes hierarchy bounds events occurring on this component by dispatching them to any registeredHierarchyBoundsListener
objects.protected void
Processes hierarchy events occurring on this component by dispatching them to any registeredHierarchyListener
objects.protected void
Processes input method events occurring on this component by dispatching them to any registeredInputMethodListener
objects.protected void
Processes mouse wheel events occurring on this component by dispatching them to any registeredMouseWheelListener
objects.void
remove
(MenuComponent popup) Removes the specified popup menu from the component.void
Removes the specified component listener so that it no longer receives component events from this component.void
Removes the specified focus listener so that it no longer receives focus events from this component.void
Removes the specified hierarchy bounds listener so that it no longer receives hierarchy bounds events from this component.void
Removes the specified hierarchy listener so that it no longer receives hierarchy changed events from this component.void
Removes the specified input method listener so that it no longer receives input method events from this component.void
Removes the specified key listener so that it no longer receives key events from this component.void
Removes the specified mouse listener so that it no longer receives mouse events from this component.void
Removes the specified mouse motion listener so that it no longer receives mouse motion events from this component.void
Removes the specified mouse wheel listener so that it no longer receives mouse wheel events from this component.void
Removes a PropertyChangeListener from the listener list.void
removePropertyChangeListener
(String propertyName, PropertyChangeListener listener) Removes aPropertyChangeListener
from the listener list for a specific property.void
repaint()
Repaints this component.void
repaint
(int x, int y, int width, int height) Repaints the specified rectangle of this component.void
repaint
(long tm) Repaints the component.protected boolean
requestFocus
(boolean temporary, FocusEvent.Cause cause) Requests by the reason ofcause
that thisComponent
get the input focus, and that thisComponent
's top-level ancestor become the focusedWindow
.void
requestFocus
(FocusEvent.Cause cause) Requests by the reason ofcause
that this Component get the input focus, and that this Component's top-level ancestor become the focused Window.boolean
Requests by the reason ofcause
that this Component get the input focus, if this Component's top-level ancestor is already the focused Window.void
resize
(int width, int height) Deprecated.As of JDK version 1.1, replaced bysetSize(int, int)
.void
Deprecated.As of JDK version 1.1, replaced bysetSize(Dimension)
.void
setBounds
(int x, int y, int width, int height) Moves and resizes this component.void
Moves and resizes this component to conform to the new bounding rectangler
.void
Sets the language-sensitive orientation that is to be used to order the elements or text within this component.void
Sets the cursor image to the specified cursor.void
Associate aDropTarget
with this component.void
setFocusable
(boolean focusable) Sets the focusable state of this Component to the specified value.void
setFocusTraversalKeysEnabled
(boolean focusTraversalKeysEnabled) Sets whether focus traversal keys are enabled for this Component.void
setIgnoreRepaint
(boolean ignoreRepaint) Sets whether or not paint messages received from the operating system should be ignored.void
Sets the locale of this component.void
setLocation
(int x, int y) Moves this component to a new location.void
setLocation
(Point p) Moves this component to a new location.void
setMixingCutoutShape
(Shape shape) Sets a 'mixing-cutout' shape for this lightweight component.void
Sets the name of the component to the specified string.void
setSize
(int width, int height) Resizes this component so that it has widthwidth
and heightheight
.void
Resizes this component so that it has widthd.width
and heightd.height
.void
show()
Deprecated.As of JDK version 1.1, replaced bysetVisible(boolean)
.void
show
(boolean b) Deprecated.As of JDK version 1.1, replaced bysetVisible(boolean)
.size()
Deprecated.As of JDK version 1.1, replaced bygetSize()
.toString()
Returns a string representation of this component and its values.void
Transfers the focus to the next component, as though this Component were the focus owner.void
Transfers the focus to the previous component, as though this Component were the focus owner.void
Transfers the focus up one focus traversal cycle.Methods declared in class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Modifier and TypeMethodDescriptionprotected Object
clone()
Creates and returns a copy of this object.boolean
Indicates whether some other object is "equal to" this one.protected void
finalize()
Deprecated, for removal: This API element is subject to removal in a future version.Finalization is deprecated and subject to removal in a future release.final Class
<?> getClass()
Returns the runtime class of thisObject
.int
hashCode()
Returns a hash code value for this object.final void
notify()
Wakes up a single thread that is waiting on this object's monitor.final void
Wakes up all threads that are waiting on this object's monitor.final void
wait()
Causes the current thread to wait until it is awakened, typically by being notified or interrupted.final void
wait
(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.final void
wait
(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
-
Field Details
-
OPEN_DIALOG
public static final int OPEN_DIALOGType value indicating that theJFileChooser
supports an "Open" file operation.- See Also:
-
SAVE_DIALOG
public static final int SAVE_DIALOGType value indicating that theJFileChooser
supports a "Save" file operation.- See Also:
-
CUSTOM_DIALOG
public static final int CUSTOM_DIALOGType value indicating that theJFileChooser
supports a developer-specified file operation.- See Also:
-
CANCEL_OPTION
public static final int CANCEL_OPTIONReturn value if cancel is chosen.- See Also:
-
APPROVE_OPTION
public static final int APPROVE_OPTIONReturn value if approve (yes, ok) is chosen.- See Also:
-
ERROR_OPTION
public static final int ERROR_OPTIONReturn value if an error occurred.- See Also:
-
FILES_ONLY
public static final int FILES_ONLYInstruction to display only files.- See Also:
-
DIRECTORIES_ONLY
public static final int DIRECTORIES_ONLYInstruction to display only directories.- See Also:
-
FILES_AND_DIRECTORIES
public static final int FILES_AND_DIRECTORIESInstruction to display both files and directories.- See Also:
-
CANCEL_SELECTION
-
APPROVE_SELECTION
Instruction to approve the current selection (same as pressing yes or ok).- See Also:
-
APPROVE_BUTTON_TEXT_CHANGED_PROPERTY
Identifies change in the text on the approve (yes, ok) button.- See Also:
-
APPROVE_BUTTON_TOOL_TIP_TEXT_CHANGED_PROPERTY
Identifies change in the tooltip text for the approve (yes, ok) button.- See Also:
-
APPROVE_BUTTON_MNEMONIC_CHANGED_PROPERTY
Identifies change in the mnemonic for the approve (yes, ok) button.- See Also:
-
CONTROL_BUTTONS_ARE_SHOWN_CHANGED_PROPERTY
Instruction to display the control buttons.- See Also:
-
DIRECTORY_CHANGED_PROPERTY
-
SELECTED_FILE_CHANGED_PROPERTY
Identifies change in user's single-file selection.- See Also:
-
SELECTED_FILES_CHANGED_PROPERTY
Identifies change in user's multiple-file selection.- See Also:
-
MULTI_SELECTION_ENABLED_CHANGED_PROPERTY
Enables multiple-file selections.- See Also:
-
FILE_SYSTEM_VIEW_CHANGED_PROPERTY
Says that a different object is being used to find available drives on the system.- See Also:
-
FILE_VIEW_CHANGED_PROPERTY
Says that a different object is being used to retrieve file information.- See Also:
-
FILE_HIDING_CHANGED_PROPERTY
Identifies a change in the display-hidden-files property.- See Also:
-
FILE_FILTER_CHANGED_PROPERTY
User changed the kind of files to display.- See Also:
-
FILE_SELECTION_MODE_CHANGED_PROPERTY
Identifies a change in the kind of selection (single, multiple, etc.).- See Also:
-
ACCESSORY_CHANGED_PROPERTY
Says that a different accessory component is in use (for example, to preview files).- See Also:
-
ACCEPT_ALL_FILE_FILTER_USED_CHANGED_PROPERTY
Identifies whether the AcceptAllFileFilter is used or not.- See Also:
-
DIALOG_TITLE_CHANGED_PROPERTY
Identifies a change in the dialog title.- See Also:
-
DIALOG_TYPE_CHANGED_PROPERTY
Identifies a change in the type of files displayed (files only, directories only, or both files and directories).- See Also:
-
CHOOSABLE_FILE_FILTER_CHANGED_PROPERTY
Identifies a change in the list of predefined file filters the user can choose from.- See Also:
-
accessibleContext
AccessibleContext
associated with thisJFileChooser
-
-
Constructor Details
-
JFileChooser
public JFileChooser()Constructs aJFileChooser
pointing to the user's default directory. This default depends on the operating system. It is typically the "Documents" folder on Windows, and the user's home directory on Unix. -
JFileChooser
Constructs aJFileChooser
using the given path. Passing in anull
string causes the file chooser to point to the user's default directory. This default depends on the operating system. It is typically the "Documents" folder on Windows, and the user's home directory on Unix.- Parameters:
currentDirectoryPath
- aString
giving the path to a file or directory
-
JFileChooser
Constructs aJFileChooser
using the givenFile
as the path. Passing in anull
file causes the file chooser to point to the user's default directory. This default depends on the operating system. It is typically the "Documents" folder on Windows, and the user's home directory on Unix.- Parameters:
currentDirectory
- aFile
object specifying the path to a file or directory
-
JFileChooser
Constructs aJFileChooser
using the givenFileSystemView
.- Parameters:
fsv
- aFileSystemView
-
JFileChooser
Constructs aJFileChooser
using the given current directory andFileSystemView
.- Parameters:
currentDirectory
- aFile
object specifying the path to a file or directoryfsv
- aFileSystemView
-
JFileChooser
Constructs aJFileChooser
using the given current directory path andFileSystemView
.- Parameters:
currentDirectoryPath
- aString
specifying the path to a file or directoryfsv
- aFileSystemView
-
-
Method Details
-
setup
Performs common constructor initialization and setup.- Parameters:
view
- theFileSystemView
used for setup
-
setDragEnabled
@BeanProperty(bound=false, description="determines whether automatic drag handling is enabled") public void setDragEnabled(boolean b) Sets thedragEnabled
property, which must betrue
to enable automatic drag handling (the first part of drag and drop) on this component. ThetransferHandler
property needs to be set to a non-null
value for the drag to do anything. The default value of thedragEnabled
property isfalse
.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 aTransferHandler
.- Parameters:
b
- the value to set thedragEnabled
property to- Throws:
HeadlessException
- ifb
istrue
andGraphicsEnvironment.isHeadless()
returnstrue
- Since:
- 1.4
- See Also:
-
getDragEnabled
public boolean getDragEnabled()Gets the value of thedragEnabled
property.- Returns:
- the value of the
dragEnabled
property - Since:
- 1.4
- See Also:
-
getSelectedFile
Returns the selected file. This can be set either by the programmer viasetSelectedFile
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
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:
-
getSelectedFiles
Returns a list of selected files if the file chooser is set to allow multiple selection.- Returns:
- an array of selected
File
s
-
setSelectedFiles
@BeanProperty(description="The list of selected files if the chooser is in multiple selection mode.") public void setSelectedFiles(File[] selectedFiles) Sets the list of selected files if the file chooser is set to allow multiple selection.- Parameters:
selectedFiles
- an arrayFile
s to be selected
-
getCurrentDirectory
Returns the current directory.- Returns:
- the current directory
- See Also:
-
setCurrentDirectory
@BeanProperty(preferred=true, description="The directory that the JFileChooser is showing files of.") public void setCurrentDirectory(File dir) Sets the current directory. Passing innull
sets the file chooser to point to the user's default directory. This default depends on the operating system. It is typically the "Documents" folder on Windows, and the user's home directory on Unix. If the file passed in ascurrentDirectory
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:
-
changeToParentDirectory
public void changeToParentDirectory()Changes the directory to be set to the parent of the current directory.- See Also:
-
rescanCurrentDirectory
public void rescanCurrentDirectory()Tells the UI to rescan its files list from the current directory. -
ensureFileIsVisible
Makes sure that the specified file is viewable, and not hidden.- Parameters:
f
- a File object
-
showOpenDialog
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 benull
; seeshowDialog
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:
-
showSaveDialog
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 benull
; seeshowDialog
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:
-
showDialog
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 aFrame
object (such as aJFrame
) 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 isnull
, 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 benull
approveButtonText
- the text of theApproveButton
- 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:
-
createDialog
Creates and returns a newJDialog
wrappingthis
centered on theparent
in theparent
's frame. This method can be overridden to further manipulate the dialog, to disable resizing, set the location, etc. Example:class MyFileChooser extends JFileChooser { protected JDialog createDialog(Component parent) throws HeadlessException { JDialog dialog = super.createDialog(parent); dialog.setLocation(300, 200); dialog.setResizable(false); return dialog; } }
- Parameters:
parent
- the parent component of the dialog; can benull
- Returns:
- a new
JDialog
containing this instance - Throws:
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true.- Since:
- 1.4
- See Also:
-
getControlButtonsAreShown
public boolean getControlButtonsAreShown()Returns the value of thecontrolButtonsAreShown
property.- Returns:
- the value of the
controlButtonsAreShown
property - Since:
- 1.3
- See Also:
-
setControlButtonsAreShown
@BeanProperty(preferred=true, description="Sets whether the approve & cancel buttons are shown.") public void setControlButtonsAreShown(boolean b) Sets the property that indicates whether the approve and cancel buttons are shown in the file chooser. This property istrue
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 ofCONTROL_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:
-
getDialogType
public int getDialogType()Returns the type of this dialog. The default isJFileChooser.OPEN_DIALOG
.- Returns:
- the type of dialog to be displayed:
- JFileChooser.OPEN_DIALOG
- JFileChooser.SAVE_DIALOG
- JFileChooser.CUSTOM_DIALOG
- See Also:
-
setDialogType
@BeanProperty(preferred=true, enumerationValues={"JFileChooser.OPEN_DIALOG","JFileChooser.SAVE_DIALOG","JFileChooser.CUSTOM_DIALOG"}, description="The type (open, save, custom) of the JFileChooser.") public void setDialogType(int dialogType) Sets the type of this dialog. UseOPEN_DIALOG
when you want to bring up a file chooser that the user can use to open a file. Likewise, useSAVE_DIALOG
for letting the user choose a file for saving. UseCUSTOM_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 theJFileChooser
to useCUSTOM_DIALOG
since a call tosetApproveButtonText
does this for you. The default dialog type isJFileChooser.OPEN_DIALOG
.- Parameters:
dialogType
- the type of dialog to be displayed:- JFileChooser.OPEN_DIALOG
- JFileChooser.SAVE_DIALOG
- JFileChooser.CUSTOM_DIALOG
- Throws:
IllegalArgumentException
- ifdialogType
is not legal- See Also:
-
setDialogTitle
@BeanProperty(preferred=true, description="The title of the JFileChooser dialog window.") public void setDialogTitle(String dialogTitle) Sets the string that goes in theJFileChooser
window's title bar.- Parameters:
dialogTitle
- the newString
for the title bar- See Also:
-
getDialogTitle
Gets the string that goes in theJFileChooser
's titlebar.- Returns:
- the string from the
JFileChooser
window's title bar - See Also:
-
setApproveButtonToolTipText
@BeanProperty(preferred=true, description="The tooltip text for the ApproveButton.") public void setApproveButtonToolTipText(String toolTipText) Sets the tooltip text used in theApproveButton
. Ifnull
, the UI object will determine the button's text.- Parameters:
toolTipText
- the tooltip text for the approve button- See Also:
-
getApproveButtonToolTipText
Returns the tooltip text used in theApproveButton
. Ifnull
, the UI object will determine the button's text.- Returns:
- the tooltip text used for the approve button
- See Also:
-
getApproveButtonMnemonic
public int getApproveButtonMnemonic()Returns the approve button's mnemonic.- Returns:
- an integer value for the mnemonic key
- See Also:
-
setApproveButtonMnemonic
@BeanProperty(preferred=true, description="The mnemonic key accelerator for the ApproveButton.") public 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:
-
setApproveButtonMnemonic
public void setApproveButtonMnemonic(char mnemonic) Sets the approve button's mnemonic using a character.- Parameters:
mnemonic
- a character value for the mnemonic key- See Also:
-
setApproveButtonText
@BeanProperty(preferred=true, description="The text that goes in the ApproveButton.") public void setApproveButtonText(String approveButtonText) Sets the text used in theApproveButton
in theFileChooserUI
.- Parameters:
approveButtonText
- the text used in theApproveButton
- See Also:
-
getApproveButtonText
Returns the text used in theApproveButton
in theFileChooserUI
. Ifnull
, the UI object will determine the button's text. Typically, this would be "Open" or "Save".- Returns:
- the text used in the
ApproveButton
- See Also:
-
getChoosableFileFilters
Gets the list of user choosable file filters.- Returns:
- a
FileFilter
array containing all the choosable file filters - See Also:
-
addChoosableFileFilter
@BeanProperty(preferred=true, description="Adds a filter to the list of user choosable file filters.") public void addChoosableFileFilter(FileFilter filter) Adds a filter to the list of user choosable file filters. For information on setting the file selection mode, seesetFileSelectionMode
.- Parameters:
filter
- theFileFilter
to add to the choosable file filter list- See Also:
-
removeChoosableFileFilter
Removes a filter from the list of user choosable file filters. Returns true if the file filter was removed.- Parameters:
f
- the file filter to be removed- Returns:
- true if the file filter was removed, false otherwise
- See Also:
-
resetChoosableFileFilters
public void resetChoosableFileFilters()Resets the choosable file filter list to its starting state. Normally, this removes all added file filters while leaving theAcceptAll
file filter.- See Also:
-
getAcceptAllFileFilter
Returns theAcceptAll
file filter. For example, on Microsoft Windows this would be All Files (*.*).- Returns:
- the
AcceptAll
file filter
-
isAcceptAllFileFilterUsed
public boolean isAcceptAllFileFilterUsed()Returns whether theAcceptAll FileFilter
is used.- Returns:
- true if the
AcceptAll FileFilter
is used - Since:
- 1.3
- See Also:
-
setAcceptAllFileFilterUsed
@BeanProperty(preferred=true, description="Sets whether the AcceptAll FileFilter is used as an available choice in the choosable filter list.") public void setAcceptAllFileFilterUsed(boolean b) Determines whether theAcceptAll FileFilter
is used as an available choice in the choosable filter list. If false, theAcceptAll
file filter is removed from the list of available file filters. If true, theAcceptAll
file filter will become the actively used file filter.- Parameters:
b
- aboolean
which determines whether theAcceptAll
file filter is an available choice in the choosable filter list- Since:
- 1.3
- See Also:
-
getAccessory
Returns the accessory component.- Returns:
- this JFileChooser's accessory component, or null
- See Also:
-
setAccessory
@BeanProperty(preferred=true, description="Sets the accessory component on the JFileChooser.") public 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
@BeanProperty(preferred=true, enumerationValues={"JFileChooser.FILES_ONLY","JFileChooser.DIRECTORIES_ONLY","JFileChooser.FILES_AND_DIRECTORIES"}, description="Sets the types of files that the JFileChooser can choose.") public void setFileSelectionMode(int mode) Sets theJFileChooser
to allow the user to just select files, just select directories, or select both files and directories. The default isJFilesChooser.FILES_ONLY
.- Parameters:
mode
- the type of files to be displayed:- JFileChooser.FILES_ONLY
- JFileChooser.DIRECTORIES_ONLY
- JFileChooser.FILES_AND_DIRECTORIES
- Throws:
IllegalArgumentException
- ifmode
is an illegal file selection mode- See Also:
-
getFileSelectionMode
public int getFileSelectionMode()Returns the current file-selection mode. The default isJFilesChooser.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:
-
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:
-
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:
-
setMultiSelectionEnabled
@BeanProperty(description="Sets multiple file selection mode.") public 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
public boolean isMultiSelectionEnabled()Returns true if multiple files can be selected.- Returns:
- true if multiple files can be selected
- See Also:
-
isFileHidingEnabled
public boolean isFileHidingEnabled()Returns true if hidden files are not shown in the file chooser; otherwise, returns false. The default value of this property may be derived from the underlying Operating System.- Returns:
- the status of the file hiding property
- See Also:
-
setFileHidingEnabled
@BeanProperty(preferred=true, description="Sets file hiding on or off.") public 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 theFileView
.- Parameters:
b
- the boolean value that determines whether file hiding is turned on- See Also:
-
setFileFilter
@BeanProperty(preferred=true, description="Sets the File Filter used to filter out files of type.") public 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
Returns the currently selected file filter.- Returns:
- the current file filter
- See Also:
-
setFileView
@BeanProperty(preferred=true, description="Sets the File View used to get file type information.") public 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
- aFileView
to be used to retrieve UI information- See Also:
-
getFileView
Returns the current file view.- Returns:
- the current file view
- See Also:
-
getName
-
getDescription
-
getTypeDescription
-
getIcon
-
isTraversable
Returns true if the file (directory) can be visited. Returns false if the directory cannot be traversed.- Parameters:
f
- theFile
- Returns:
- true if the file/directory can be traversed, otherwise false
- See Also:
-
accept
Returns true if the file should be displayed.- Parameters:
f
- theFile
- Returns:
- true if the file should be displayed, otherwise false
- See Also:
-
setFileSystemView
@BeanProperty(expert=true, description="Sets the FileSystemView used to get filesystem information.") public void setFileSystemView(FileSystemView fsv) Sets the file system view that theJFileChooser
uses for accessing and creating file system resources, such as finding the floppy drive and getting a list of root drives.- Parameters:
fsv
- the newFileSystemView
- See Also:
-
getFileSystemView
Returns the file system view.- Returns:
- the
FileSystemView
object - See Also:
-
approveSelection
public 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 toAPPROVE_SELECTION
.- See Also:
-
cancelSelection
public 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 toCANCEL_SELECTION
.- See Also:
-
addActionListener
Adds anActionListener
to the file chooser.- Parameters:
l
- the listener to be added- See Also:
-
removeActionListener
Removes anActionListener
from the file chooser.- Parameters:
l
- the listener to be removed- See Also:
-
getActionListeners
Returns an array of all the action listeners registered on this file chooser.- Returns:
- all of this file chooser's
ActionListener
s or an empty array if no action listeners are currently registered - Since:
- 1.4
- See Also:
-
fireActionPerformed
Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using thecommand
parameter.- Parameters:
command
- a string that may specify a command associated with the event- See Also:
-
updateUI
public void updateUI()Resets the UI property to a value from the current look and feel.- Overrides:
updateUI
in classJComponent
- See Also:
-
getUIClassID
@BeanProperty(bound=false, expert=true, description="A string that specifies the name of the L&F class.") public String getUIClassID()Returns a string that specifies the name of the L&F class that renders this component.- Overrides:
getUIClassID
in classJComponent
- Returns:
- the string "FileChooserUI"
- See Also:
-
getUI
Gets the UI object which implements the L&F for this component.- Overrides:
getUI
in classJComponent
- Returns:
- the FileChooserUI object that implements the FileChooserUI L&F
-
paramString
Returns a string representation of thisJFileChooser
. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not benull
.- Overrides:
paramString
in classJComponent
- Returns:
- a string representation of this
JFileChooser
-
getAccessibleContext
Gets the AccessibleContext associated with this JFileChooser. For file choosers, the AccessibleContext takes the form of an AccessibleJFileChooser. A new AccessibleJFileChooser instance is created if necessary.- Specified by:
getAccessibleContext
in interfaceAccessible
- Overrides:
getAccessibleContext
in classComponent
- Returns:
- an AccessibleJFileChooser that serves as the AccessibleContext of this JFileChooser
-
setEnabled
public void setEnabled(boolean enabled) Sets whether or not this component is enabled. A component that is enabled may respond to user input, while a component that is not enabled cannot respond to user input. Some components may alter their visual representation when they are disabled in order to provide feedback to the user that they cannot take input.Note: Disabling a component does not disable its children.
Note: Disabling a lightweight component does not prevent it from receiving MouseEvents.
- Overrides:
setEnabled
in classJComponent
- Parameters:
enabled
- true if this component should be enabled, false otherwise- See Also:
-
java.awt.Component.setEnabled(boolean)
.