org.tentackle.swing.rdc

Class PdoSearchDialog<T extends PersistentDomainObject<T>>

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

org.tentackle.swing.FormDialog

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

Type Parameters:

T - the pdo type

All Implemented Interfaces:

ContainerListener, ImageObserver, KeyEventDispatcher, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants, FormChangeable, FormContainer, FormWindow

public class PdoSearchDialog<T extends PersistentDomainObject<T>>
extends FormDialog
implements KeyEventDispatcher

A generic search dialog.

Author:

harald

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JDialog

JDialog.AccessibleJDialog

Nested classes/interfaces inherited from class java.awt.Dialog

Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType

Nested classes/interfaces inherited from class java.awt.Window

Window.AccessibleAWTWindow, Window.Type

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 inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
PdoSearchDialog(DomainContext context, Class<T> pdoClass, SelectionFilter selectionFilter, boolean allowCreate, boolean modal) Creates a search dialog.
PdoSearchDialog(Window owner, DomainContext context, Class<T> pdoClass, SelectionFilter selectionFilter, boolean allowCreate, boolean modal) Creates a search dialog.
PdoSearchDialog(Window owner, PdoSearch<T> pdoSearch, SelectionFilter selectionFilter, boolean allowCreate, boolean modal) Creates a search dialog.

Method Summary

Modifier and Type	Method and Description
boolean	checkAutoClose()
protected void	clearResult() Clears the search result.
PdoNavigationPanel<T>	createNavigationPanel() Creates the navigation panel.
protected PdoSearch<T>	createPdoSearch(DomainContext context, Class<T> searchClass) Creates the default pdo search from the GUI-provider according to given PDO class.
boolean	dispatchKeyEvent(KeyEvent e) dispatch the special keys
protected void	doCancel() Cancels the dialog. (clears the selection and the search parameter).
protected void	doMoreSearch() Search in results.
PdoNavigationPanel<T>	getNaviPanel() Gives access to the current navigation panel.
List<T>	getObjects() Gets the list of all objects.
PdoSearch<T>	getPdoSearch() get the search plugin.
PersistentDomainObject<?>	getSelectedObject() Gets the (first) selected object.
List<PersistentDomainObject<?>>	getSelectedObjects() Gets the list of all selected objects.
SelectionFilter	getSelectionFilter() Gets the selection filter.
boolean	isAllowCreate() Gets the allowcreate flag.
boolean	isAutoSelectFirstItem() Returns whether the first object is automatically selected or not.
boolean	isMultiSelection() Returns whether multiple selections are allowed or not.
boolean	isShowMessageIfNotFound() Returns whether a message should be displayed if no object is found.
protected void	processWindowEvent(WindowEvent e)
protected void	runSearch() Runs the search.
void	setAutoSelectFirstItem(boolean autoSelectFistItem) Sets whether the first object is automatically selected or not.
void	setButtonsEnabled(boolean flag) Enables/disables all buttons.
protected void	setInitialFocus() Sets the focus to the initial or first component.
void	setMultiSelection(boolean multiSelection) Sets whether multiple selections are allowed or not.
void	setPdoSearch(PdoSearch<T> pdoSearch) Set the search plugin (if custom).
void	setShowMessageIfNotFound(boolean showMessageIfNotFound) Sets whether a message should be displayed if no object is found.
protected void	setup(DomainContext context, Class<T> pdoClass, SelectionFilter selectionFilter, boolean allowCreate) Sets up the dialog by context and searchclass.
protected void	setup(PdoSearch<T> pdoSearch, SelectionFilter selectionFilter, boolean allowCreate) Sets up the dialog by plugin.
PersistentDomainObject<?>	showDialog() Shows the dialog (modal or non-modal).
protected void	updateResult(List<T> list) Updates the list of objects in the navigation panel.

Methods inherited from class org.tentackle.swing.FormDialog

addFormWrapListener, alignLocation, areValuesChanged, componentAdded, componentRemoved, createBinder, fireFormWrappedFocus, getAutoClose, getBinder, getFormValues, getHelpURL, getKeepChangedValues, getParentWindow, getRelatedWindow, getTimeOfLastValuesChanged, getTooltipDisplay, getUIVersion, invalidateParentInfo, isAutoCloseable, isAutoPosition, isAutoUpdate, isBindable, isChangeable, isHonourChangeable, isTriggerValuesChangedEnabled, pack, paint, removeFormWrapListener, saveValues, setAutoClose, setAutoPosition, setAutoUpdate, setBindable, setChangeable, setFormValues, setFormValuesKeepChanged, setHelpURL, setHonourChangeable, setKeepChangedValues, setRelatedWindow, setTimeOfLastValuesChanged, setTooltipDisplay, setTriggerValuesChangedEnabled, setUIVersion, showHelp, triggerValuesChanged

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, setVisible, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, 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.FormContainer

getTitle, setTitle

Constructor Detail

PdoSearchDialog

public PdoSearchDialog(Window owner,
                       DomainContext context,
                       Class<T> pdoClass,
                       SelectionFilter selectionFilter,
                       boolean allowCreate,
                       boolean modal)

Creates a search dialog.

Parameters:

owner - the owner window, null if none

context - the database context

pdoClass - the PDO class to search

selectionFilter - the section filter, null if all of PDO class are allowed

allowCreate - true if "new"-button for creation of a new object of searchClass

modal - true if modal dialog

PdoSearchDialog

public PdoSearchDialog(DomainContext context,
                       Class<T> pdoClass,
                       SelectionFilter selectionFilter,
                       boolean allowCreate,
                       boolean modal)

Creates a search dialog.

Parameters:

context - the database context

pdoClass - the object class'es table to search in

