de.esprit.appsuite.database.dbgui.form

Class RecordFieldPanel<C extends ApplicationContext,R extends DBRecord>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

de.esprit.common.gui.ZPanel

de.esprit.common.gui.gridbag.GridBagPanel

de.esprit.appsuite.database.dbgui.field.FieldPanel

de.esprit.appsuite.database.dbgui.form.RecordFieldPanel<C,R>

All Implemented Interfaces:

ApplicationObject<C>, GridBagConstants, Clearable, Dumpable, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

Direct Known Subclasses:

ClientRecordFieldPanel

public class RecordFieldPanel<C extends ApplicationContext,R extends DBRecord>
extends FieldPanel
implements ApplicationObject<C>

This class creates a ready to use input form that contains all fields of the given DBRecord for user input. It is used for modifying the values of a record as well as for creating new record instances from the users input.

Author:

Rainer Buesch

See Also:

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

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 de.esprit.common.gui.gridbag.GridBagConstants

BOTH, C, CENTER, E, EAST, HOR, HORIZONTAL, N, NE, NONE, NORTH, NORTHEAST, NORTHWEST, NW, REM, REMAINDER, S, SE, SOUTH, SOUTHEAST, SOUTHWEST, SW, VER, VERTICAL, W, WEST

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
RecordFieldPanel(C ctx, R masterRec, EditMode mode) Constructs the panel for the given type of DBRecord.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkRecordTypeField(Field field) Sets this field the record-type column of a ComposedRecord (inheritance type).
protected Field	createInputField(java.lang.Class fieldClass, int jdbcType, java.lang.String fieldName, int fieldLength, boolean isNotNull, boolean isPK) Creates the Field component with the given parameters.
R	createRecordFromInput() Tries to create a DBObject of the managed type from the input fields.
ZAction	getActionRehashRecord() This action rehashes the current record from the database without changing its reference.
C	getApplicationContext()
R	getCurrentRecord() Returns the current DBRecord which has been set with setCurrentRecord(DBRecord).
R	getMasterRecord() Returns the master DBRecord that was used to create this form panel.
DBRecord	getParentRecord()
void	insertRecord(RecordCollection recColl) Creates the new DBRecord from the users input and calls performRecordInsert(DBRecord, RecordCollection).
protected boolean	isFieldVisible(java.lang.String fieldName) Tells whether the field with the given name should be visible in the form.
protected boolean	isPrimaryKeyFieldLocked() Tells whether the PK field should be locked.
R	modifyRecordFromInput() Returns a copy of the current DBRecord modified according the values of the input fields.
R	modifyRecordFromInput(R newRec) Tries to create a DBRecord of the managed type from the input fields.
protected void	performRecordInsert(R newRec, RecordCollection recColl) Performs the actual database INSERT operation and if successful adds the newly inserted record into the record collection.
protected R	performRecordRehash(R currRec) Performs the database REHASH request.
protected void	performRecordUpdate(R modifiedRec, RecordCollection recColl) Performs the database UPDATE request and modifies the RecordCollection accordingly
void	rehashRecord() Rehashes the current record from the database by calling performRecordRehash(DBRecord).
void	reset() Sets all input field values from the current DBRecord.
void	setCurrentRecord(R record) Makes the given DBRecord the current one and displays it's values.
void	setParentRecord(DBRecord record) Sets the parent record from which the current record may depend
protected R	setPrimaryKeyValues(R newRec)
void	setRecordType() Sets the value of the record-type field
void	updateRecord(RecordCollection recColl) Creates a copy of the current record, modifies it from the users input and calls performRecordUpdate(DBRecord, RecordCollection).

Methods inherited from class de.esprit.appsuite.database.dbgui.field.FieldPanel

addField, checkInput, checkInput, clear, clearAll, configureField, createLayout, existsField, focusFirstField, getEditMode, getField, getField, getFieldCount, getFields, getMaxLabelWidth, getModifyFlag, hasInput, isCreateMode, isFieldLocked, isFieldNotNull, isModified, isSearchMode, isUpdateMode, layoutFields, placeField, setApplier, setEditMode, setFields, setInsertDefaultValues, setLocked, setModified, setModifyFlag, setNotNull, setPrimaryKeysLocked, toDumpString, toDumpString, toString, toString

Methods inherited from class de.esprit.common.gui.gridbag.GridBagPanel

alignFirstColumnsInSubPanels, getDefaultInsets, getFirstColumnMaxWidth, horizontalStretch, place, place, place, place, place, place, place, setDefaultInsets, setFirstColumnWidth, stretchX, stretchY, verticalStretch

Methods inherited from class de.esprit.common.gui.ZPanel

