org.tentackle.swing.rdc

Class PdoFieldPanel<T extends PersistentDomainObject<T>>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.tentackle.swing.FormPanel

org.tentackle.swing.FormComponentPanel

org.tentackle.swing.FormFieldComponentPanel

org.tentackle.swing.rdc.PdoFieldPanel<T>

Type Parameters:

T - the pdo type

All Implemented Interfaces:

DropTargetListener, ContainerListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, FormChangeable, FormChangeableComponent, FormComponent, FormContainer, FormFieldComponent

public class PdoFieldPanel<T extends PersistentDomainObject<T>>
extends FormFieldComponentPanel
implements DropTargetListener

A panel containing a FormField representing the key to select the data object and buttons for editing/viewing/searching.

See Also:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected long	linkedId
protected T	linkedObject

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 org.tentackle.swing.FormFieldComponent

ADJUST_LEFT, ADJUST_NONE, ADJUST_RIGHT, ADJUST_TRIM, CONVERT_LC, CONVERT_NONE, CONVERT_UC

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
PdoFieldPanel() Creates an application database object field panel.

Method Summary

Modifier and Type	Method and Description
protected Object	checkObject(Object object, Class<T> clazz) Checks the returned object against null and creates the error popup if enabled.
PdoSearchDialog<T>	createSearchDialog() Creates the search dialog.
void	dragEnter(DropTargetDragEvent event)
void	dragExit(DropTargetEvent event)
void	dragOver(DropTargetDragEvent event)
void	drop(DropTargetDropEvent event)
void	dropActionChanged(DropTargetDragEvent event)
T	findByKey(Class<T> clazz, DomainContext contextDb, Object key) Finds an PersistentDomainObject of given class by the key entered in the formfield component.
FormButton	getEditButton() Returns the editButton.
Object	getFormValue()
int	getInfoColumns() Get columns of info field
T	getLink() Gets the object.
long	getLinkId() Gets the object Id of the link.
FormButton	getSearchButton() Returns the searchButton.
PdoSearch<T>	getSearchPlugin() Gets the search plugin.
boolean	isCheckExistsEnabled() Gets the check exists feature.
boolean	isDropEnabled() Returns whether the infofield of this linkpanel is a dropzone.
boolean	isEditButtonVisible() Gets the visibility of the edit button.
boolean	isInfoFieldVisible() Gets the infofield's visibility.
boolean	isSearchButtonVisible() Gets the visibility of the search button.
protected void	loadObject() Loads the object
void	runEdit() Edits the object
void	runSearch() Runs the search
void	setCellEditorUsage(boolean flag)
void	setChangeable(boolean changeable)
void	setCheckExistsEnabled(boolean checkExistsEnabled) Sets whether the object exists for given domain key. If there is no object for given key an error popup will be shown.
void	setDropEnabled(boolean dropEnabled) Sets the infofield of this linkpanel to be a drop zone.
void	setEditButtonVisible(boolean visible) Sets the visibility of the edit button. Some apps don't want the user to edit the object.
void	setFormComponent(FormComponent comp)
void	setFormValue(Object obj)
void	setInfoColumns(int col) Sets columns of the info field.
void	setInfoFieldVisible(boolean visible) Sets the infofield's visibility.
void	setLink(Class<T> clazz, DomainContext context, long linkedId) Sets the link with default plugin.
void	setLink(Class<T> clazz, DomainContext context, long linkedId, boolean keepPlugin) Sets the link with default plugin.
void	setLink(PdoSearch<T> pdoSearch, long linkedId) Sets the link.
void	setLink(T pdo) sets the link object (if plugin matches)
void	setName(String name)
void	setSearchButtonVisible(boolean visible) Sets the visibility of the search button. The default is visible.
protected void	setup() Sets up the component, drop enabled and clears the object
void	updateCodeAndInfoField(T linkedObject) Updates both the code- and the info field.
protected void	updateInfoFieldDropAndColor() Updates the background color of the infofield.

Methods inherited from class org.tentackle.swing.FormFieldComponentPanel

clearText, doFormat, downRight, getAdjust, getCaretPosition, getColumns, getConvert, getConverter, getDefaultColumns, getErrorMessage, getErrorOffset, getFiller, getFormat, getFormComponent, getHorizontalAlignment, getInvalidChars, getMaxColumns, getText, getToolTipText, getValidChars, getVerticalAlignment, isAutoNext, isAutoSelect, isCaretLeft, isCaretRight, isEmpty, isEraseFirst, isInhibitAutoSelect, isOverwrite, isStartEditLeftmost, postActionEvent, setAdjust, setAutoNext, setAutoSelect, setCaretLeft, setCaretPosition, setCaretRight, setColumns, setConvert, setConverter, setDefaultColumns, setEraseFirst, setErrorMessage, setErrorOffset, setFiller, setFormat, setHorizontalAlignment, setInhibitAutoSelect, setInvalidChars, setMaxColumns, setOverwrite, setStartEditLeftmost, setText, setToolTipText, setValidChars, setVerticalAlignment, upLeft

