org.freehep.jas.util
Class OpenLocalFilePanel

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 org.freehep.jas.util.OpenLocalFilePanel
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible

public class OpenLocalFilePanel
extends JPanel

This class provides a convenient way to get a file name from the user. It is merely a panel with a text field for the file name with some built in convenience items. This panel does not actually open a file for you; it simply provides an easy way to get a file name from the user. Use getText() to get the file name selected.

Be sure to invoke the saveState() method when you are done. This will set include the selected file in the drop-down list for the next time the panel is used.

Author:
Jonas Gifford, Tony Johnson
See Also:
getText(), saveState(), 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.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
OpenLocalFilePanel(String key, boolean includePreviewButton, boolean includeGZIP)
          Creates an OpenLocalFilePanel component that you can add to a container.
OpenLocalFilePanel(String key, FileFilter filter, boolean includePreviewButton, boolean includeGZIP)
          Creates an OpenLocalFilePanel component that you can add to a container.
 
Method Summary
 void addActionListener(ActionListener al)
          The given ActionListener will be notified when the "Enter" button is clicked in the file name text field.
 void addChangeListener(ChangeListener cl)
          The given ChangeListener will be notified when the visible text changes in the file name field.
 File getFile()
           
 boolean getGZIPed()
          Returns whether the user has selected the GZip option.
 String getText()
          Returns the file name showing in the text field.
 boolean isFileSelected()
           
 void removeActionListener(ActionListener al)
           
 void removeChangeListener(ChangeListener cl)
           
 void saveState()
          Includes the currently selected file name in the drop-down list for the next time this class is instantiated.
 
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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, setEnabled, 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

OpenLocalFilePanel

public OpenLocalFilePanel(String key,
                          FileFilter filter,
                          boolean includePreviewButton,
                          boolean includeGZIP)
Creates an OpenLocalFilePanel component that you can add to a container.

Parameters:
includePreviewButton - whether a "Preview" button should be shown
includeGZIP - whether the GZip option should be shown
key - the key used to store the drop-down items and the last directory for the browse dialog
filter - sets a FileFilter for the browse dialog

OpenLocalFilePanel

public OpenLocalFilePanel(String key,
                          boolean includePreviewButton,
                          boolean includeGZIP)
Creates an OpenLocalFilePanel component that you can add to a container.

Parameters:
includePreviewButton - whether a "Preview" button should be shown
includeGZIP - whether the GZip option should be shown
key - the key used to store the drop-down items and the last directory for the browse dialog
Method Detail

isFileSelected

public boolean isFileSelected()

addChangeListener

public void addChangeListener(ChangeListener cl)
The given ChangeListener will be notified when the visible text changes in the file name field.


removeChangeListener

public void removeChangeListener(ChangeListener cl)

addActionListener

public void addActionListener(ActionListener al)
The given ActionListener will be notified when the "Enter" button is clicked in the file name text field.


removeActionListener

public void removeActionListener(ActionListener al)

getText

public String getText()
Returns the file name showing in the text field.

Returns:
the selected file name

getFile

public File getFile()

saveState

public void saveState()
Includes the currently selected file name in the drop-down list for the next time this class is instantiated. It merely invokes the saveState() method in the RecentItemTextField that is shown on the panel.

See Also:
RecentItemTextField, RecentItemTextField.saveState()

getGZIPed

public boolean getGZIPed()
Returns whether the user has selected the GZip option. If the GZip option was not available (i.e., in the constructor the parameter includeGZIP was false) then it will return false.

Returns:
whether the GZip option was selected


Copyright © 2013. All Rights Reserved.