Holger's
Java API

com.antelmann.util.gui
Class JPropertyEntryForm<T extends PropertyEntry>

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by com.antelmann.util.gui.JPropertyEntryComponent
                  extended by com.antelmann.util.gui.JPropertyEntryForm<T>
All Implemented Interfaces:
EditableComponent, FormValidator<T>, ValueRetriever<PropertyEntry>, ImageObserver, MenuContainer, Serializable

public class JPropertyEntryForm<T extends PropertyEntry>
extends JPropertyEntryComponent
implements FormValidator<T>

provides a generic form to edit instances of class T based on its properties.

Since:
26.09.2008, 00:45:25
Author:
Holger Antelmann
See Also:
Serialized Form

Nested Class Summary
 
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
protected  ValueSetter<T> setter
           
protected  DBClassStore<T> store
           
 
Fields inherited from class com.antelmann.util.gui.JPropertyEntryComponent
entry, keyFields
 
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
JPropertyEntryForm(T entry, Database<?> db)
           
JPropertyEntryForm(T entry, DBClassStore<T> store, String... propertyKeys)
           
JPropertyEntryForm(T entry, ValueSetter<T> setter, DBClassStore<T> store, boolean initComponent, String... propertyKeys)
           
JPropertyEntryForm(T entry, ValueSetter<T> setter, DBClassStore<T> store, int padding, int maxRows, boolean initComponent, String... propertyKeys)
           
JPropertyEntryForm(T entry, ValueSetter<T> setter, DBClassStore<T> store, int padding, int maxRows, String... propertyKeys)
           
JPropertyEntryForm(T entry, ValueSetter<T> setter, DBClassStore<T> store, String... propertyKeys)
           
JPropertyEntryForm(T entry, ValueSetter<T> setter, String... propertyKeys)
           
 
Method Summary
 T commitFormAction(Component formComponent)
          first, the setter (if non-null) is called, then (if non-null) the store using DBUtils.commitEntry(DBClassStore, com.antelmann.db.DBEntry)
 void setEntry(PropertyEntry entry)
           
 
Methods inherited from class com.antelmann.util.gui.JPropertyEntryComponent
applyFormToEntry, applyValueToForm, createComponentFor, createComponentFor, createLabelFor, getClassFor, getRelevantValue, getValue, initComponent, initListener, isEditable, setEditable, setEnabled, validateForm
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, 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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, 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, updateUI
 
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
 
Methods inherited from interface com.antelmann.util.gui.FormValidator
validateForm
 

Field Detail

store

protected DBClassStore<T extends PropertyEntry> store

setter

protected ValueSetter<T extends PropertyEntry> setter
Constructor Detail

JPropertyEntryForm

public JPropertyEntryForm(T entry,
                          Database<?> db)

JPropertyEntryForm

public JPropertyEntryForm(T entry,
                          DBClassStore<T> store,
                          String... propertyKeys)

JPropertyEntryForm

public JPropertyEntryForm(T entry,
                          ValueSetter<T> setter,
                          String... propertyKeys)

JPropertyEntryForm

public JPropertyEntryForm(T entry,
                          ValueSetter<T> setter,
                          DBClassStore<T> store,
                          String... propertyKeys)

JPropertyEntryForm

public JPropertyEntryForm(T entry,
                          ValueSetter<T> setter,
                          DBClassStore<T> store,
                          boolean initComponent,
                          String... propertyKeys)

JPropertyEntryForm

public JPropertyEntryForm(T entry,
                          ValueSetter<T> setter,
                          DBClassStore<T> store,
                          int padding,
                          int maxRows,
                          String... propertyKeys)

JPropertyEntryForm

public JPropertyEntryForm(T entry,
                          ValueSetter<T> setter,
                          DBClassStore<T> store,
                          int padding,
                          int maxRows,
                          boolean initComponent,
                          String... propertyKeys)
Method Detail

setEntry

public void setEntry(PropertyEntry entry)
              throws ClassCastException
Overrides:
setEntry in class JPropertyEntryComponent
Throws:
ClassCastException

commitFormAction

public T commitFormAction(Component formComponent)
                                         throws IllegalArgumentException,
                                                Exception
first, the setter (if non-null) is called, then (if non-null) the store using DBUtils.commitEntry(DBClassStore, com.antelmann.db.DBEntry)

Specified by:
commitFormAction in interface FormValidator<T extends PropertyEntry>
Parameters:
formComponent - the component that contains the fields to be submitted for action
Returns:
the object that was committed by this method or null.
Throws:
IllegalArgumentException - if this validator doesn't accept the given formComponent
Exception - if something prevented the successful processing of the form


(c) Holger Antelmann since 2001- all rights reserved (contact: info@antelmann.com)
see www.antelmann.com/developer for further details and available downloads