Methods inherited from class org.tentackle.swing.FormComponentPanel

addValueListener, clearValueShownModified, fireValueChanged, fireValueEntered, getBaseline, getBinding, getBindingPath, getComponentPath, getFocusTraversalGroup, getHelpURL, getParentWindow, getPropertyGroup, getValueShown, hasFocus, invalidateParentInfo, isAutoUpdate, isBindable, isCellEditorUsage, isChangeable, isFireRunning, isFormTraversable, isHonourChangeable, isMandatory, isSmartValueEntered, isTriggerValueChangedEnabled, isValueChanged, isValueShownModified, prepareFocusLost, removeValueListener, requestFocus, requestFocus, requestFocusInWindow, requestFocusLater, saveValue, setAutoUpdate, setBindable, setBinding, setBindingPath, setComponentPath, setFireRunning, setFocusTraversalGroup, setFormTraversable, setFormWrapWindow, setHelpURL, setHonourChangeable, setMandatory, setPropertyGroup, setSmartValueEntered, setTriggerValueChangedEnabled, showErrorPopup, showHelp, triggerValueChanged, updateAllChangeable, wasFocusGainedFromTransfer, wasFocusGainedFromTransferBackward, wasTransferFocus, wasTransferFocusBackward, wasTransferFocusByEnter

Methods inherited from class org.tentackle.swing.FormPanel

addActionListener, areValuesChanged, componentAdded, componentRemoved, createBinder, fireActionPerformed, getBinder, getFormValues, getTitle, isTriggerValuesChangedEnabled, removeActionListener, saveValues, setFormValues, setFormValuesKeepChanged, setTitle, setTriggerValuesChangedEnabled, triggerValuesChanged

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

Methods inherited from interface org.tentackle.swing.FormComponent

addValueListener, clearValueShownModified, fireValueChanged, fireValueEntered, getBaseline, getBinding, getBindingPath, getComponentPath, getFocusTraversalGroup, getHelpURL, getParentWindow, getPropertyGroup, getValueShown, hasFocus, invalidateParentInfo, isAutoUpdate, isBindable, isCellEditorUsage, isFireRunning, isFormTraversable, isMandatory, isSmartValueEntered, isTriggerValueChangedEnabled, isValueChanged, isValueShownModified, prepareFocusLost, removeValueListener, requestFocusLater, saveValue, setAutoUpdate, setBindable, setBinding, setBindingPath, setComponentPath, setFireRunning, setFocusTraversalGroup, setFormTraversable, setFormWrapWindow, setHelpURL, setMandatory, setPropertyGroup, setSmartValueEntered, setTriggerValueChangedEnabled, showErrorPopup, showHelp, transferFocus, transferFocusBackward, triggerValueChanged, wasFocusGainedFromTransfer, wasFocusGainedFromTransferBackward, wasTransferFocus, wasTransferFocusBackward, wasTransferFocusByEnter

Methods inherited from interface org.tentackle.swing.FormChangeableComponent

updateAllChangeable

Methods inherited from interface org.tentackle.swing.FormChangeable

isChangeable, isHonourChangeable, setHonourChangeable

Field Detail

linkedId

protected long linkedId

linkedObject

protected T extends PersistentDomainObject<T> linkedObject

Constructor Detail

PdoFieldPanel

public PdoFieldPanel()

Creates an application database object field panel.

Pressing F2 in the key field will open a search dialog. F3 will edit the object. Drag and drop is supported as well.
By default, the editing component is a StringFormField.

Method Detail

setup

protected void setup()

Sets up the component, drop enabled and clears the object

setName

public void setName(String name)

Overridden to set the names in subcomponents.

Overrides:

setName in class Component

setCheckExistsEnabled

public void setCheckExistsEnabled(boolean checkExistsEnabled)

Sets whether the object exists for given domain key.
If there is no object for given key an error popup will be shown.

Parameters:

checkExistsEnabled - true to enable check, false to disable

isCheckExistsEnabled

public boolean isCheckExistsEnabled()

Gets the check exists feature.

Returns:

true if check is enabled (default)

setFormComponent

public void setFormComponent(FormComponent comp)

Overrides:

setFormComponent in class FormComponentPanel

setFormValue

public void setFormValue(Object obj)

Overridden due to binding.
Notice that obj may be null. In such a case the domain context will be retrieved from the bindingProperty DomainContext.class from the formcontainer.

Specified by:

setFormValue in interface FormComponent

Overrides:

setFormValue in class FormComponentPanel

getFormValue

public Object getFormValue()

Overridden due to binding.

Specified by:

getFormValue in interface FormComponent

Overrides:

getFormValue in class FormComponentPanel

checkObject

protected Object checkObject(Object object,
                             Class<T> clazz)

Checks the returned object against null and creates the error popup if enabled.

Parameters:

object - the returned object

clazz - the PDO-class

Returns:

the object

setDropEnabled

public void setDropEnabled(boolean dropEnabled)

