com.huguesjohnson.ui
Class FileBrowsePanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.huguesjohnson.ui.FileBrowsePanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class FileBrowsePanel
extends javax.swing.JPanel

Panel to browse for a file.

Author:

Hugues Johnson

See Also:

Serialized Form

Nested Class Summary

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

static boolean

DEFAULT_SHOW_BROWSE_BUTTON Default value for showing the browse button.

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

FileBrowsePanel(java.lang.String title)
Creates a new FileBrowsePanel, accepts (*.*).

FileBrowsePanel(java.lang.String title, boolean showBrowseButton)
Creates a new FileBrowsePanel, accepts (*.*).

FileBrowsePanel(java.lang.String title, javax.swing.filechooser.FileFilter filter)
Creates a new FileBrowsePanel with a single file filter.

FileBrowsePanel(java.lang.String title, javax.swing.filechooser.FileFilter[] filters)
Creates a new FileBrowsePanel.

FileBrowsePanel(java.lang.String title, javax.swing.filechooser.FileFilter[] filters, boolean showBrowseButton)
Creates a new FileBrowsePanel.

FileBrowsePanel(java.lang.String title, javax.swing.filechooser.FileFilter filter, boolean showBrowseButton)
Creates a new FileBrowsePanel with a single file filter.

Method Summary

boolean	browse() Opens a JFileChooser with the supported filters.
void	buttonBrowseActionPerformed() Action executed when the browse button is pressed.
void	clear() Clears the "Path:" text field.
java.lang.String	getDirectory() Returns the full directory of the current path, no file name.
java.lang.String	getFilePath() Returns the file path in the "Path:" text field.
void	onBrowseComplete() Event that fires after a browse has completed successfully.
void	setFilePath(java.lang.String filePath) Sets the "Path:" text field.
void	setFilters(javax.swing.filechooser.FileFilter filter) Sets filters to a single filter.
void	setFilters(javax.swing.filechooser.FileFilter[] filters) Sets the file filters.
void	setTitle(java.lang.String title) Sets the title on the panel border.

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

Field Detail

DEFAULT_SHOW_BROWSE_BUTTON

public static final boolean DEFAULT_SHOW_BROWSE_BUTTON

Default value for showing the browse button.

See Also:

Constant Field Values

Constructor Detail

FileBrowsePanel

public FileBrowsePanel(java.lang.String title,
                       javax.swing.filechooser.FileFilter[] filters)

Creates a new FileBrowsePanel.

Parameters:

title - The title of the panel.

filters - A list of file filters to accept.

FileBrowsePanel

public FileBrowsePanel(java.lang.String title,
                       javax.swing.filechooser.FileFilter filter)

Creates a new FileBrowsePanel with a single file filter.

Parameters:

title - The title of the panel.

filter - The file filter to accept.

FileBrowsePanel

public FileBrowsePanel(java.lang.String title,
                       javax.swing.filechooser.FileFilter[] filters,
                       boolean showBrowseButton)

Creates a new FileBrowsePanel.

Parameters:

title - The title of the panel.

filters - A list of file filters to accept.

showBrowseButton - Whether or not to show the browse button.

FileBrowsePanel

public FileBrowsePanel(java.lang.String title,
                       javax.swing.filechooser.FileFilter filter,
                       boolean showBrowseButton)

Creates a new FileBrowsePanel with a single file filter.

Parameters:

title - The title of the panel.

filter - The file filter to accept.

showBrowseButton - Whether or not to show the browse button.

FileBrowsePanel

public FileBrowsePanel(java.lang.String title)

Creates a new FileBrowsePanel, accepts (*.*).

Parameters:

title - The title of the panel.

FileBrowsePanel

public FileBrowsePanel(java.lang.String title,
                       boolean showBrowseButton)

Creates a new FileBrowsePanel, accepts (*.*).

Parameters:

title - The title of the panel.

showBrowseButton - Whether or not to show the browse button.

Method Detail

buttonBrowseActionPerformed

public final void buttonBrowseActionPerformed()

Action executed when the browse button is pressed. Opens a JFileChooser and calls onBrowseComplete() if a file was selected.

browse

public boolean browse()

Opens a JFileChooser with the supported filters.

Returns:

True if a file was selected and the selected file is not the same as the file currently listed in the "Path:" text field.

onBrowseComplete

public void onBrowseComplete()

Event that fires after a browse has completed successfully. No method implementation, not abstract because overriding this is optional.

setFilePath

public void setFilePath(java.lang.String filePath)

Sets the "Path:" text field.

Parameters:

filePath - The new path.

getFilePath

public java.lang.String getFilePath()

Returns the file path in the "Path:" text field.

Returns:

Path in the text field.

getDirectory

public java.lang.String getDirectory()

Returns the full directory of the current path, no file name.

Returns:

The full directory of the current path, no file name.

clear

public void clear()

Clears the "Path:" text field.

setFilters

public void setFilters(javax.swing.filechooser.FileFilter[] filters)

Sets the file filters.

Parameters:

filters - The new filters to use.

setFilters

public void setFilters(javax.swing.filechooser.FileFilter filter)

Sets filters to a single filter.

Parameters:

filter - The single filter to use.

setTitle

public void setTitle(java.lang.String title)

Sets the title on the panel border.

Parameters:

title - The new title for the panel border.