selectionFilter - the section filter, null if all of PDO class are allowed

allowCreate - true if "new"-button for creation of a new object of searchClass

modal - true if modal dialog

PdoSearchDialog

public PdoSearchDialog(Window owner,
                       PdoSearch<T> pdoSearch,
                       SelectionFilter selectionFilter,
                       boolean allowCreate,
                       boolean modal)

Creates a search dialog.

Parameters:

owner - the owner window, null if none

pdoSearch - the search plugin

selectionFilter - the section filter, null if all of PDO class are allowed

allowCreate - true if "new"-button for creation of a new object of searchClass

modal - true if modal dialog

Method Detail

getSelectionFilter

public SelectionFilter getSelectionFilter()

Gets the selection filter.

Returns:

the selection filter, null if all of PDO class are allowed

isAllowCreate

public boolean isAllowCreate()

Gets the allowcreate flag.

Returns:

true if "new"-button for creation of a new object of searchClass

getPdoSearch

public PdoSearch<T> getPdoSearch()

get the search plugin.

Returns:

Value of property pdoSearch.

setPdoSearch

public void setPdoSearch(PdoSearch<T> pdoSearch)

Set the search plugin (if custom).

Parameters:

pdoSearch - New value of property pdoSearch.

checkAutoClose

public boolean checkAutoClose()

Overridden to allow autoclosing whether the values in search panels are changed or not.
The time of last change is set in updateResult() and whenever a field is changed.

Specified by:

checkAutoClose in interface FormWindow

Overrides:

checkAutoClose in class FormDialog

setButtonsEnabled

public void setButtonsEnabled(boolean flag)

Enables/disables all buttons.

Notice: the buttons of the plugin panel are not modified.

Parameters:

flag - true if all buttons enabled, false if all disabled

getNaviPanel

public PdoNavigationPanel<T> getNaviPanel()

Gives access to the current navigation panel.

Returns:

the navigation panel

setMultiSelection

public void setMultiSelection(boolean multiSelection)

Sets whether multiple selections are allowed or not.

Parameters:

multiSelection - true if allowed, false if only single object (default)

isMultiSelection

public boolean isMultiSelection()

Returns whether multiple selections are allowed or not.

Returns:

true if allowed, false if only single object (default)

setAutoSelectFirstItem

public void setAutoSelectFirstItem(boolean autoSelectFistItem)

Sets whether the first object is automatically selected or not.

Parameters:

autoSelectFistItem - true if selected, false if not (default)

isAutoSelectFirstItem

public boolean isAutoSelectFirstItem()

Returns whether the first object is automatically selected or not.

Returns:

true if selected, false if not (default)

showDialog

public PersistentDomainObject<?> showDialog()

Shows the dialog (modal or non-modal).

Notice: if multiSelection=true the first selected object is returned. U se getSelectedObjects() to get all objects

Returns:

the selected object, null if nothing selected or non-modal

getSelectedObject

public PersistentDomainObject<?> getSelectedObject()

Gets the (first) selected object.

Returns:

the selected object, null if none

getSelectedObjects

public List<PersistentDomainObject<?>> getSelectedObjects()

Gets the list of all selected objects.

Returns:

the selected objects, null if none

getObjects

public List<T> getObjects()

Gets the list of all objects.

Returns:

the list of all objects

isShowMessageIfNotFound

public boolean isShowMessageIfNotFound()

Returns whether a message should be displayed if no object is found.

Returns:

true if show (default), false if don't show

setShowMessageIfNotFound

public void setShowMessageIfNotFound(boolean showMessageIfNotFound)

Sets whether a message should be displayed if no object is found.

Parameters:

showMessageIfNotFound - true if show (default), false if don't show

dispatchKeyEvent

public boolean dispatchKeyEvent(KeyEvent e)

dispatch the special keys

Specified by:

dispatchKeyEvent in interface KeyEventDispatcher

processWindowEvent

protected void processWindowEvent(WindowEvent e)

Overridden to catch WINDOW_CLOSING event.

Overrides:

processWindowEvent in class FormDialog

runSearch

protected void runSearch()

Runs the search.

Depending on the search parameter the search is run in a separate thread.

setInitialFocus

protected void setInitialFocus()

Sets the focus to the initial or first component.

doMoreSearch

protected void doMoreSearch()

Search in results.

createNavigationPanel

public PdoNavigationPanel<T> createNavigationPanel()

Creates the navigation panel.

Returns:

the navi panel

updateResult

protected void updateResult(List<T> list)

Updates the list of objects in the navigation panel.

Parameters:

list - the list of objects

doCancel

protected void doCancel()

Cancels the dialog.
(clears the selection and the search parameter).

createPdoSearch

protected PdoSearch<T> createPdoSearch(DomainContext context,
                                       Class<T> searchClass)

Creates the default pdo search from the GUI-provider according to given PDO class.

Parameters:

context - the database context

searchClass - the allowed selections

Returns:

the plugin

setup

protected void setup(DomainContext context,
                     Class<T> pdoClass,
                     SelectionFilter selectionFilter,
                     boolean allowCreate)

Sets up the dialog by context and searchclass.

Parameters:

context - the database context

pdoClass - the object class'es table to search in

selectionFilter - the filter for allowed selections

allowCreate - true if "new"-button for creation of a new object of searchClass

setup

protected void setup(PdoSearch<T> pdoSearch,
                     SelectionFilter selectionFilter,
                     boolean allowCreate)

Sets up the dialog by plugin.

Parameters:

pdoSearch - the search plugin

selectionFilter - the filter for allowed selections

allowCreate - true if "new"-button for creation of a new object of searchClass

clearResult

protected void clearResult()

Clears the search result.