Sets the infofield of this linkpanel to be a drop zone.

The default is true.

Parameters:

dropEnabled - true if this is a drop zone, false if not

isDropEnabled

public boolean isDropEnabled()

Returns whether the infofield of this linkpanel is a dropzone.

Returns:

true if this is a drop zone, false if not

findByKey

public T findByKey(Class<T> clazz,
                   DomainContext contextDb,
                   Object key)

Finds an PersistentDomainObject of given class by the key entered in the formfield component.

The default implementation just invokes DomainObject.findByUniqueDomainKey(java.lang.Object).

Parameters:

clazz - the object class

contextDb - the domain context

key - the domain key

Returns:

the object, null if not found

setLink

public void setLink(PdoSearch<T> pdoSearch,
                    long linkedId)

Sets the link.

Parameters:

pdoSearch - is the PdoSearch to be used

linkedId - the original, i.e. current Id of the linked object

setLink

public void setLink(T pdo)

sets the link object (if plugin matches)

Parameters:

pdo - the data object

setLink

public void setLink(Class<T> clazz,
                    DomainContext context,
                    long linkedId,
                    boolean keepPlugin)

Sets the link with default plugin.

Parameters:

clazz - the class of the linked object, e.g. Konto.class

context - is the db-connection with context

linkedId - the original, i.e. current Id of the linked object

keepPlugin - is true if keep plugin if already initialized

setLink

public void setLink(Class<T> clazz,
                    DomainContext context,
                    long linkedId)

Sets the link with default plugin.

Parameters:

clazz - the class of the linked object, e.g. Konto.class

context - is the db-connection with context

linkedId - the original, i.e. current Id of the linked object

getLinkId

public long getLinkId()

Gets the object Id of the link.

Returns:

the object id, 0 = no object linked

getLink

public T getLink()

Gets the object.

Returns:

the data object, null = no object linked

getSearchPlugin

public PdoSearch<T> getSearchPlugin()

Gets the search plugin.

Returns:

the search plugin

setInfoColumns

public void setInfoColumns(int col)

Sets columns of the info field.

Parameters:

col - the columns

getInfoColumns

public int getInfoColumns()

Get columns of info field

Returns:

the columns

updateCodeAndInfoField

public void updateCodeAndInfoField(T linkedObject)

Updates both the code- and the info field. Override this if the default does not match your objects behaviour!

Parameters:

linkedObject - the data object

setInfoFieldVisible

public void setInfoFieldVisible(boolean visible)

Sets the infofield's visibility. Sometimes useful if getTreeText() is not appropriate for non-ShortLongText objects.

Parameters:

visible - true if info field is visible (default)

isInfoFieldVisible

public boolean isInfoFieldVisible()

Gets the infofield's visibility.

Returns:

true if visible

setChangeable

public void setChangeable(boolean changeable)

Specified by:

setChangeable in interface FormChangeable

Overrides:

setChangeable in class FormComponentPanel

setCellEditorUsage

public void setCellEditorUsage(boolean flag)

Specified by:

setCellEditorUsage in interface FormComponent

Overrides:

setCellEditorUsage in class FormComponentPanel

loadObject

protected void loadObject()

Loads the object

updateInfoFieldDropAndColor

protected void updateInfoFieldDropAndColor()

Updates the background color of the infofield.

createSearchDialog

public PdoSearchDialog<T> createSearchDialog()

Creates the search dialog.

Invoked from runSearch().

Returns:

the dialog

runSearch

public void runSearch()

Runs the search

runEdit

public void runEdit()

Edits the object

setEditButtonVisible

public void setEditButtonVisible(boolean visible)

Sets the visibility of the edit button.
Some apps don't want the user to edit the object. The default is visible.

Parameters:

visible - true if editbutton is visible

isEditButtonVisible

public boolean isEditButtonVisible()

Gets the visibility of the edit button.

Returns:

true if editbutton is visible

setSearchButtonVisible

public void setSearchButtonVisible(boolean visible)

Sets the visibility of the search button.
The default is visible.

Parameters:

visible - true if searchbutton is visible

isSearchButtonVisible

public boolean isSearchButtonVisible()

Gets the visibility of the search button.

Returns:

true if searchbutton is visible

getEditButton

public FormButton getEditButton()

Returns the editButton.

Returns:

The editButton

getSearchButton

public FormButton getSearchButton()

Returns the searchButton.

Returns:

The searchButton

dragEnter

public void dragEnter(DropTargetDragEvent event)

Specified by:

dragEnter in interface DropTargetListener

dragExit

public void dragExit(DropTargetEvent event)

Specified by:

dragExit in interface DropTargetListener

dragOver

public void dragOver(DropTargetDragEvent event)

Specified by:

dragOver in interface DropTargetListener

dropActionChanged

public void dropActionChanged(DropTargetDragEvent event)

Specified by:

dropActionChanged in interface DropTargetListener

drop

public void drop(DropTargetDropEvent event)

Specified by:

drop in interface DropTargetListener