Package adams.gui.tools

Class EmailAddressBookPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

adams.gui.core.BasePanel

adams.gui.tools.AbstractManagementPanel<T>

adams.gui.tools.AbstractManagementPanelWithProperties<EmailContact>

adams.gui.tools.EmailAddressBookPanel

All Implemented Interfaces:

CleanUpHandler, MenuBarProvider, ImageObserver, MenuContainer, Serializable, Accessible

public class EmailAddressBookPanel
extends AbstractManagementPanelWithProperties<EmailContact>

Panel for managing email addresses.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EmailAddressBookPanel.TableModel	A simple table model for displaying the contacts.

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

Modifier and Type	Field	Description
protected BaseTextArea	m_TextAddress	the address.
protected BaseTextField	m_TextEmail	the email address.
protected BaseTextField	m_TextFirstName	the first name.
protected BaseTextField	m_TextLastName	the last name.
protected BaseTextArea	m_TextNote	the note.
protected BaseTextArea	m_TextPhone	the phone number.

Fields inherited from class adams.gui.tools.AbstractManagementPanelWithProperties

m_Properties

Fields inherited from class adams.gui.tools.AbstractManagementPanel

m_ButtonAdd, m_ButtonClear, m_ButtonLoad, m_ButtonRefresh, m_ButtonRemove, m_ButtonUpdate, m_FileChooser, m_MenuBar, m_MenuItemEditAdd, m_MenuItemEditClear, m_MenuItemEditRemove, m_MenuItemEditUpdate, m_MenuItemFileRefresh, m_ModelValues, m_PanelSearch, m_PanelTable, m_PanelValues, m_TableValues

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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

Constructors

Constructor	Description
EmailAddressBookPanel()

Method Summary

Modifier and Type	Method	Description
protected void	addFields(ParameterPanelWithButtons panel)	For adding all the fields.
protected boolean	canAddObject()	Returns whether all the required fields are set to add the object.
protected boolean	canClearFields()	Returns whether the fields can be cleared, i.e., if there is any input.
protected void	clear()	Resets the input fields.
protected String	createKey(EmailContact value)	Creates the key for storing the object in the properties.
protected EmailContact	fieldsToObject()	Turns the fields into an object.
protected EmailContact	fromString(String s)	Turns the string obtained from the properties file into an object.
protected Class	getManagedClass()	Returns the class that is being managed.
protected Properties	getProperties()	Returns the properties to work with.
protected boolean	isReadOnly()	Returns whether modified data cannot be stored.
protected AbstractManagementTableModel<EmailContact>	newTableModel()	Returns an instance of a new table model.
protected void	objectToFields(EmailContact value)	Updates the field with the specified object.
protected boolean	storeProperties()	Saves the properties on disk.
protected String	toString(EmailContact value)	Turns the object into a string to be stored in the properties file.

Methods inherited from class adams.gui.tools.AbstractManagementPanelWithProperties

exists, getID, loadAll, remove, store

Methods inherited from class adams.gui.tools.AbstractManagementPanel

addActionListener, addChangeListener, addDocumentListener, addListener, addObject, addOtherMenus, addToEditMenu, addToFileMenu, cleanUp, finishInit, getFileChooser, getItemName, getMaximumColumnWidth, getMenuBar, getSelectedValues, initGUI, loadValue, refresh, removeObjects, update, updateButtons, updateMenu, updateObject

Methods inherited from class adams.gui.core.BasePanel

afterHide, afterShow, beforeHide, beforeShow, closeParent, getParentChild, getParentDialog, getParentFrame, getParentInternalFrame, getParentTitle, initFileChooser, initialize, main, printErrorMessage, printException, saveComponent, setEnabledCascade, setEnabledCascade, setParentTitle, setVisible

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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, 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, 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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, 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

m_TextFirstName

protected BaseTextField m_TextFirstName

the first name.

m_TextLastName

protected BaseTextField m_TextLastName

the last name.

m_TextEmail

protected BaseTextField m_TextEmail

the email address.

m_TextPhone

protected BaseTextArea m_TextPhone

the phone number.

m_TextAddress

protected BaseTextArea m_TextAddress

the address.

m_TextNote

protected BaseTextArea m_TextNote

the note.

Constructor Detail

EmailAddressBookPanel

public EmailAddressBookPanel()

Method Detail

addFields

protected void addFields(ParameterPanelWithButtons panel)

For adding all the fields.

Specified by:

addFields in class AbstractManagementPanel<EmailContact>

Parameters:

panel - the panel to add the fields to

getProperties

protected Properties getProperties()

Returns the properties to work with. Loads them, if necessary.

Specified by:

getProperties in class AbstractManagementPanelWithProperties<EmailContact>

Returns:

the properties

storeProperties

protected boolean storeProperties()

Saves the properties on disk.

Specified by:

storeProperties in class AbstractManagementPanelWithProperties<EmailContact>

Returns:

true if successfully saved

createKey

protected String createKey(EmailContact value)

Creates the key for storing the object in the properties.

Specified by:

createKey in class AbstractManagementPanelWithProperties<EmailContact>

Parameters:

value - the object to create the key from

Returns:

the generated key

fromString

protected EmailContact fromString(String s)

Turns the string obtained from the properties file into an object.

Specified by:

fromString in class AbstractManagementPanelWithProperties<EmailContact>

Parameters:

s - the string to parse

Returns:

the generated object, null if failed to generate

toString

protected String toString(EmailContact value)

Turns the object into a string to be stored in the properties file.

Specified by:

toString in class AbstractManagementPanelWithProperties<EmailContact>

Parameters:

value - the object to convert

Returns:

the generated strings

newTableModel

protected AbstractManagementTableModel<EmailContact> newTableModel()

Returns an instance of a new table model.

Specified by:

newTableModel in class AbstractManagementPanel<EmailContact>

Returns:

the table model

getManagedClass

protected Class getManagedClass()

Returns the class that is being managed.

Specified by:

getManagedClass in class AbstractManagementPanel<EmailContact>

Returns:

the class being managed

clear

protected void clear()

Resets the input fields.

Specified by:

clear in class AbstractManagementPanel<EmailContact>

fieldsToObject

protected EmailContact fieldsToObject()

Turns the fields into an object.

Specified by:

fieldsToObject in class AbstractManagementPanel<EmailContact>

Returns:

the generated object

objectToFields

protected void objectToFields(EmailContact value)

Updates the field with the specified object.

Specified by:

objectToFields in class AbstractManagementPanel<EmailContact>

Parameters:

value - the object to display

canClearFields

protected boolean canClearFields()

Returns whether the fields can be cleared, i.e., if there is any input.

Specified by:

canClearFields in class AbstractManagementPanel<EmailContact>

Returns:

true if input can be cleared

isReadOnly

protected boolean isReadOnly()

Returns whether modified data cannot be stored.

Specified by:

isReadOnly in class AbstractManagementPanel<EmailContact>

Returns:

true if storing is not available

canAddObject

protected boolean canAddObject()

Returns whether all the required fields are set to add the object.

Specified by:

canAddObject in class AbstractManagementPanel<EmailContact>

Returns:

true if required fields are filled in