addBorder, contains, getTileIcon, insertBorder, paintComponent, setTileIcon, setTileIcon, setTitledBorder

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, 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, 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, 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, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RecordFieldPanel

public RecordFieldPanel(C ctx,
                R masterRec,
                EditMode mode)

Constructs the panel for the given type of DBRecord.

Method Detail

getApplicationContext

public final C getApplicationContext()

Specified by:

getApplicationContext in interface ApplicationObject<C extends ApplicationContext>

getMasterRecord

public R getMasterRecord()

Returns the master DBRecord that was used to create this form panel.

isPrimaryKeyFieldLocked

protected boolean isPrimaryKeyFieldLocked()

Tells whether the PK field should be locked. By default PK fields are locked in EditMode.UPDATE.

createInputField

protected Field createInputField(java.lang.Class fieldClass,
                     int jdbcType,
                     java.lang.String fieldName,
                     int fieldLength,
                     boolean isNotNull,
                     boolean isPK)

Creates the Field component with the given parameters. May be overridden to provide specialized Fields like ChoiceFields for particular columns.

checkRecordTypeField

protected void checkRecordTypeField(Field field)

Sets this field the record-type column of a ComposedRecord (inheritance type). The column is considered to be the record type column if its name matches the syntax: <table>_type.

createRecordFromInput

public R createRecordFromInput()
                                         throws java.lang.Exception

Tries to create a DBObject of the managed type from the input fields.

Throws:

java.lang.Exception

getActionRehashRecord

public ZAction getActionRehashRecord()

This action rehashes the current record from the database without changing its reference.

setCurrentRecord

public void setCurrentRecord(R record)

Makes the given DBRecord the current one and displays it's values.

See Also:

getCurrentRecord()

setParentRecord

public void setParentRecord(DBRecord record)

Sets the parent record from which the current record may depend

getParentRecord

public DBRecord getParentRecord()

getCurrentRecord

public R getCurrentRecord()

Returns the current DBRecord which has been set with setCurrentRecord(DBRecord).

See Also:

setCurrentRecord(DBRecord r), createRecordFromInput()

setPrimaryKeyValues

protected R setPrimaryKeyValues(R newRec)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

modifyRecordFromInput

public R modifyRecordFromInput()
                                         throws java.lang.Exception

Returns a copy of the current DBRecord modified according the values of the input fields.

Throws:

java.lang.Exception

modifyRecordFromInput

public R modifyRecordFromInput(R newRec)
                                         throws java.lang.Exception

Tries to create a DBRecord of the managed type from the input fields.

Throws:

java.lang.Exception

reset

public void reset()

Sets all input field values from the current DBRecord. If there is no current DBRecord then all fields are cleared.

See Also:

setCurrentRecord(DBRecord r)

isFieldVisible

protected boolean isFieldVisible(java.lang.String fieldName)

Tells whether the field with the given name should be visible in the form. May be overridden by subclasses to control, which fields are displayed. By default a field is hidden in create-mode, if it represents a single primary key column or if it is a virtual field.

Overrides:

isFieldVisible in class FieldPanel

See Also:

DBRecord.isFieldVirtual(String), DBRecord.isPrimaryKey(String)

insertRecord

public final void insertRecord(RecordCollection recColl)
                        throws java.lang.Exception

Creates the new DBRecord from the users input and calls performRecordInsert(DBRecord, RecordCollection).

Throws:

java.lang.Exception

updateRecord

public final void updateRecord(RecordCollection recColl)
                        throws java.lang.Exception

Creates a copy of the current record, modifies it from the users input and calls performRecordUpdate(DBRecord, RecordCollection).

Throws:

java.lang.Exception

rehashRecord

public final void rehashRecord()
                        throws java.lang.Exception

Rehashes the current record from the database by calling performRecordRehash(DBRecord).

Throws:

java.lang.Exception

setRecordType

public void setRecordType()

Sets the value of the record-type field

performRecordInsert

protected void performRecordInsert(R newRec,
                       RecordCollection recColl)
                            throws java.lang.Exception

Performs the actual database INSERT operation and if successful adds the newly inserted record into the record collection.

Throws:

java.lang.Exception

performRecordUpdate

protected void performRecordUpdate(R modifiedRec,
                       RecordCollection recColl)
                            throws java.lang.Exception

Performs the database UPDATE request and modifies the RecordCollection accordingly

Throws:

java.lang.Exception

performRecordRehash

protected R performRecordRehash(R currRec)
                                          throws java.lang.Exception

Performs the database REHASH request. After this request the current record is being replaced accordingly.

Throws:

java.lang.Exception