proper.gui.core.text
Class FileTextField

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by proper.gui.core.text.ProperTextField
                      extended by proper.gui.core.text.FileTextField
All Implemented Interfaces:
java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

public class FileTextField
extends ProperTextField

This Panel represents a combination of a JTextField and a Button with which you can open a FileChooser-Dialog.

Version:
$Revision: 1.2 $
Author:
FracPete
See Also:
SimpleFileFilter, FileChooser, FileFilter, Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Field Summary
 
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, 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
FileTextField(ProperFrame parent)
          initializes the field with a standard size
FileTextField(ProperFrame parent, int columns)
          initializes the field with the given size
FileTextField(ProperFrame parent, java.lang.String text, int columns)
          initializes the field the given text and the given size
FileTextField(ProperFrame parent, java.lang.String text, int columns, boolean useIcon)
          initializes the field the given text and the given size
 
Method Summary
 void addChoosableFileFilter(javax.swing.filechooser.FileFilter filter)
          Adds a filter to the list of user choosable file filters.
 void addCurrentDirChangeListener(CurrentDirChangeListener l)
          adds the given listener to the notify list
 javax.swing.filechooser.FileFilter getAcceptAllFileFilter()
          Returns the AcceptAll file filter.
 javax.swing.filechooser.FileFilter[] getChoosableFileFilters()
          Gets the list of user choosable file filters.
 java.io.File getCurrentDirectory()
          returns the current directory of the textfield
 java.lang.String getFile()
          returns the file
 javax.swing.filechooser.FileFilter getFileFilter()
          Returns the currently selected file filter.
 java.lang.String getFiles()
          returns the files (comma separated list)
 boolean isAcceptAllFileFilterUsed()
          Returns whether the AcceptAll FileFilter is used.
 boolean isMultiSelectionEnabled()
          Returns true if multiple files can be selected.
 boolean removeChoosableFileFilter(javax.swing.filechooser.FileFilter f)
          Removes a filter from the list of user choosable file filters.
 boolean removeCurrentDirChangeListener(CurrentDirChangeListener l)
          removes the given listener from the notify list
 void resetChoosableFileFilters()
          Resets the choosable file filter list to its starting state.
 void setAcceptAllFileFilterUsed(boolean b)
          Determines whether the AcceptAll FileFilter is used as an available choice in the choosable filter list.
 void setCurrentDirectory(java.io.File dir)
          sets the current directory for the textfield
 void setFile(java.lang.String file)
          sets the file (if possible)
 void setFileFilter(javax.swing.filechooser.FileFilter filter)
          Sets the current file filter.
 void setFiles(java.lang.String filelist)
          sets the files (comma separated list, if possible)
 void setMultiSelectionEnabled(boolean b)
          Sets the file chooser to allow multiple file selections.
 
Methods inherited from class proper.gui.core.text.ProperTextField
actionPerformed, getColumns, getDocument, getParentFrame, getText, getToolTipText, getUseIcon, setColumns, setText, setToolTipText
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, 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, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, 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, 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
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FileTextField

public FileTextField(ProperFrame parent)
initializes the field with a standard size

Parameters:
parent - the parent frame

FileTextField

public FileTextField(ProperFrame parent,
                     int columns)
initializes the field with the given size

Parameters:
parent - the parent frame
columns - the size of the textfield

FileTextField

public FileTextField(ProperFrame parent,
                     java.lang.String text,
                     int columns)
initializes the field the given text and the given size

Parameters:
parent - the parent frame
text - the text to display initially
columns - the size of the textfield

FileTextField

public FileTextField(ProperFrame parent,
                     java.lang.String text,
                     int columns,
                     boolean useIcon)
initializes the field the given text and the given size

Parameters:
parent - the parent frame
text - the text to display initially
columns - the size of the textfield
useIcon - whether to display an Icon instead of "..."
Method Detail

addCurrentDirChangeListener

public void addCurrentDirChangeListener(CurrentDirChangeListener l)
adds the given listener to the notify list


removeCurrentDirChangeListener

public boolean removeCurrentDirChangeListener(CurrentDirChangeListener l)
removes the given listener from the notify list

Returns:
returns TRUE if the listener was in the list

getFile

public java.lang.String getFile()
returns the file


setFile

public void setFile(java.lang.String file)
sets the file (if possible)


getFiles

public java.lang.String getFiles()
returns the files (comma separated list)


setFiles

public void setFiles(java.lang.String filelist)
sets the files (comma separated list, if possible)


setMultiSelectionEnabled

public void setMultiSelectionEnabled(boolean b)
Sets the file chooser to allow multiple file selections.


isMultiSelectionEnabled

public boolean isMultiSelectionEnabled()
Returns true if multiple files can be selected.


setFileFilter

public void setFileFilter(javax.swing.filechooser.FileFilter filter)
Sets the current file filter.


getFileFilter

public javax.swing.filechooser.FileFilter getFileFilter()
Returns the currently selected file filter.


addChoosableFileFilter

public void addChoosableFileFilter(javax.swing.filechooser.FileFilter filter)
Adds a filter to the list of user choosable file filters.


getAcceptAllFileFilter

public javax.swing.filechooser.FileFilter getAcceptAllFileFilter()
Returns the AcceptAll file filter.


getChoosableFileFilters

public javax.swing.filechooser.FileFilter[] getChoosableFileFilters()
Gets the list of user choosable file filters.


isAcceptAllFileFilterUsed

public boolean isAcceptAllFileFilterUsed()
Returns whether the AcceptAll FileFilter is used.


removeChoosableFileFilter

public boolean removeChoosableFileFilter(javax.swing.filechooser.FileFilter f)
Removes a filter from the list of user choosable file filters.


resetChoosableFileFilters

public void resetChoosableFileFilters()
Resets the choosable file filter list to its starting state.


setAcceptAllFileFilterUsed

public void setAcceptAllFileFilterUsed(boolean b)
Determines whether the AcceptAll FileFilter is used as an available choice in the choosable filter list.


setCurrentDirectory

public void setCurrentDirectory(java.io.File dir)
sets the current directory for the textfield


getCurrentDirectory

public java.io.File getCurrentDirectory()
returns the current directory of the textfield