Venice 0.751beta

nz.org.venice.prefs
Class PreferencesModule

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JPanel
                  extended bynz.org.venice.prefs.PreferencesModule
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.event.ActionListener, java.util.EventListener, java.awt.image.ImageObserver, java.awt.MenuContainer, Module, java.io.Serializable

public class PreferencesModule
extends javax.swing.JPanel
implements Module, java.awt.event.ActionListener

The preferences module for venice. This class provides the user interface to change any of the preferences settings. Preferences are organised as a set of pages, each page is responsible for one group of settings. Example:

      // Open a new preferences window displaying the quote source page
      PreferencesModule prefs = new PreferencesModule(desktop);
 
	// Create a frame around the module and add to the desktop
	ModuleFrame frame = new ModuleFrame(chart, 0, 0, 400, 300);
	desktop.add(frame);
 

See Also:
PreferencesPage, 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 int EQUATION_PAGE
          Refers to the stored equaton preferences page
static int LANGUAGE_PAGE
          Refers to the language preferences page
static int MACROS_PAGE
          Refers to the proxy macros page
static int PROXY_PAGE
          Refers to the proxy preferences page
static int QUOTE_SOURCE_PAGE
          Refers to the quote source preferences page
static int TUNING_PAGE
          Refers to the tuning preferences page
static int USER_INTERFACE
          Refers to the user interface page
 
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
PreferencesModule(javax.swing.JDesktopPane desktop)
          Create a new Preference Module loaded with the last viewed page.
PreferencesModule(javax.swing.JDesktopPane desktop, int page)
          Create a new Preference Module loaded with the given page.
 
Method Summary
 void actionPerformed(java.awt.event.ActionEvent e)
          Called when the user clicks on the save or cancel button.
 void addModuleChangeListener(java.beans.PropertyChangeListener listener)
          Add a property change listener for module change events.
 boolean encloseInScrollPane()
          Return whether the module should be enclosed in a scroll pane.
 javax.swing.JComponent getComponent()
          Return displayed component for this module.
 javax.swing.ImageIcon getFrameIcon()
          Return frame icon for quote source preferences module.
 javax.swing.JMenuBar getJMenuBar()
          Return menu bar for quote source preferences module.
 java.awt.Dimension getPreferredSize()
          Overrides the default method.
 Settings getSettings()
          Return the Settings for the module.
 java.lang.String getTitle()
          Returns the window title.
 void removeModuleChangeListener(java.beans.PropertyChangeListener listener)
          Remove a property change listener for module change events.
 void save()
          Tell module to save any current state data / preferences data because the window is being closed.
 
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, 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

EQUATION_PAGE

public static final int EQUATION_PAGE
Refers to the stored equaton preferences page

See Also:
Constant Field Values

QUOTE_SOURCE_PAGE

public static final int QUOTE_SOURCE_PAGE
Refers to the quote source preferences page

See Also:
Constant Field Values

TUNING_PAGE

public static final int TUNING_PAGE
Refers to the tuning preferences page

See Also:
Constant Field Values

PROXY_PAGE

public static final int PROXY_PAGE
Refers to the proxy preferences page

See Also:
Constant Field Values

MACROS_PAGE

public static final int MACROS_PAGE
Refers to the proxy macros page

See Also:
Constant Field Values

LANGUAGE_PAGE

public static final int LANGUAGE_PAGE
Refers to the language preferences page

See Also:
Constant Field Values

USER_INTERFACE

public static final int USER_INTERFACE
Refers to the user interface page

See Also:
Constant Field Values
Constructor Detail

PreferencesModule

public PreferencesModule(javax.swing.JDesktopPane desktop)
Create a new Preference Module loaded with the last viewed page.

Parameters:
desktop - the parent desktop

PreferencesModule

public PreferencesModule(javax.swing.JDesktopPane desktop,
                         int page)
Create a new Preference Module loaded with the given page.

Parameters:
desktop - the parent desktop
page - the page to view
Method Detail

getPreferredSize

public java.awt.Dimension getPreferredSize()
Overrides the default method. Determines the preferred size of all page components, rather than just the one to be displayed first


actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)
Called when the user clicks on the save or cancel button.

Specified by:
actionPerformed in interface java.awt.event.ActionListener
Parameters:
e - The event.

addModuleChangeListener

public void addModuleChangeListener(java.beans.PropertyChangeListener listener)
Add a property change listener for module change events.

Specified by:
addModuleChangeListener in interface Module
Parameters:
listener - listener

removeModuleChangeListener

public void removeModuleChangeListener(java.beans.PropertyChangeListener listener)
Remove a property change listener for module change events.

Specified by:
removeModuleChangeListener in interface Module
Parameters:
listener - listener

getComponent

public javax.swing.JComponent getComponent()
Return displayed component for this module.

Specified by:
getComponent in interface Module
Returns:
the component to display.

getJMenuBar

public javax.swing.JMenuBar getJMenuBar()
Return menu bar for quote source preferences module.

Specified by:
getJMenuBar in interface Module
Returns:
the menu bar.

getFrameIcon

public javax.swing.ImageIcon getFrameIcon()
Return frame icon for quote source preferences module.

Specified by:
getFrameIcon in interface Module
Returns:
the frame icon.

getTitle

public java.lang.String getTitle()
Returns the window title.

Specified by:
getTitle in interface Module
Returns:
the window title.

encloseInScrollPane

public boolean encloseInScrollPane()
Return whether the module should be enclosed in a scroll pane.

Specified by:
encloseInScrollPane in interface Module
Returns:
enclose module in scroll bar

save

public void save()
Tell module to save any current state data / preferences data because the window is being closed.

Specified by:
save in interface Module

getSettings

public Settings getSettings()
Description copied from interface: Module
Return the Settings for the module.

Specified by:
getSettings in interface Module

Venice 0.751beta