org.xnap.commons.gui
Class FileChooserPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.xnap.commons.gui.FileChooserPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class FileChooserPanel
extends JPanel

Provides a panel with a JTextField and a button for file selection.

Author:

Steffen Pingel, Felix Berger

See Also:

Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

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

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

FileChooserPanel(File file, int columns)
Constructs a file chooser panel with an initial text.

FileChooserPanel(int columns)
Constructs a file chooser panel.

Method Summary

protected void	fileSelected(File file) Sub classes can overwrite this.
Completion	getCompletion() Returns the completion object associated with the file text field.
Component	getDialogParent() Returns the parent of the file chooser dialog.
File	getFile() Returns a file having the path name of the currently set text in the text field.
JFileChooser	getFileChooser() Returns the file chooser that is used to select the file.
Action	getFileChooserAction()
String	getFilename() Deprecated.
JTextField	getTextField() Returns the text field used internally.
void	setDialogParent(Component dialogParent) Sets the parent of the file chooser dialog that is used internally.
void	setEnabled(boolean enabled) Enables/disables this component and all of its subcomponents.
void	setFile(File file) Sets the text in the text field to the absolute path of file.
void	setFileChooser(JFileChooser chooser) Sets the file chooser to use that is used by the file chooser action.
void	setFilename(String filename) Deprecated.
protected boolean	showChooser() The default implementation shows a JFileChooser.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, 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

Methods inherited from class java.awt.Container

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

Methods inherited from class java.awt.Component

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

Methods inherited from class java.lang.Object

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

Constructor Detail

FileChooserPanel

public FileChooserPanel(File file,
                        int columns)

Constructs a file chooser panel with an initial text.

Parameters:

file - the filename to display can be null

columns - the number of columns for calculating the preferred width of the text field, can be 0

See Also:

setFile(File)

FileChooserPanel

public FileChooserPanel(int columns)

Constructs a file chooser panel.

Parameters:

columns - the number of columns for calculating the preferred width of the text field, can be 0

Method Detail

fileSelected

protected void fileSelected(File file)

Sub classes can overwrite this.

getFile

public File getFile()

Returns a file having the path name of the currently set text in the text field.

Returns:

the returned file does not necessarily have to exist; null, if no file was entered

getFileChooser

public JFileChooser getFileChooser()

Returns the file chooser that is used to select the file.

Returns:

the file chooser; never returns null

setFile

public void setFile(File file)

Sets the text in the text field to the absolute path of file.

Parameters:

file - can be null the text field is cleared then.

setFileChooser

public void setFileChooser(JFileChooser chooser)

Sets the file chooser to use that is used by the file chooser action.

Parameters:

chooser - the file chooser; if null, a default file chooser will be created when the action is performed

getFilename

public String getFilename()

Deprecated.

Returns the text that is currently set in the text field of the chooser panel.

Use getFile().

setFilename

public void setFilename(String filename)

Deprecated.

Sets the text in the text field.

Use setFile(File).

Parameters:

filename - the text

getTextField

public JTextField getTextField()

Returns the text field used internally.

getCompletion

public Completion getCompletion()

Returns the completion object associated with the file text field.

Thus, you can disable completion or save the used completion mode in a setting.

getFileChooserAction

public Action getFileChooserAction()

getDialogParent

public Component getDialogParent()

Returns the parent of the file chooser dialog.

Returns:

the parent of the file chooser dialog

setEnabled

public void setEnabled(boolean enabled)

Enables/disables this component and all of its subcomponents.

Overrides:

setEnabled in class JComponent

setDialogParent

public void setDialogParent(Component dialogParent)

Sets the parent of the file chooser dialog that is used internally.

See JFileChooser.showDialog(java.awt.Component, java.lang.String) for details on dialog parents.

showChooser

protected boolean showChooser()

The default implementation shows a JFileChooser.

This method can be overriden in a subclass, so other file choosers can be provided

Returns:

true if a file was successfully selected and set using setFile(File), false otherwise