bibliothek.extension.gui.dock.preference
Class PreferenceTreeDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  bibliothek.extension.gui.dock.preference.AbstractPreferenceDialog<PreferenceTreeModel>
                      bibliothek.extension.gui.dock.preference.PreferenceTreeDialog

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class PreferenceTreeDialog
extends AbstractPreferenceDialog<PreferenceTreeModel>

A simple dialog showing a PreferenceTreeModel on a PreferenceTreePanel.

Author:

Benjamin Sigg

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

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

PreferenceTreeDialog(boolean destroyOnClose)
Creates a new dialog without model.

PreferenceTreeDialog(PreferenceTreeModel model, boolean destroyOnClose)
Creates a new dialog.

Method Summary

protected JComponent	getContent() Gets the component which will show the model of this dialog.
PreferenceTreePanel	getPanel() Access to the PreferenceTreePanel which is shown on this dialog.
static void	openDialog(PreferenceTreeModel model, Component owner) Shows a modal dialog on which the user can change the preferences of controller.
void	setEditorFactory(Path type, PreferenceEditorFactory<?> factory) Sets an editor for some type of values.
protected void	setModelForContent(PreferenceTreeModel model) Informs subclasses that the model has changed and that they might setup the content again.

Methods inherited from class bibliothek.extension.gui.dock.preference.AbstractPreferenceDialog

close, destroy, doApply, doCancel, doOk, doReset, getModel, init, isDestroyOnClose, openDialog, setDestroyOnClose, setModel

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

Constructor Detail

PreferenceTreeDialog

public PreferenceTreeDialog(boolean destroyOnClose)

Creates a new dialog without model.

Parameters:

destroyOnClose - if set to true, then AbstractPreferenceDialog.destroy() is automatically called if AbstractPreferenceDialog.close() is called. Clients have to call AbstractPreferenceDialog.destroy() manually if they are not using AbstractPreferenceDialog.openDialog(Component, boolean).

PreferenceTreeDialog

public PreferenceTreeDialog(PreferenceTreeModel model,
                            boolean destroyOnClose)

Creates a new dialog.

Parameters:

model - the model to show on the dialog

destroyOnClose - if set to true, then AbstractPreferenceDialog.destroy() is automatically called if AbstractPreferenceDialog.close() is called. Clients have to call AbstractPreferenceDialog.destroy() manually if they are not using AbstractPreferenceDialog.openDialog(Component, boolean).

Method Detail

openDialog

public static void openDialog(PreferenceTreeModel model,
                              Component owner)

Shows a modal dialog on which the user can change the preferences of controller. This method will call PreferenceModel.read() and PreferenceModel.write() to reset or to apply the changes of the user.

Parameters:

model - the model to show on the dialog

owner - the owner of the dialog

setEditorFactory

public void setEditorFactory(Path type,
                             PreferenceEditorFactory<?> factory)

Sets an editor for some type of values.

Parameters:

type - the type

factory - the factory for the new editors

See Also:

PreferenceTable.setEditorFactory(Path, PreferenceEditorFactory)

getPanel

public PreferenceTreePanel getPanel()

Access to the PreferenceTreePanel which is shown on this dialog. Clients should not change the PreferenceTreeModel of that panel. But they are allowed to customize the panel, for example to change the TreeCellRenderer.

Returns:

the panel of this dialog

getContent

protected JComponent getContent()

Description copied from class: AbstractPreferenceDialog

Gets the component which will show the model of this dialog.

Specified by:

getContent in class AbstractPreferenceDialog<PreferenceTreeModel>

Returns:

the component

setModelForContent

protected void setModelForContent(PreferenceTreeModel model)

Description copied from class: AbstractPreferenceDialog

Informs subclasses that the model has changed and that they might setup the content again.

Specified by:

setModelForContent in class AbstractPreferenceDialog<PreferenceTreeModel>

Parameters:

model - the new model, can be null