Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.mrbook.mrpostman.gui
Class ModuleOptionPanel  view ModuleOptionPanel download ModuleOptionPanel.java

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JPanel
                  extended byorg.mrbook.mrpostman.gui.ModuleOptionPanel
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class ModuleOptionPanel
extends javax.swing.JPanel


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
private  javax.swing.JLabel authors
           
private static int CELL_PADDING
          The CELL_PADDING for the gridbag layout
private  java.util.HashMap componentMap
          Our mapping from optionId to JComponent.
static java.lang.String CVSID
           
private  java.lang.String moduleId
          The moduleId that this panel represents
private  MrPostmanGui parentGui
          Our reference to the MrPostmanGui object which handles the 'Apply' processing
private  javax.swing.JLabel version
           
 
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
ModuleOptionPanel(org.mrbook.mrpostman.ModuleInfo info)
          Constructor.
 
Method Summary
private  java.lang.String getAuthorsString(java.lang.String[] authors)
          Helper function to return String representation of the list of authors.
 java.lang.String getModuleId()
          Return the moduleID that this panel represents
 java.lang.String getOptionValue(java.lang.String optionId)
          Return an option's current value as entered in its gui component
 void handleApplyButtonPress()
          Internal awt event linker method (required so the 'Apply' button event handler can access the ModuleOptionPanel 'this' object.
 void handleHelpButtonPress()
          Internal awt event linker method (required so the 'Help' button event handler can access the ModuleOptionPanel 'this' object.
 void initComponents(org.mrbook.mrpostman.ModuleInfo info)
          Create this panel's common (fixed) gui components.
 void setMrPostmanGui(MrPostmanGui eventHandler)
          Set the parent MrPostmanGui instance which will handle our button events.
 void setOptionPanel(javax.swing.JPanel options, java.util.HashMap componentMap)
          Add the ModuleOption panel.
 void setOptionValue(java.lang.String optionId, java.lang.String newValue)
          Update this named option's gui component with the supplied value.
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, 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, 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, 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, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, 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, 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, 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

CVSID

public static final java.lang.String CVSID
See Also:
Constant Field Values

CELL_PADDING

private static final int CELL_PADDING
The CELL_PADDING for the gridbag layout

See Also:
Constant Field Values

moduleId

private java.lang.String moduleId
The moduleId that this panel represents


parentGui

private MrPostmanGui parentGui
Our reference to the MrPostmanGui object which handles the 'Apply' processing


componentMap

private java.util.HashMap componentMap
Our mapping from optionId to JComponent. This is passed to setOptionPanel(..) and is created by the ModuleOptionGuiManager during panel construction.


version

private javax.swing.JLabel version

authors

private javax.swing.JLabel authors
Constructor Detail

ModuleOptionPanel

public ModuleOptionPanel(org.mrbook.mrpostman.ModuleInfo info)
Constructor. Takes a ModuleInfo object (as returned from the WebMailSession object) which describes the module info.

Method Detail

setMrPostmanGui

public void setMrPostmanGui(MrPostmanGui eventHandler)
Set the parent MrPostmanGui instance which will handle our button events. This must be done before this panel is displayed.


initComponents

public void initComponents(org.mrbook.mrpostman.ModuleInfo info)
Create this panel's common (fixed) gui components. These are the same for all modules. This does not include the 'variable' ModuleOption panel which is added later.


setOptionPanel

public void setOptionPanel(javax.swing.JPanel options,
                           java.util.HashMap componentMap)
Add the ModuleOption panel. This contains the module specific option gui components, as created by the ModuleOptionGuiManager from details contained in the XML configuration file. This method also requires the component hashmap from optionId to JComponent


handleApplyButtonPress

public void handleApplyButtonPress()
Internal awt event linker method (required so the 'Apply' button event handler can access the ModuleOptionPanel 'this' object.


handleHelpButtonPress

public void handleHelpButtonPress()
Internal awt event linker method (required so the 'Help' button event handler can access the ModuleOptionPanel 'this' object.


getAuthorsString

private java.lang.String getAuthorsString(java.lang.String[] authors)
Helper function to return String representation of the list of authors.


setOptionValue

public void setOptionValue(java.lang.String optionId,
                           java.lang.String newValue)
Update this named option's gui component with the supplied value.


getOptionValue

public java.lang.String getOptionValue(java.lang.String optionId)
Return an option's current value as entered in its gui component


getModuleId

public java.lang.String getModuleId()
Return the moduleID that this panel represents