org.jurvis.swing.form
Class JvAbstractForm

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.jurvis.swing.form.JvAbstractForm

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, JvJavaBean, JvForm

Direct Known Subclasses:

JvAbstractView

public abstract class JvAbstractForm
extends JPanel
implements JvForm

Abstract form containing input fields displaying data from a model. Classes extending JvAbstractForm are expected to implement the JvForm.setModel(java.lang.Object) and JvForm.getModel() methods. Stubs are provided for isValid(org.jurvis.util.JvErrorList) and commit(org.jurvis.util.JvErrorList), but most subclasses will want to provide their own implementation.

Author:

Neil W. Weber

See Also:

Serialized Form

Nested Class Summary

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.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

protected boolean

enabled Flag indicating if the form is enabled.

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

protected

JvAbstractForm() Construct an instance of JvAbstractForm.

Method Summary

boolean	commit(JvErrorList errorList) Commit all the user changes in the form to the form's model.
Object	getActiveObject() Return the active object in the form.
JComponent	getComponent() Return the JComponent containing this form.
boolean	isEnabled() Return whether the form is enabled or not.
boolean	isModified() Returns whether this form has been modified by the user.
boolean	isValid(JvErrorList errorList) Validate all user changes to the form.
void	registerFields(JvForm form) Register all fields within this form to the specified enclosing form.
boolean	rollback(JvErrorList errorList) Rollback all the user changes in the form to their original values.
void	setEnabled(boolean enabled) Set whether form is editable or not.
void	setModified(boolean modified) Sets whether or not this form has been modified by the user.

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

Methods inherited from interface org.jurvis.swing.form.JvForm

getModel, setModel

Methods inherited from interface org.jurvis.beans.JvJavaBean

addPropertyChangeListener, removePropertyChangeListener

Field Detail

enabled

protected boolean enabled

Flag indicating if the form is enabled.

Constructor Detail

JvAbstractForm

protected JvAbstractForm()

Construct an instance of JvAbstractForm.

Method Detail

getComponent

public JComponent getComponent()

Return the JComponent containing this form.

Specified by:

getComponent in interface JvForm

Returns:

the form's JComponent

registerFields

public void registerFields(JvForm form)

Register all fields within this form to the specified enclosing form. Wen a user makes a change on any of the registered fields, the form will be marked as modified. The default behavior is to traverse the component tree rooted at this form and register all encountered editable components.

Parameters:

form - the enclosing form

getActiveObject

public Object getActiveObject()

Return the active object in the form.

Specified by:

getActiveObject in interface JvForm

Returns:

the current model

setModified

public void setModified(boolean modified)

Sets whether or not this form has been modified by the user. This method is not typically called by code outside of the com.nike.nfc package.

Specified by:

setModified in interface JvForm

Parameters:

modified - new value for the modified property

isModified

public boolean isModified()

Returns whether this form has been modified by the user.

Specified by:

isModified in interface JvForm

Returns:

true if the user has modified the form; false otherwise

isEnabled

public boolean isEnabled()

Return whether the form is enabled or not.

Specified by:

isEnabled in interface JvForm

Overrides:

isEnabled in class Component

Returns:

true or false indicating whether form is editable.

setEnabled

public void setEnabled(boolean enabled)

Set whether form is editable or not.

Specified by:

setEnabled in interface JvForm

Overrides:

setEnabled in class JComponent

Parameters:

enabled - new value for the modified property

isValid

public boolean isValid(JvErrorList errorList)

Validate all user changes to the form. This method is stubbed out and always returns true. Subclasses will probably want to provide their own implementation.

Specified by:

isValid in interface JvForm

Parameters:

errorList - list containing any errors found during validation

Returns:

true

commit

public boolean commit(JvErrorList errorList)

Commit all the user changes in the form to the form's model. This method is stubbed out and always returns true. Subclasses will probably want to provide their own implementation.

Specified by:

commit in interface JvForm

Parameters:

errorList - list containing any errors found during commit

Returns:

true

rollback

public boolean rollback(JvErrorList errorList)

Rollback all the user changes in the form to their original values.

Specified by:

rollback in interface JvForm

Parameters:

errorList - list containing any errors found during the rollback

Returns:

true if the rollback was successful; false otherwise