Package org.apache.uima.tools.util.gui

Class FileSelector

  • All Implemented Interfaces:
    java.awt.event.FocusListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible
    public class FileSelector
extends javax.swing.JPanel
implements java.awt.event.FocusListener
    Composite component to allow file or directory input or selection. Comprises a JTextField, and a browse button associated with a JFileChooser.
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      (package private) static class  FileSelector.BrowseButton
      The Class BrowseButton.

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

        javax.swing.JPanel.AccessibleJPanel

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

        javax.swing.JComponent.AccessibleJComponent

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

        java.awt.Container.AccessibleAWTContainer

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

        java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private FileSelector.BrowseButton browseButton
      The browse button.
      private javax.swing.JTextField field
      The field.
      private javax.swing.JFileChooser fileChooser
      Note that fileChooser is created lazily, to address issue UIMA-231.
      private java.lang.String fileChooserTitle
      The file chooser title.
      private FileSelectorListener fileSelectorListener
      The file selector listener.
      private javax.swing.filechooser.FileFilter filter
      The filter.
      private java.io.File initialDir
      The initial dir.
      private java.lang.String previousValue
      The previous value.
      private int selectionMode
      The selection mode.
      private static long serialVersionUID
      The Constant serialVersionUID.
      private javax.swing.JComponent source
      The source.

      • Fields inherited from class javax.swing.JComponent

        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

        accessibleContext, 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

      Constructors 
      Constructor Description
      FileSelector​(java.lang.String initialValue, java.lang.String fileChooserTitle, int selectionMode)
      Creates a new FileSelector.
      FileSelector​(java.lang.String initialValue, java.lang.String fileChooserTitle, int selectionMode, java.io.File currentDir)
      Creates a new FileSelector.
      FileSelector​(java.lang.String initialValue, java.lang.String fileChooserTitle, int selectionMode, java.io.File currentDir, javax.swing.filechooser.FileFilter filter)
      Creates a new FileSelector.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addFileSelectorListener​(FileSelectorListener fileSelectorListener, javax.swing.JComponent source)
      Adds the file selector listener.
      void clear()
      Clear.
      void focusGained​(java.awt.event.FocusEvent aEvent)  
      void focusLost​(java.awt.event.FocusEvent aEvent)  
      protected javax.swing.JFileChooser getFileChooser()
      Get the File Chooser user when the Browse button is clicked.
      java.lang.String getSelected()
      Gets the selected.
      void setEnabled​(boolean onOff)  
      void setSelected​(java.lang.String s)
      Sets the selected.

      • 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, 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

      • 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, 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, 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, transferFocusBackward, transferFocusUpCycle

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • serialVersionUID

        private static final long serialVersionUID
        The Constant serialVersionUID.
        See Also:
        Constant Field Values

      • field

        private javax.swing.JTextField field
        The field.

      • fileChooser

        private javax.swing.JFileChooser fileChooser
        Note that fileChooser is created lazily, to address issue UIMA-231. Apparently calls to JFileChooser.setCurrentDirectory aren't reliable before the file chooser has been shown.

      • source

        private javax.swing.JComponent source
        The source.

      • fileSelectorListener

        private FileSelectorListener fileSelectorListener
        The file selector listener.

      • previousValue

        private java.lang.String previousValue
        The previous value.

      • initialDir

        private java.io.File initialDir
        The initial dir.

      • fileChooserTitle

        private java.lang.String fileChooserTitle
        The file chooser title.

      • selectionMode

        private int selectionMode
        The selection mode.

      • filter

        private javax.swing.filechooser.FileFilter filter
        The filter.

    • Constructor Detail

      • FileSelector

        public FileSelector​(java.lang.String initialValue,
                    java.lang.String fileChooserTitle,
                    int selectionMode)
        Creates a new FileSelector.
        Parameters:
        initialValue - filename initially displayed in the text field
        fileChooserTitle - title of the JFileChooser launched when the user clicks Browse
        selectionMode - Can be either JFileChooser.FILES_ONLY, JFileChooser.DIRECTORIES_ONLY or JFileChooser.FILES_AND_DIRECTORIES

      • FileSelector

        public FileSelector​(java.lang.String initialValue,
                    java.lang.String fileChooserTitle,
                    int selectionMode,
                    java.io.File currentDir)
        Creates a new FileSelector.
        Parameters:
        initialValue - filename initially displayed in the text field
        fileChooserTitle - title of the JFileChooser launched when the user clicks Browse
        selectionMode - Can be either JFileChooser.FILES_ONLY, JFileChooser.DIRECTORIES_ONLY or JFileChooser.FILES_AND_DIRECTORIES
        currentDir - default directory for the file chooser

      • FileSelector

        public FileSelector​(java.lang.String initialValue,
                    java.lang.String fileChooserTitle,
                    int selectionMode,
                    java.io.File currentDir,
                    javax.swing.filechooser.FileFilter filter)
        Creates a new FileSelector.
        Parameters:
        initialValue - filename initially displayed in the text field
        fileChooserTitle - title of the JFileChooser launched when the user clicks Browse
        selectionMode - Can be either JFileChooser.FILES_ONLY, JFileChooser.DIRECTORIES_ONLY or JFileChooser.FILES_AND_DIRECTORIES
        currentDir - default directory for the file chooser
        filter - file filter used by the file chooser

    • Method Detail

      • addFileSelectorListener

        public void addFileSelectorListener​(FileSelectorListener fileSelectorListener,
                                    javax.swing.JComponent source)
        Adds the file selector listener.
        Parameters:
        fileSelectorListener - the file selector listener
        source - the source

      • getSelected

        public java.lang.String getSelected()
        Gets the selected.
        Returns:
        the selected

      • setSelected

        public void setSelected​(java.lang.String s)
        Sets the selected.
        Parameters:
        s - the new selected

      • setEnabled

        public void setEnabled​(boolean onOff)
        Overrides:
        setEnabled in class javax.swing.JComponent

      • clear

        public void clear()
        Clear.

      • focusGained

        public void focusGained​(java.awt.event.FocusEvent aEvent)
        Specified by:
        focusGained in interface java.awt.event.FocusListener

      • focusLost

        public void focusLost​(java.awt.event.FocusEvent aEvent)
        Specified by:
        focusLost in interface java.awt.event.FocusListener

      • getFileChooser

        protected javax.swing.JFileChooser getFileChooser()
        Get the File Chooser user when the Browse button is clicked. This is lazily created when needed, because of issue UIMA-231.
        Returns:
        the file chooser