com.antelmann.util.gui
Class JFileField

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              com.antelmann.util.gui.JFileField

All Implemented Interfaces:

EditableComponent, ValueRetriever<File>, ValueSetter<File>, ImageObserver, MenuContainer, Serializable

public class JFileField
extends JComponent
implements EditableComponent, ValueRetriever<File>, ValueSetter<File>

A text component that denotes a file path; supports mouse drops from file system and provides a convenient JFileChooser. To be notified for changes, best use a DocumentListener on the JTextField component.

Author:

Holger Antelmann

See Also:

JFileChooser, Serialized Form

Nested Class Summary

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

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

Field Summary

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

JFileField()

JFileField(File initialFile)

JFileField(File initialFile, int columns)

JFileField(File initialFile, JTextField field)

JFileField(int columns)

JFileField(JTextField field)

Method Summary

void	addChoosableFileFilter(FileFilter filter)
File	getBaseDir()
File	getFile() returns the file or null if the field is null or empty
FileFilter	getFileFilter()
int	getFileSelectionMode()
JFileChooser	getJFileChooser() provides access to the chooser of the component
JTextField	getJTextField() provides access to the text field of the component
File	getRelevantValue() returns the relevant value for this instance at the time of calling
boolean	isEditable()
void	setBaseDir(File baseDir) if set to a non-null vaule, the text will show the relative path to this given dir
void	setEditable(boolean flag)
void	setEnabled(boolean flag)
boolean	setFile(File file) returns true only if the file was accepted by the filter and hence the file was actually set; null is always accepted
void	setFileFilter(FileFilter filter)
void	setFileSelectionMode(int mode)
void	setRelevantValue(File file) sets the relevant value for this instance with the given value

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, 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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, 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, updateUI

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

JFileField

public JFileField()

JFileField

public JFileField(int columns)

JFileField

public JFileField(File initialFile)

JFileField

public JFileField(JTextField field)

JFileField

public JFileField(File initialFile,
                  int columns)

JFileField

public JFileField(File initialFile,
                  JTextField field)

Method Detail

setEnabled

public void setEnabled(boolean flag)

Overrides:

setEnabled in class JComponent

isEditable

public boolean isEditable()

Specified by:

isEditable in interface EditableComponent

setEditable

public void setEditable(boolean flag)

Specified by:

setEditable in interface EditableComponent

setFileSelectionMode

public void setFileSelectionMode(int mode)

Parameters:

mode - the type of files to be chosen:

• JFileChooser.FILES_ONLY
• JFileChooser.DIRECTORIES_ONLY
• JFileChooser.FILES_AND_DIRECTORIES

Throws:

IllegalArgumentException - if mode is illegal

See Also:

JFileChooser

getFileSelectionMode

public int getFileSelectionMode()

Returns:

the type of files to be chosen:

• JFileChooser.FILES_ONLY
• JFileChooser.DIRECTORIES_ONLY
• JFileChooser.FILES_AND_DIRECTORIES

See Also:

JFileChooser

addChoosableFileFilter

public void addChoosableFileFilter(FileFilter filter)

setFileFilter

public void setFileFilter(FileFilter filter)

getFileFilter

public FileFilter getFileFilter()

getRelevantValue

public File getRelevantValue()

Description copied from interface: ValueRetriever

returns the relevant value for this instance at the time of calling

Specified by:

getRelevantValue in interface ValueRetriever<File>

setRelevantValue

public void setRelevantValue(File file)
                      throws IllegalArgumentException

Description copied from interface: ValueSetter

sets the relevant value for this instance with the given value

Specified by:

setRelevantValue in interface ValueSetter<File>

Throws:

IllegalArgumentException

getFile

public File getFile()

returns the file or null if the field is null or empty

setFile

public boolean setFile(File file)

returns true only if the file was accepted by the filter and hence the file was actually set; null is always accepted

getBaseDir

public File getBaseDir()

setBaseDir

public void setBaseDir(File baseDir)

if set to a non-null vaule, the text will show the relative path to this given dir

getJFileChooser

public JFileChooser getJFileChooser()

provides access to the chooser of the component

getJTextField

public JTextField getJTextField()

provides access to the text field of the component