com.mindtree.techworks.insight.gui.preferences
Class AbstractPreferencesUIPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.mindtree.techworks.insight.gui.preferences.AbstractPreferencesUIPanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

Direct Known Subclasses:

EventColumnPreferencePanel, FilesetsUIPanel, FTPFilesUIPanel, LocalFilesUIPanel, LogPatternUIPanel, ProxyUIPanel, RemoteFilesUIPanel, RemoteProtocolUIPanel, SFTPFilesUIPanel

public abstract class AbstractPreferencesUIPanel
extends javax.swing.JPanel

The AbstractPreferencesUIPanel abstract class is the base GUI panel for rendering Insight Preference instances. Specific sub-types render the respective Preference details. All subtypes need to provide a no-args constructor to permit instantiation using Reflection. This panel uses a GrigBagLayout. Derived types may add widgets using

Version:

$Revision: 27 $ $Date: 2007-12-16 04:58:03 -0700 (Sun, 16 Dec 2007) $

Author:

Regunath B

See Also:

addComponent(Component, int, int, int, int, int, int), Preference, Serialized Form

Nested Class Summary

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

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

protected static java.lang.String	FALSE Constant for 'true' and 'false' boolean value
protected PreferencesFrame	parent The PreferencesFrame for this panel
protected Preference	preference The Preference rendered by this panel
protected static java.lang.String	TRUE Constant for 'true' and 'false' boolean value

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

AbstractPreferencesUIPanel()

Method Summary

protected void	addComponent(java.awt.Component c, int gridx, int gridy, int weightx, int weighty, int width, int height) Adds the specified component to this panel using the specified constraints.
protected void	createAndAddBooleanAttribute(Preference childPreference, java.lang.String id, java.lang.String name, javax.swing.JCheckBox checkBox) Helper method to created and add a PreferenceAttribute of type CHECK and containing the specified valued
protected void	createAndAddPasswordAttribute(Preference childPreference, java.lang.String id, java.lang.String name, javax.swing.JPasswordField passwordField) Helper method to created and add a password PreferenceAttribute of type TEXT and containing the specified valued
protected void	createAndAddTextAttribute(Preference childPreference, java.lang.String id, java.lang.String name, javax.swing.JTextField textField) Helper method to created and add a PreferenceAttribute of type TEXT and containing the specified valued
void	initialize(Preference preferenceToLoad, PreferencesFrame parentComponent) Initializes this class with the Preference specified.
protected abstract void	initializeDisplay() Abstract method to initialize the display contents.
protected abstract void	setPreferenceValues() Abstract method that informs this panel to set the edited preference values to the Preference that this panel was initialized with.

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

Field Detail

TRUE

protected static final java.lang.String TRUE

Constant for 'true' and 'false' boolean value

See Also:

Constant Field Values

FALSE

protected static final java.lang.String FALSE

Constant for 'true' and 'false' boolean value

See Also:

Constant Field Values

preference

protected Preference preference

The Preference rendered by this panel

parent

protected PreferencesFrame parent

The PreferencesFrame for this panel

Constructor Detail

AbstractPreferencesUIPanel

public AbstractPreferencesUIPanel()

Method Detail

initialize

public void initialize(Preference preferenceToLoad,
                       PreferencesFrame parentComponent)

Initializes this class with the Preference specified. Also sets up the display layout.

Parameters:

preferenceToLoad - the Preference to be displayed by this panel

parentComponent - The parent container of this component

initializeDisplay

protected abstract void initializeDisplay()

Abstract method to initialize the display contents. This method is called after initialize() has been invoked.

See Also:

initialize(Preference, PreferencesFrame)

setPreferenceValues

protected abstract void setPreferenceValues()

Abstract method that informs this panel to set the edited preference values to the Preference that this panel was initialized with.

See Also:

initialize(Preference, PreferencesFrame)

addComponent

protected final void addComponent(java.awt.Component c,
                                  int gridx,
                                  int gridy,
                                  int weightx,
                                  int weighty,
                                  int width,
                                  int height)

Adds the specified component to this panel using the specified constraints.

Parameters:

c - The component to add

gridx - Horizontal location on the grid

gridy - Vertical location on the grid

weightx - The horizontal weight

weighty - The vertical weight

width - The width of the component

height - The height of the component

createAndAddTextAttribute

protected void createAndAddTextAttribute(Preference childPreference,
                                         java.lang.String id,
                                         java.lang.String name,
                                         javax.swing.JTextField textField)

Helper method to created and add a PreferenceAttribute of type TEXT and containing the specified valued

Parameters:

childPreference - the Preference to add the attribute to

id - id of the attribute

name - name of the attribute

textField - the JTextField to pick up the value from

createAndAddPasswordAttribute

protected void createAndAddPasswordAttribute(Preference childPreference,
                                             java.lang.String id,
                                             java.lang.String name,
                                             javax.swing.JPasswordField passwordField)

Helper method to created and add a password PreferenceAttribute of type TEXT and containing the specified valued

Parameters:

childPreference - the Preference to add the attribute to

id - id of the attribute

name - name of the attribute

passwordField - the JPasswordField to pick up the value from

createAndAddBooleanAttribute

protected void createAndAddBooleanAttribute(Preference childPreference,
                                            java.lang.String id,
                                            java.lang.String name,
                                            javax.swing.JCheckBox checkBox)

Helper method to created and add a PreferenceAttribute of type CHECK and containing the specified valued

Parameters:

childPreference - the Preference to add the attribute to

id - id of the attribute

name - name of the attribute

checkBox - the JCheckBox to pick up the value from