Package be.gaudry.swing.component
Class BrowseDirectoryPanel
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
be.gaudry.swing.component.BrowseDirectoryPanel
- All Implemented Interfaces:
ILocalized
,IRememberPreferences
,ImageObserver
,MenuContainer
,Serializable
,Accessible
- Since:
- 1.0 2008, 1.0
- Version:
- %I%, %G%
- Author:
- Steph GAUDRY
- See Also:
- 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
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
ConstructorDescriptionConstructs a BrowseDirectoryPanel with all default values : prefStorageName : "default" directoryPath : user home directory storageType :LOCAL
BrowseDirectoryPanel(String prefStorageName)
Constructs a BrowseDirectoryPanel with some default values : directoryPath : user home directory storageType :LOCAL
BrowseDirectoryPanel(String prefStorageName, RememberHelper.StorageType storageType)
Constructs a BrowseDirectoryPanel with some default values : directoryPath : user home directoryBrowseDirectoryPanel(String prefStorageName, String directoryPath, RememberHelper.StorageType storageType)
Constructs a BrowseDirectoryPanel with all values. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds an observer to the set of observers for this object, provided that it is not the same as some observer already in the set.void
Deletes an observer from the set of observers of this object.getPath()
Virtual path used to store data (slashes separated)void
static void
Auto-generated main method to display this JPanel inside a new JFrame.void
void
setFileSelectionMode(int mode)
Sets theJFileChooser
to allow the user to just select files, just select directories, or select both files and directories.void
setFileSelectionMode(int mode, FileNameExtensionFilter filesFilter)
void
Sets localized language The implementation should use aResourceBundle
to load information based on the user'sLocale
, and may observe theLanguageHelper
to update the GUI on Locale switch.void
Sets the directory path and sends a notification to the observersvoid
setPreferencesKey(String key)
Sets the key to store and retrieve the preferred path, and reload preferences corresponding to the new key.
Be careful : modifying this virtual path involves storing data in another virtual location in the property filevoid
setPreferredPath(String preferredPath, boolean onlyIfExists)
Gives a preferred path if the path cannot be loadedvoid
setStorageType(RememberHelper.StorageType storageType)
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, 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, 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
Field Details
-
PROP_PATH
- See Also:
- Constant Field Values
-
-
Constructor Details
-
BrowseDirectoryPanel
public BrowseDirectoryPanel()Constructs a BrowseDirectoryPanel with all default values :- prefStorageName : "default"
- directoryPath : user home directory
- storageType :
LOCAL
-
BrowseDirectoryPanel
Constructs a BrowseDirectoryPanel with some default values :- directoryPath : user home directory
- storageType :
LOCAL
- Parameters:
prefStorageName
- Key used to retrieve or save the directory path with theRememberHelper
helper class.
-
BrowseDirectoryPanel
Constructs a BrowseDirectoryPanel with some default values :- directoryPath : user home directory
- Parameters:
prefStorageName
- Key used to retrieve or save the directory path with theRememberHelper
helper class.storageType
- the preferred data path type (LOCAL
orROAMING
).
-
BrowseDirectoryPanel
public BrowseDirectoryPanel(String prefStorageName, String directoryPath, RememberHelper.StorageType storageType)Constructs a BrowseDirectoryPanel with all values.- Parameters:
prefStorageName
- Key used to retrieve or save the directory path with theRememberHelper
helper class.directoryPath
- Value defined as default directory path with theRememberHelper
helper class.storageType
- the preferred data path type (LOCAL
orROAMING
).
-
-
Method Details
-
getStorageType
- Returns:
- the storageType
-
setStorageType
- Parameters:
storageType
- the storageType to set
-
getPath
- Returns:
- the path
-
setPreferredPath
Gives a preferred path if the path cannot be loaded- Parameters:
preferredPath
- the path to setonlyIfExists
- do not set the preferred path if the path doesn't exists
-
setPath
Sets the directory path and sends a notification to the observers- Parameters:
path
- the path to set
-
getPreferencesKey
Virtual path used to store data (slashes separated)- Returns:
- the preferencesKey
-
setPreferencesKey
Sets the key to store and retrieve the preferred path, and reload preferences corresponding to the new key.
Be careful : modifying this virtual path involves storing data in another virtual location in the property file- Parameters:
key
- thepreferencesKey
to set
-
setFileSelectionMode
public void setFileSelectionMode(int mode)Sets theJFileChooser
to allow the user to just select files, just select directories, or select both files and directories. The default isJFilesChooser.FILES_ONLY
.- Parameters:
mode
- the type of files to be displayed:- JFileChooser.FILES_ONLY
- JFileChooser.DIRECTORIES_ONLY
- JFileChooser.FILES_AND_DIRECTORIES
- Throws:
IllegalArgumentException
- ifmode
is an illegal file selection mode- See Also:
JFileChooser.getFileSelectionMode()
-
setFileSelectionMode
-
loadPreferences
public void loadPreferences()- Specified by:
loadPreferences
in interfaceIRememberPreferences
-
savePreferences
public void savePreferences()- Specified by:
savePreferences
in interfaceIRememberPreferences
-
addObserver
Adds an observer to the set of observers for this object, provided that it is not the same as some observer already in the set. The order in which notifications will be delivered to multiple observers is not specified. See the class comment.- Parameters:
pcl
- an observer to be added.- Throws:
NullPointerException
- if the parameter o is null.
-
deleteObserver
Deletes an observer from the set of observers of this object. Passingnull
to this method will have no effect.- Parameters:
pcl
- the observer to be deleted.
-
main
Auto-generated main method to display this JPanel inside a new JFrame. -
setLanguage
public void setLanguage()Description copied from interface:ILocalized
Sets localized language The implementation should use aResourceBundle
to load information based on the user'sLocale
, and may observe theLanguageHelper
to update the GUI on Locale switch.- Specified by:
setLanguage
in interfaceILocalized
-