com.mucommander.ui.dialog.pref
Class PreferencesDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      com.mucommander.ui.dialog.FocusDialog
                          com.mucommander.ui.dialog.pref.PreferencesDialog

All Implemented Interfaces:

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

Direct Known Subclasses:

GeneralPreferencesDialog, ThemeEditorDialog

public abstract class PreferencesDialog
extends FocusDialog
implements java.awt.event.ActionListener

Dialog meant to let users edit software preferences.

Author:

Maxence Bernard, Nicolas Rinaudo

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JDialog.AccessibleJDialog

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

java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType

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

java.awt.Window.AccessibleAWTWindow

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

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

PreferencesDialog(java.awt.Dialog parent, java.lang.String title)
Creates a new preferences dialog.

PreferencesDialog(java.awt.Frame parent, java.lang.String title)
Creates a new preferences dialog.

Method Summary

void	actionPerformed(java.awt.event.ActionEvent e) Reacts to buttons being pushed.
void	addPreferencesPanel(PreferencesPanel prefPanel) Adds the specified preferences panel to this dialog.
void	addPreferencesPanel(PreferencesPanel prefPanel, boolean scroll) Adds the specified preferences panel to this dialog.
void	addPreferencesPanel(PreferencesPanel prefPanel, java.lang.String iconName) Adds a new prefences panel and creates a new tab with an icon.
void	addPreferencesPanel(PreferencesPanel prefPanel, java.lang.String iconName, boolean scroll) Adds the specified preferences panel to this dialog.
boolean	checkCommit() Notifies all panels that changes are about to be commited.
void	commit() Calls PreferencesPanel.commit() on all registered preference panels.
abstract void	componentChanged(PrefComponent component) Function that will be called when the user change a value in a PrefComponent in this dialog.
int	getSelectedPanelIndex() Returns the index of the currently selected configuration panel.
void	setActiveTab(int index) Sets the currently active tab.
protected void	setCommitButtonsEnabled(boolean enable) This function set the "commit buttons", i.e apply & ok buttons, enabled\disabled according to the given parameter.

Methods inherited from class com.mucommander.ui.dialog.FocusDialog

cancel, isActivated, pack, setInitialFocusComponent, setKeyboardDisposalEnabled, setMaximumSize, setMinimumSize, showDialog, windowActivated, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowIconified, windowOpened

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setModalityType, setResizable, setTitle, setUndecorated, setVisible, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocationByPlatform, setLocationRelativeTo, setModalExclusionType, setSize, setSize, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PreferencesDialog

public PreferencesDialog(java.awt.Frame parent,
                         java.lang.String title)

Creates a new preferences dialog.

Parameters:

parent - parent of the dialog.

title - title of the dialg.

PreferencesDialog

public PreferencesDialog(java.awt.Dialog parent,
                         java.lang.String title)

Creates a new preferences dialog.

Parameters:

parent - parent of the dialog.

title - title of the dialg.

Method Detail

addPreferencesPanel

public void addPreferencesPanel(PreferencesPanel prefPanel,
                                java.lang.String iconName,
                                boolean scroll)

Adds the specified preferences panel to this dialog.

Parameters:

prefPanel - panel to add.

iconName - name of the icon that represents this dialog.

scroll - whether this panel should be wrapped in a scroll panel.

addPreferencesPanel

public void addPreferencesPanel(PreferencesPanel prefPanel,
                                java.lang.String iconName)

Adds a new prefences panel and creates a new tab with an icon.

Parameters:

prefPanel - panel to add.

iconName - name of the icon that represents this dialog.

addPreferencesPanel

public void addPreferencesPanel(PreferencesPanel prefPanel,
                                boolean scroll)

Adds the specified preferences panel to this dialog.

Parameters:

prefPanel - panel to add.

scroll - whether this panel should be wrapped in a scroll panel.

addPreferencesPanel

public void addPreferencesPanel(PreferencesPanel prefPanel)

Adds the specified preferences panel to this dialog.

Parameters:

prefPanel - panel to add.

commit

public void commit()

Calls PreferencesPanel.commit() on all registered preference panels.

checkCommit

public boolean checkCommit()

Notifies all panels that changes are about to be commited.

This gives preference panels a chance to display warning or errors before changes are commited.

Returns:

true if all preference panels are ok with commiting the changes, false otherwise.

setActiveTab

public void setActiveTab(int index)

Sets the currently active tab.

Parameters:

index - index of the tab to select.

actionPerformed

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

Reacts to buttons being pushed.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

getSelectedPanelIndex

public int getSelectedPanelIndex()

Returns the index of the currently selected configuration panel.

Returns:

the index of the currently selected configuration panel.

setCommitButtonsEnabled

protected void setCommitButtonsEnabled(boolean enable)

This function set the "commit buttons", i.e apply & ok buttons, enabled\disabled according to the given parameter.

Parameters:

enable - - parameter that indicated if the commit button will turn to be enabled (true) or disabled (false).

componentChanged

public abstract void componentChanged(PrefComponent component)

Function that will be called when the user change a value in a PrefComponent in this dialog.

Parameters:

component - - the PrefComponent that its value was changed.