net.sf.genuine.preferences.general
Class AppearancePreferencesPage

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JPanel
                  extended bynet.sf.genuine.preferences.PreferencesPage
                      extended bynet.sf.genuine.preferences.general.AppearancePreferencesPage
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class AppearancePreferencesPage
extends PreferencesPage

A default preference panel provided by Genuine that lets the user set several GUI related appearance options. This class may be sub classed if a different identification path or resource item is desired.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
static java.lang.String IDENTIFICATION_PATH
          The identification path for this preferences page.
static java.lang.String PREF_TOOLBAR_BUTTONS
          Key for the preference setting that controls whether text labels are shown in the tool bar.
static int PREF_TOOLBAR_BUTTONS_ICONS
           
static int PREF_TOOLBAR_BUTTONS_ICONSTEXT
           
static int PREF_TOOLBAR_BUTTONS_TEXT
           
 
Fields inherited from class net.sf.genuine.preferences.PreferencesPage
helperService
 
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.Container
 
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
AppearancePreferencesPage()
          Initializes this panel
 
Method Summary
 java.lang.String getIdentificationPath()
          Has to return a path that identifies this preferences page.
static int getToolbarButtonsPreference(ServiceBroker serviceBroker)
          Returns the currently set preference for toolbar buttons by querying the preferences service as long as that service has been created and registered by the preferences module.
 void resetPreferences()
          When this method is called, the page has to reset all preferences to their default settings.
 void restorePreferences(java.util.prefs.Preferences preferences)
          When this method is called, the page has to update its graphical components so that their values match the preferences stored in the given Preferences object.
 void storePreferences(java.util.prefs.Preferences preferences)
          When this method is called, the page has to update the given Preferences object with the current values of the graphical components.
 
Methods inherited from class net.sf.genuine.preferences.PreferencesPage
getResourceItem, showMessageRestartNeeded
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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
 

Field Detail

IDENTIFICATION_PATH

public static final java.lang.String IDENTIFICATION_PATH
The identification path for this preferences page. Use it to get the preferences object from outside this class using the PreferencesService.

See Also:
Constant Field Values

PREF_TOOLBAR_BUTTONS

public static final java.lang.String PREF_TOOLBAR_BUTTONS
Key for the preference setting that controls whether text labels are shown in the tool bar.

See Also:
Constant Field Values

PREF_TOOLBAR_BUTTONS_ICONS

public static final int PREF_TOOLBAR_BUTTONS_ICONS
See Also:
Constant Field Values

PREF_TOOLBAR_BUTTONS_TEXT

public static final int PREF_TOOLBAR_BUTTONS_TEXT
See Also:
Constant Field Values

PREF_TOOLBAR_BUTTONS_ICONSTEXT

public static final int PREF_TOOLBAR_BUTTONS_ICONSTEXT
See Also:
Constant Field Values
Constructor Detail

AppearancePreferencesPage

public AppearancePreferencesPage()
Initializes this panel

Method Detail

getIdentificationPath

public java.lang.String getIdentificationPath()
Description copied from class: PreferencesPage
Has to return a path that identifies this preferences page. Every page has to return a unique identification path. The string that is returned has to match XPath syntax. There should not be any starting or trailing slashes. Here are some examples:

The last part of the string that is returned defines the resource item that is used for the visual description of the preferences page. In the examples above, the following resource items are searched and retrieved:

Currently, all preferences pages are put into a tabbed pane one besides each other. In a future implementation, this path might be used to show a graphical tree of preferences page entries. The user may then click on any entry to open the corresponding preferences page.

Specified by:
getIdentificationPath in class PreferencesPage

resetPreferences

public void resetPreferences()
Description copied from class: PreferencesPage
When this method is called, the page has to reset all preferences to their default settings.

Specified by:
resetPreferences in class PreferencesPage

restorePreferences

public void restorePreferences(java.util.prefs.Preferences preferences)
Description copied from class: PreferencesPage
When this method is called, the page has to update its graphical components so that their values match the preferences stored in the given Preferences object.

Specified by:
restorePreferences in class PreferencesPage
Parameters:
preferences - The Preferences object that is associated with this preferences page. The association is derived from the root preferences path and the identification path of this page. See PreferencesService.

storePreferences

public void storePreferences(java.util.prefs.Preferences preferences)
Description copied from class: PreferencesPage
When this method is called, the page has to update the given Preferences object with the current values of the graphical components.

Specified by:
storePreferences in class PreferencesPage
Parameters:
preferences - The Preferences object that is associated with this preferences page. The association is derived from the root preferences path and the identification path of this page. See PreferencesService.

getToolbarButtonsPreference

public static int getToolbarButtonsPreference(ServiceBroker serviceBroker)
Returns the currently set preference for toolbar buttons by querying the preferences service as long as that service has been created and registered by the preferences module. Otherwise, the default preference setting is returned.

Returns:
A integer that encodes the preference. See the constants of this class.