jas2.util

Class OpenLocalFilePanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

jas2.util.OpenLocalFilePanel

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.ChangeListener

public class OpenLocalFilePanel
extends javax.swing.JPanel
implements java.awt.event.ActionListener, javax.swing.event.ChangeListener

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.

• The text field is in fact a JASEditableComboBox, so recently selected files are available on a drop-down list. The drop-down list is stored in the Application's UserProperties object according to a key that you specify for the constructor.
• A "Browse..." button opens a file dialog so that the user can select a file. The object will remember the last directory used according to the given key and open the dialog to that directory the next time it is opened.
• Optionally, you can have a "Preview..." button that opens a dialog showing the beginning of the file.
• Optionally, you can have GZip option, where the user can select whether the file in in GZip format.
• If you add an ActionListener to this class, you will receive ActionEvents from the JASEditableComboBox. An ActionEvent will be sent only when the 'Enter' button is clicked in the text field. Similarly, if you add a ChangeListener to this class, you will receive ChangeEvents from the JASEditableComboBox. A ChangeEvent will be sent every time the visible text changes.

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.

See Also:

JASEditableComboBox, UserProperties, getText(), saveState(), Serialized Form

Nested Class Summary

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Component.BaselineResizeBehavior

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

Constructors

Constructor and Description
OpenLocalFilePanel(boolean includePreviewButton, boolean includeGZIP, java.lang.String key) Creates an OpenLocalFilePanel component that you can add to a container.
OpenLocalFilePanel(boolean includePreviewButton, boolean includeGZIP, java.lang.String key, javax.swing.filechooser.FileFilter filter) Creates an OpenLocalFilePanel component that you can add to a container.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) This method is public as an implelentation side effect; do not call.
void	addActionListener(java.awt.event.ActionListener al) The given ActionListener will be notified when the "Enter" button is clicked in the file name text field.
void	addChangeListener(javax.swing.event.ChangeListener cl) The given ChangeListener will be notified when the visible text changes in the file name field.
boolean	getGZIPed() Returns whether the user has selected the GZip option.
java.lang.String	getText() Returns the file name showing in the text field.
void	saveState() Includes the currently selected file name in the drop-down list for the next time this class is instantiated.
void	stateChanged(javax.swing.event.ChangeEvent e) This method is public as an implelentation side effect; do not call.

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, getBaseline, getBaselineResizeBehavior, 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, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, setToolTipText, 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, 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, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OpenLocalFilePanel

public OpenLocalFilePanel(boolean includePreviewButton,
                          boolean includeGZIP,
                          java.lang.String key,
                          javax.swing.filechooser.FileFilter filter)

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(boolean includePreviewButton,
                          boolean includeGZIP,
                          java.lang.String key)

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

addChangeListener

public void addChangeListener(javax.swing.event.ChangeListener cl)

The given ChangeListener will be notified when the visible text changes in the file name field.

addActionListener

public void addActionListener(java.awt.event.ActionListener al)

The given ActionListener will be notified when the "Enter" button is clicked in the file name text field.

stateChanged

public final void stateChanged(javax.swing.event.ChangeEvent e)

This method is public as an implelentation side effect; do not call.

Specified by:

stateChanged in interface javax.swing.event.ChangeListener

actionPerformed

public final void actionPerformed(java.awt.event.ActionEvent e)

This method is public as an implelentation side effect; do not call.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

getText

public java.lang.String getText()

Returns the file name showing in the text field.

Returns:

the selected file name

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 JASEditableComboBox that is shown on the panel.

See Also:

JASEditableComboBox, JASEditableComboBox.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