com.googlecode.jfilechooserbookmarks

Class AbstractBookmarksPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.googlecode.jfilechooserbookmarks.gui.BasePanel

com.googlecode.jfilechooserbookmarks.AbstractBookmarksPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

CustomHandler.CustomFileChooserBookmarksPanel, DefaultBookmarksPanel

public abstract class AbstractBookmarksPanel
extends BasePanel

Panel for bookmarking directories in a JFileChooser.

You can customize the panel by implementing the newFactory() method, returning a custom factory class instance.

Version:

$Revision: 8361 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

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

Modifier and Type	Field and Description
protected JButton	m_ButtonAdd the button for adding a bookmark.
protected JButton	m_ButtonCopy the button for copying the current directory.
protected JButton	m_ButtonMoveDown the button for moving a bookmark down.
protected JButton	m_ButtonMoveUp the button for moving a bookmark up.
protected JButton	m_ButtonPaste the button for pasting the directory from the clipboard.
protected JButton	m_ButtonRemove the button for remove a bookmark.
protected PropertyChangeListener	m_DirChangeListener the listener for directory changes.
protected AbstractFactory	m_Factory the factor to use.
protected AbstractIconLoader	m_IconLoader the icon loader to use.
protected BaseList	m_ListBookmarks the list of bookmarks.
protected DefaultListModel	m_ModelBookmarks the list model with the bookmarks.
protected JFileChooser	m_Owner the owner.
protected JPanel	m_PanelButtons the panel for the buttons.
protected boolean	m_SkipDirectoryChanges whether to skip changes to current directory.

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
AbstractBookmarksPanel()

Method Summary

Modifier and Type	Method and Description
protected void	addBookmark() Adds a bookmark, if possible.
protected void	copyCurrentDirToClipboard() Copies the current directory to the clipboard.
protected Bookmark	createUniqueBookmark(Bookmark bookmark, DefaultListModel model) Ensures that the bookmark has a unique name in the model.
protected void	finishInit() Finishes up the initialization.
AbstractBookmarksManager	getBookmarksManger() Returns the bookmarks manager to use.
JFileChooser	getOwner() Returns the owner.
protected JPopupMenu	getPopupMenu(MouseEvent e) Creates a popup menu for the BaseList.
Dimension	getPreferredSize() Returns the preferred size.
protected void	initGUI() Initializes the widgets.
protected void	initialize() Initializes the members.
protected boolean	isValidPath(String dirStr) Checks whether the string represents a valid directory.
protected DefaultListModel	loadBookmarks() Loads all the bookmarks that are currently stored in the properties.
protected abstract AbstractFactory	newFactory() Creates a new instance of the factory.
protected void	pasteCurrentDirFromClipboard() Pastes the current directory from the clipboard.
void	reload() Reloads the bookmarks.
protected void	removeBookmark(int[] indices) Removes one or more bookmarks.
protected void	renameBookmark(int index) Renames the bookmark.
protected boolean	saveBookmarks(DefaultListModel model) Saves all the bookmarks in the properties.
void	setOwner(JFileChooser value) Sets the owner.
protected void	updateButtons() Updates the enabled state of the buttons.

Methods inherited from class com.googlecode.jfilechooserbookmarks.gui.BasePanel

afterHide, afterShow, beforeHide, beforeShow, closeParent, getParentDialog, getParentFrame, getParentInternalFrame, getParentTitle, main, printErrorMessage, printException, setParentTitle, setVisible

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

m_Owner

protected JFileChooser m_Owner

the owner.

m_ListBookmarks

protected BaseList m_ListBookmarks

the list of bookmarks.

m_ModelBookmarks

protected DefaultListModel m_ModelBookmarks

the list model with the bookmarks.

m_PanelButtons

protected JPanel m_PanelButtons

the panel for the buttons.

m_ButtonAdd

protected JButton m_ButtonAdd

the button for adding a bookmark.

m_ButtonRemove

protected JButton m_ButtonRemove

the button for remove a bookmark.

m_ButtonMoveUp

protected JButton m_ButtonMoveUp

the button for moving a bookmark up.

m_ButtonMoveDown

protected JButton m_ButtonMoveDown

the button for moving a bookmark down.

m_ButtonCopy

protected JButton m_ButtonCopy

the button for copying the current directory.

m_ButtonPaste

protected JButton m_ButtonPaste

the button for pasting the directory from the clipboard.

m_DirChangeListener

protected PropertyChangeListener m_DirChangeListener

the listener for directory changes.

m_SkipDirectoryChanges

protected boolean m_SkipDirectoryChanges

whether to skip changes to current directory.

m_Factory

protected AbstractFactory m_Factory

the factor to use.

m_IconLoader

protected AbstractIconLoader m_IconLoader

the icon loader to use.

Constructor Detail

AbstractBookmarksPanel

public AbstractBookmarksPanel()

Method Detail

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class BasePanel

initGUI

protected void initGUI()

Initializes the widgets.

Overrides:

initGUI in class BasePanel

finishInit

protected void finishInit()

Finishes up the initialization.

Overrides:

finishInit in class BasePanel

setOwner

public void setOwner(JFileChooser value)

Sets the owner.

Parameters:

value - the new owner

getOwner

public JFileChooser getOwner()

Returns the owner.

Returns:

the owner, null if none set

getPopupMenu

protected JPopupMenu getPopupMenu(MouseEvent e)

Creates a popup menu for the BaseList.

Parameters:

e - the event that triggered the menu

Returns:

the generated menu, null if not available

createUniqueBookmark

protected Bookmark createUniqueBookmark(Bookmark bookmark,
                                        DefaultListModel model)

Ensures that the bookmark has a unique name in the model.

Parameters:

bookmark - the initial bookmark

model - the model with bookmarks

Returns:

the (potentially) updated bookmark

addBookmark

protected void addBookmark()

Adds a bookmark, if possible.

removeBookmark

protected void removeBookmark(int[] indices)

Removes one or more bookmarks.

Parameters:

indices - the indices to remove

renameBookmark

protected void renameBookmark(int index)

Renames the bookmark.

Parameters:

index - the index of the bookmark to rename

loadBookmarks

protected DefaultListModel loadBookmarks()

Loads all the bookmarks that are currently stored in the properties.

Returns:

the current bookmarks

saveBookmarks

protected boolean saveBookmarks(DefaultListModel model)

Saves all the bookmarks in the properties.

Parameters:

model - the current bookmarks

Returns:

true if successfully saved

copyCurrentDirToClipboard

protected void copyCurrentDirToClipboard()

Copies the current directory to the clipboard.

isValidPath

protected boolean isValidPath(String dirStr)

Checks whether the string represents a valid directory.

Parameters:

dirStr - the string to test

Returns:

true if valid and existing directory

pasteCurrentDirFromClipboard

protected void pasteCurrentDirFromClipboard()

Pastes the current directory from the clipboard.

getPreferredSize

public Dimension getPreferredSize()

Returns the preferred size.

Overrides:

getPreferredSize in class JComponent

Returns:

the preferred size

updateButtons

protected void updateButtons()

Updates the enabled state of the buttons.

reload

public void reload()

Reloads the bookmarks.

newFactory

protected abstract AbstractFactory newFactory()

Creates a new instance of the factory.

Returns:

the factory

getBookmarksManger

public AbstractBookmarksManager getBookmarksManger()

Returns the bookmarks manager to use.

Returns:

the manager