com.portal.ctrl

Class DirectoryChooser

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

com.portal.ctrl.DirectoryChooser

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable

public class DirectoryChooser
extends JComponent

DirectoryChooser provides a simple mechanism for the user to choose a directory. The following pops up a directory chooser in the users home directory DirectoryChooser chooser = new DirectoryChooser(); int returnVal = chooser.showDialog(parent); if(returnVal == DirectoryChooser.APPROVE_OPTION) { System.out.println("You choosed directory : " + chooser.getSelectedFile().getName()); }

Author:

Bhupesh Jadhav

See Also:

Serialized Form

Nested Class Summary

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

Modifier and Type	Field and Description
static int	APPROVE_OPTION
protected JButton	approveJb
static int	CANCEL_OPTION
protected JButton	cancelJB
protected JDialog	dialog
protected JScrollPane	directoryPane
protected JTree	directoryTree
protected JLabel	driveLb
protected JComboBox	drivesJcb
protected JTextField	folderJt
protected JLabel	folderLb
protected int	option
protected JPanel	panel

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 and Description
DirectoryChooser() Construct a DirectoryChooser pointing to the last selected directory if any else to the users home directory
DirectoryChooser(String currentDirectoryPath) Constructs a DirectoryChooser using the given path.

Method Summary

Modifier and Type	Method and Description
int	getApproveButtonMnemonic() Gets the Mnemonic in Approve Button
String	getApproveButtonText() Gets the text used in Approve Button
String	getApproveButtonToolTipText() Gets the tooltip used in ApproveButton
static File	getLastDirectory()
protected TreePath	getPath(File file)
File	getSelectedDirectory() Gets the selected directory as an File object
void	setApproveButtonMnemonic(char mnemonic) Sets the Mnemonic used in Approve Button
void	setApproveButtonText(String approveButtonText) Sets the Approve Button text
void	setApproveButtonToolTipText(String toolTipText) Sets the tooltip used in the ApproveButton
void	setDialogTitle(String title) Sets the DirectoryChooser dialog title
void	setSelectedDirectory(File file) Sets the selected directory
int	showDialog(Component parent) Display the dialog

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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, 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, updateUI

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

APPROVE_OPTION

public static int APPROVE_OPTION

CANCEL_OPTION

public static int CANCEL_OPTION

dialog

protected JDialog dialog

folderLb

protected JLabel folderLb

folderJt

protected JTextField folderJt

directoryPane

protected JScrollPane directoryPane

approveJb

protected JButton approveJb

cancelJB

protected JButton cancelJB

driveLb

protected JLabel driveLb

drivesJcb

protected JComboBox drivesJcb

directoryTree

protected JTree directoryTree

option

protected int option

panel

protected JPanel panel

Constructor Detail

DirectoryChooser

public DirectoryChooser()
                 throws MissingResourceException

Construct a DirectoryChooser pointing to the last selected directory if any else to the users home directory

Throws:

MissingResourceException

DirectoryChooser

public DirectoryChooser(String currentDirectoryPath)
                 throws MissingResourceException

Constructs a DirectoryChooser using the given path. Passing in a null string causes the DirectoryChooser to point to the user's home directory.

Parameters:

String - representing the directory to be selected

Throws:

MissingResourceException

Method Detail

getLastDirectory

public static File getLastDirectory()

Returns:

any previously selected directory as File object

getSelectedDirectory

public File getSelectedDirectory()

Gets the selected directory as an File object

Returns:

selected file

setSelectedDirectory

public void setSelectedDirectory(File file)

Sets the selected directory

Parameters:

File - to be selected

setDialogTitle

public void setDialogTitle(String title)

Sets the DirectoryChooser dialog title

Parameters:

String - title

showDialog

public int showDialog(Component parent)

Display the dialog

Parameters:

parent - - the parent component of the dialog, can be null

Returns:

the return state of the file chooser on popdown: DirectoryChooser.CANCEL_OPTION DirectoryChooser.APPROVE_OPTION

setApproveButtonToolTipText

public void setApproveButtonToolTipText(String toolTipText)

Sets the tooltip used in the ApproveButton

Parameters:

Tool - tip text

getApproveButtonToolTipText

public String getApproveButtonToolTipText()

Gets the tooltip used in ApproveButton

Returns:

Tool tip text

setApproveButtonMnemonic

public void setApproveButtonMnemonic(char mnemonic)

Sets the Mnemonic used in Approve Button

Parameters:

char -

getApproveButtonMnemonic

public int getApproveButtonMnemonic()

Gets the Mnemonic in Approve Button

Returns:

mnemonic

setApproveButtonText

public void setApproveButtonText(String approveButtonText)

Sets the Approve Button text

Parameters:

approve - button text

getApproveButtonText

public String getApproveButtonText()

Gets the text used in Approve Button

Returns:

approve button text

getPath

protected TreePath getPath(File file)

Returns:

TreePath of the node identified by File "file"