org.tentackle.swing.rdc

Class PdoPanel<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.rdc.PdoPanel<T>

Type Parameters:

T - the PDO type

All Implemented Interfaces:

ContainerListener, ImageObserver, MenuContainer, Pageable, Printable, Serializable, EventListener, Accessible, DomainContextProvider, FormChangeable, FormContainer

public class PdoPanel<T extends PersistentDomainObject<T>>
extends FormPanel
implements DomainContextProvider, Printable, Pageable

Panel to view and/or edit an PersistentDomainObject.

The panel is designed to used as a plugin by PdoEditDialog. Notice: the class should be abstract but most GUI-designers cannot handle abstract classes and need a bean to instantiate. Hence, some methods that should be abstract as well are non-abstract default implementations that *must* be overridden.

Author:

harald

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

Field Summary

Fields

Modifier and Type	Field and Description
protected PdoEditDialog<T>	dialog the enclosing PdoEditDialog, null if none

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.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Fields inherited from interface java.awt.print.Pageable

UNKNOWN_NUMBER_OF_PAGES

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
PdoPanel()

Method Summary

Modifier and Type	Method and Description
boolean	announceDelete() Announce that a delete is going to happen. As opposed to prepareDelete() this method is invoked by PdoEditDialog before the transaction is started.
boolean	announceSave() Announce that a save is going to happen. As opposed to prepareSave() this method is invoked by PdoEditDialog before the transaction is started.
InteractiveError	createInteractiveError(org.tentackle.validate.ValidationResult validationResult) Creates an interactive error from a validation result.
List<InteractiveError>	createInteractiveErrors(List<org.tentackle.validate.ValidationResult> validationResults) Creates interactive errors from validation results.
DomainContext	getDomainContext()
int	getNumberOfPages()
Pageable	getPageable(PrinterJob printJob) Gets the Pageable of this panel. PdoEditDialog invokes this method if the "print" button is pressed.
PageFormat	getPageFormat(int pageIndex)
T	getPdo() Gets the currently displayed database object.
PdoEditDialog<T>	getPdoEditDialog() Gets the parent PdoEditDialog.
Printable	getPrintable(int pageIndex)
Printable	getPrintable(PrinterJob printJob) Gets the Printable of this panel. PdoEditDialog invokes this method if the "print" button is pressed and getPageable() returned null.
String	getTitle()
void	markPrinted() Indicates a successful printout. The default implementation does nothing.
void	pack() Packs the parent window.
boolean	prepareCancel() Prepares the cancel operation. Invoked when the dialog is closed or the object is removed from the panel in general.
boolean	prepareDelete() Prepares to delete the current object. Invoked when the user wants to delete the current object (presses the "delete" button, for example).
boolean	prepareNew() Prepares to create a new object. Invoked when the user instantiates a new object (presses the "new" button, for example).
boolean	prepareSave() Checks the object for consistency before it is saved. This method must *NOT* do any modifications to the database.
boolean	prepareSearch() Prepares to search for objects. Invoked when the user wants to search for objects (presses the "search" button, for example).
int	print(Graphics graphics, PageFormat pageFormat, int pageIndex)
void	setInitialFocus() Sets the initial focus. Usually requests the focus for the top left component.
boolean	setPdo(T object) Sets the database object and updates the view.
void	setPdoEditDialog(PdoEditDialog<T> dialog) Sets the parent PdoEditDialog.
List<InteractiveError>	verifyObject() Verifies the data object.

Methods inherited from class org.tentackle.swing.FormPanel

addActionListener, areValuesChanged, componentAdded, componentRemoved, createBinder, fireActionPerformed, getBinder, getFormValues, getHelpURL, getParentWindow, getPropertyGroup, invalidateParentInfo, isAutoUpdate, isBindable, isChangeable, isHonourChangeable, isTriggerValuesChangedEnabled, removeActionListener, saveValues, setAutoUpdate, setBindable, setChangeable, setFormValues, setFormValuesKeepChanged, setHelpURL, setHonourChangeable, setPropertyGroup, setTitle, setTriggerValuesChangedEnabled, showHelp, 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, 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, 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, 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.pdo.DomainContextProvider

on, op

Field Detail

dialog

protected PdoEditDialog<T extends PersistentDomainObject<T>> dialog

the enclosing PdoEditDialog, null if none

Constructor Detail

PdoPanel

public PdoPanel()

Method Detail

setPdo

@Bindable
public boolean setPdo(T object)

Sets the database object and updates the view.

The default implementation returns false. Must be overridden!

Parameters:

object - the database object

Returns:

true if object accepted

getPdo

@Bindable
public T getPdo()

Gets the currently displayed database object.

The default implementation returns null. Must be overridden!

Returns:

the database object

getDomainContext

public DomainContext getDomainContext()

Specified by:

getDomainContext in interface DomainContextProvider

verifyObject

public List<InteractiveError> verifyObject()

Verifies the data object.

Holds verification before the object is actually saved.

Returns:

the list of errors, never null

prepareSave

public boolean prepareSave()

Checks the object for consistency before it is saved.
This method must *NOT* do any modifications to the database. It is invoked from PdoEditDialog within the transaction of saving the object.

The default implementation invokes verifyObject().

Returns:

true if continue tx, false if rollback tx

prepareCancel

public boolean prepareCancel()

Prepares the cancel operation.
Invoked when the dialog is closed or the object is removed from the panel in general.

The default implementation returns true.

Returns:

true if cancel is ok, false if not

prepareNew

public boolean prepareNew()

Prepares to create a new object.
Invoked when the user instantiates a new object (presses the "new" button, for example).

The default implementation returns true.

Returns:

true if creating new object is ok, false if not

prepareSearch

public boolean prepareSearch()

Prepares to search for objects.
Invoked when the user wants to search for objects (presses the "search" button, for example).

The default implementation returns true.

Returns:

true if search is ok, false if not

prepareDelete

public boolean prepareDelete()

Prepares to delete the current object.
Invoked when the user wants to delete the current object (presses the "delete" button, for example).

This method must *NOT* do any modifications to the database. It is invoked from PdoEditDialog within the transaction deleting the object.

The default implementation returns true.

Returns:

true if delete is ok, false if not

announceDelete

public boolean announceDelete()

Announce that a delete is going to happen.
As opposed to prepareDelete() this method is invoked by PdoEditDialog before the transaction is started.

The default implementation returns true.

Returns:

true if continue with delete, false if abort

announceSave

public boolean announceSave()

Announce that a save is going to happen.
As opposed to prepareSave() this method is invoked by PdoEditDialog before the transaction is started.

The default implementation returns true.

Returns:

true if continue with delete, false if abort

createInteractiveError

public InteractiveError createInteractiveError(org.tentackle.validate.ValidationResult validationResult)

Creates an interactive error from a validation result.

Parameters:

validationResult - the validation result

Returns:

the interactive error

createInteractiveErrors

public List<InteractiveError> createInteractiveErrors(List<org.tentackle.validate.ValidationResult> validationResults)

Creates interactive errors from validation results.

Parameters:

validationResults - the validation results

Returns:

the interactive errors

setPdoEditDialog

public void setPdoEditDialog(PdoEditDialog<T> dialog)

Sets the parent PdoEditDialog.

Invoked from PdoEditDialog when this panel is "plugged in".

Parameters:

dialog - the parent dialog

getPdoEditDialog

public PdoEditDialog<T> getPdoEditDialog()

Gets the parent PdoEditDialog.

Returns:

the parent dialog, null if this panel is not a child of an PdoEditDialog.

setInitialFocus

public void setInitialFocus()

Sets the initial focus.
Usually requests the focus for the top left component. The default implementation does nothing. Must be overridden!

getTitle

public String getTitle()

Overridden to generate the title from the current object if title is null.

Specified by:

getTitle in interface FormContainer

Overrides:

getTitle in class FormPanel

pack

public void pack()

Packs the parent window.

getPageable

public Pageable getPageable(PrinterJob printJob)

Gets the Pageable of this panel.
PdoEditDialog invokes this method if the "print" button is pressed. If this method returns null, getPrintable() will be invoked. The default implementation returns null.

Parameters:

printJob - the printer job

Returns:

the pageable, null if try getPrintable

getPrintable

public Printable getPrintable(PrinterJob printJob)

Gets the Printable of this panel.
PdoEditDialog invokes this method if the "print" button is pressed and getPageable() returned null. The default implementation returns this, which is simply a screendump of this panel.

Parameters:

printJob - the printer job

Returns:

the printable, null if printing is disabled

markPrinted

public void markPrinted()

Indicates a successful printout.
The default implementation does nothing. Can be used to set a printing date in an object or alike.

print

public int print(Graphics graphics,
                 PageFormat pageFormat,
                 int pageIndex)

The default implementation prints a screendump of this panel.

Specified by:

print in interface Printable

getPrintable

public Printable getPrintable(int pageIndex)

The default implementation returns this.

Specified by:

getPrintable in interface Pageable

getPageFormat

public PageFormat getPageFormat(int pageIndex)

The default implementation returns the default pageformat of the printjob.

Specified by:

getPageFormat in interface Pageable

getNumberOfPages

public int getNumberOfPages()

The default implementation returns UNKNOWN_NUMBER_OF_PAGES.

Specified by:

getNumberOfPages in interface Pageable