org.tentackle.swing.rdc

Class PdoEditDialogPool

java.lang.Object

org.tentackle.swing.rdc.PdoEditDialogPool

@Service(value=PdoEditDialogPool.class)
public class PdoEditDialogPool
extends Object

Pool for PdoEditDialogs.

The pool reduces memory consumption and dialog startup time. Furthermore, it makes sure that each object is being edited only once.

Notice that the pool is not mt-safe (as it is the case with Swing in general).

Author:

harald

Constructor Summary

Constructors

Constructor and Description
PdoEditDialogPool() Creates a dialog pool

Method Summary

Modifier and Type	Method and Description
void	addDialog(PdoEditDialog<?> d) Adds a dialog to the pool.
void	clear() Clears the pool.
<T extends PersistentDomainObject<T>> PdoEditDialog<T>	createPdoEditDialog(Component comp, T pdo, boolean modal) Creates a new PdoEditDialog.
boolean	delete(PersistentDomainObject<?> object) Deletes an Pdo. The user will be prompted for confirmation.
void	disposeAllDialogs() Disposes all dialogs.
<T extends PersistentDomainObject<T>> void	edit(T object) Edits an Pdo in a non-modal dialog.
<T extends PersistentDomainObject<T>> void	edit(T object, boolean disposeOnDeleteOrSave) Edits an Pdo in a non-modal dialog.
<T extends PersistentDomainObject<T>> void	edit(T object, Component comp, boolean disposeOnDeleteOrSave) Edits an Pdo in a non-modal dialog.
<T extends PersistentDomainObject<T>> T	editModal(T object) Edits an Pdo in a modal dialog.
<T extends PersistentDomainObject<T>> T	editModal(T object, Component comp) Edits an Pdo in a modal dialog.
<T extends PersistentDomainObject<T>> PdoEditDialog<T>	getDialog(Class<T> objectClass, boolean modal, boolean changeable) Checks whether an unused dialog can be used from the pool.
static PdoEditDialogPool	getInstance() The singleton.
boolean	isEnabled() Gets the pool's enabled state.
<T extends PersistentDomainObject<T>> PdoEditDialog<T>	isObjectBeingEdited(T object) Determines whether a given object is currently being edited by some other dialog.
<T extends PersistentDomainObject<T>> PdoEditDialog<T>	isObjectBeingEdited(T object, PdoEditDialog<T> exceptMe) Determines whether a given object is currently being edited by some other dialog.
<T extends PersistentDomainObject<T>> PdoEditDialog<T>	isObjectBeingEdited(T object, PdoEditDialog<T> exceptMe, Comparator<? super PersistentDomainObject<?>> comp) Determines whether a given object is currently being edited by some other dialog.
boolean	isPdoEditedOnlyOnce() Returns whether an object is allowed to be edited only once at a time.
void	removeDialog(PdoEditDialog<?> d) Removes a dialog from the pool.
void	setEnabled(boolean enabled) Sets the pool's enabled state.
void	setPdoEditedOnlyOnce(boolean pdoEditedOnlyOnce) Sets whether an object is allowed to be edited only once at a time.
<T extends PersistentDomainObject<T>> T	useModalDialog(Component comp, T object, boolean changeable) Gets a modal dialog ready for use.
<T extends PersistentDomainObject<T>> T	useModalDialog(Component comp, T object, boolean changeable, boolean noPersistence) Gets a modal dialog ready for use. Will re-use a pooled dialog if possible, otherwise creates a new one.
<T extends PersistentDomainObject<T>> T	useModalDialog(T object, boolean changeable) Gets a modal dialog ready for use.
<T extends PersistentDomainObject<T>> PdoEditDialog<T>	useNonModalDialog(Component comp, T object, boolean changeable) Gets a non-modal dialog ready for use.
<T extends PersistentDomainObject<T>> PdoEditDialog<T>	useNonModalDialog(Component comp, T pdo, boolean changeable, boolean noPersistence, boolean disposeOnDeleteOrSave) Gets a non-modal dialog ready for use.
<T extends PersistentDomainObject<T>> PdoEditDialog<T>	useNonModalDialog(T object, boolean changeable) Gets a non-modal dialog ready for use.
<T extends PersistentDomainObject<T>> PdoEditDialog<T>	useNonModalDialog(T object, boolean changeable, boolean disposeOnDeleteOrSave) Gets a non-modal dialog ready for use.
<T extends PersistentDomainObject<T>> void	view(T object) Shows an Pdo in a non-modal dialog.
<T extends PersistentDomainObject<T>> void	view(T object, Component comp) Shows an Pdo in a non-modal dialog.
<T extends PersistentDomainObject<T>> void	viewModal(T object) Shows an Pdo in a modal dialog.
<T extends PersistentDomainObject<T>> void	viewModal(T object, Component comp) Shows an Pdo in a modal dialog.

Methods inherited from class java.lang.Object

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

Constructor Detail

PdoEditDialogPool

public PdoEditDialogPool()

Creates a dialog pool

Method Detail

getInstance

public static PdoEditDialogPool getInstance()

The singleton.

Returns:

the singleton

isEnabled

public boolean isEnabled()

Gets the pool's enabled state.

Returns:

true if pool is enabled (default)

setEnabled

public void setEnabled(boolean enabled)

Sets the pool's enabled state.

Parameters:

enabled - true if pool is enabled

isPdoEditedOnlyOnce

public boolean isPdoEditedOnlyOnce()

Returns whether an object is allowed to be edited only once at a time.

Returns:

true if objects must not be edited more than once (default)

setPdoEditedOnlyOnce

public void setPdoEditedOnlyOnce(boolean pdoEditedOnlyOnce)

Sets whether an object is allowed to be edited only once at a time.

Parameters:

pdoEditedOnlyOnce - true if objects must not be edited more than once (default)

isObjectBeingEdited

public <T extends PersistentDomainObject<T>> PdoEditDialog<T> isObjectBeingEdited(T object,
                                                                                  PdoEditDialog<T> exceptMe,
                                                                                  Comparator<? super PersistentDomainObject<?>> comp)

Determines whether a given object is currently being edited by some other dialog.

Type Parameters:

T - the pdo type

Parameters:

object - the database object

exceptMe - the dialog to exclude from the check, null = none

comp - the optional comparator, null if "equals"

Returns:

the dialog that is already editing given object

isObjectBeingEdited

public <T extends PersistentDomainObject<T>> PdoEditDialog<T> isObjectBeingEdited(T object,
                                                                                  PdoEditDialog<T> exceptMe)

Determines whether a given object is currently being edited by some other dialog.

Type Parameters:

T - the pdo type

Parameters:

object - the database object

exceptMe - the dialog to exclude from the check, null = none

Returns:

the dialog that is already editing given object

isObjectBeingEdited

public <T extends PersistentDomainObject<T>> PdoEditDialog<T> isObjectBeingEdited(T object)

Determines whether a given object is currently being edited by some other dialog.

Type Parameters:

T - the pdo type

Parameters:

object - the database object

Returns:

the dialog that is already editing given object

getDialog

public <T extends PersistentDomainObject<T>> PdoEditDialog<T> getDialog(Class<T> objectClass,
                                                                        boolean modal,
                                                                        boolean changeable)

Checks whether an unused dialog can be used from the pool.

Type Parameters:

T - the pdo type

Parameters:

objectClass - the data object class

modal - true if dialog must be modal

changeable - true if dialog must be changeable, false if view-only dialog

Returns:

the dialog, null if no such dialog in pool

createPdoEditDialog

public <T extends PersistentDomainObject<T>> PdoEditDialog<T> createPdoEditDialog(Component comp,
                                                                                  T pdo,
                                                                                  boolean modal)

Creates a new PdoEditDialog.

Type Parameters:

T - the pdo type

Parameters:

comp - the component to determine the window owner, null if none

pdo - the object template to create a dialog for

modal - true if dialog should be modal

Returns:

the created dialog

addDialog

public void addDialog(PdoEditDialog<?> d)

Adds a dialog to the pool.

Parameters:

d - the dialog to add

removeDialog

public void removeDialog(PdoEditDialog<?> d)

Removes a dialog from the pool.

Parameters:

d - the dialog to remove

clear

public void clear()

Clears the pool.

disposeAllDialogs

public void disposeAllDialogs()

Disposes all dialogs.

useModalDialog

public <T extends PersistentDomainObject<T>> T useModalDialog(Component comp,
                                                              T object,
                                                              boolean changeable,
                                                              boolean noPersistence)

Gets a modal dialog ready for use.
Will re-use a pooled dialog if possible, otherwise creates a new one.

Type Parameters:

T - the pdo type

Parameters:

comp - the component to determine the owner window for

object - the database object

changeable - true if dialog must be changeable, false if view-only dialog

noPersistence - true if NO changes must be made to persistance layer

Returns:

the object

useModalDialog

public <T extends PersistentDomainObject<T>> T useModalDialog(Component comp,
                                                              T object,
                                                              boolean changeable)

Gets a modal dialog ready for use. Will re-use a pooled dialog if possible, otherwise creates a new one.

Type Parameters:

T - the pdo type

Parameters:

comp - the component to determine the owner window for

object - the database object

changeable - true if dialog must be changeable, false if view-only dialog

Returns:

the object

useModalDialog

public <T extends PersistentDomainObject<T>> T useModalDialog(T object,
                                                              boolean changeable)

Gets a modal dialog ready for use. Will re-use a pooled dialog if possible, otherwise creates a new one.

Type Parameters:

T - the pdo type

Parameters:

object - the database object

changeable - true if dialog must be changeable, false if view-only dialog

Returns:

the dialog, never null

useNonModalDialog

public <T extends PersistentDomainObject<T>> PdoEditDialog<T> useNonModalDialog(Component comp,
                                                                                T pdo,
                                                                                boolean changeable,
                                                                                boolean noPersistence,
                                                                                boolean disposeOnDeleteOrSave)

Gets a non-modal dialog ready for use. Will re-use a pooled dialog if possible, otherwise creates a new one.

Type Parameters:

T - the pdo type

Parameters:

comp - the component to determine the owner window for

pdo - the PDO

changeable - true if dialog must be changeable, false if view-only dialog

noPersistence - true if NO changes must be made to persistance layer

disposeOnDeleteOrSave - true if dispose dialog after delete or save

Returns:

the dialog, never null

useNonModalDialog

public <T extends PersistentDomainObject<T>> PdoEditDialog<T> useNonModalDialog(T object,
                                                                                boolean changeable,
                                                                                boolean disposeOnDeleteOrSave)

Gets a non-modal dialog ready for use. Will re-use a pooled dialog if possible, otherwise creates a new one.

Type Parameters:

T - the pdo type

Parameters:

object - the database object

changeable - true if dialog must be changeable, false if view-only dialog

disposeOnDeleteOrSave - true if dispose dialog after delete or save

Returns:

the dialog, never null

useNonModalDialog

public <T extends PersistentDomainObject<T>> PdoEditDialog<T> useNonModalDialog(Component comp,
                                                                                T object,
                                                                                boolean changeable)

Gets a non-modal dialog ready for use. Will re-use a pooled dialog if possible, otherwise creates a new one.

Type Parameters:

T - the pdo type

Parameters:

comp - the component to determine the owner window for

object - the database object

changeable - true if dialog must be changeable, false if view-only dialog

Returns:

the dialog, never null

useNonModalDialog

public <T extends PersistentDomainObject<T>> PdoEditDialog<T> useNonModalDialog(T object,
                                                                                boolean changeable)

Gets a non-modal dialog ready for use. Will re-use a pooled dialog if possible, otherwise creates a new one.

Type Parameters:

T - the pdo type

Parameters:

object - the database object

changeable - true if dialog must be changeable, false if view-only dialog

Returns:

the dialog, never null

view

public <T extends PersistentDomainObject<T>> void view(T object,
                                                       Component comp)

Shows an Pdo in a non-modal dialog.

Type Parameters:

T - the PDO type

Parameters:

object - the Pdo to view-only

comp - optional component to determine the window owner, null = no owner

view

public <T extends PersistentDomainObject<T>> void view(T object)

Shows an Pdo in a non-modal dialog.

Type Parameters:

T - the PDO type

Parameters:

object - the Pdo to view-only

viewModal

public <T extends PersistentDomainObject<T>> void viewModal(T object,
                                                            Component comp)

Shows an Pdo in a modal dialog.

Type Parameters:

T - the PDO type

Parameters:

object - the Pdo to view-only

comp - optional component to determine the window owner, null = no owner

viewModal

public <T extends PersistentDomainObject<T>> void viewModal(T object)

Shows an Pdo in a modal dialog.

Type Parameters:

T - the PDO type

Parameters:

object - the Pdo to view-only

edit

public <T extends PersistentDomainObject<T>> void edit(T object,
                                                       Component comp,
                                                       boolean disposeOnDeleteOrSave)

Edits an Pdo in a non-modal dialog.

Type Parameters:

T - the PDO type

Parameters:

object - the Pdo to edit

comp - optional component to determine the window owner, null = no owner

disposeOnDeleteOrSave - true if dispose dialog after delete or save

edit

public <T extends PersistentDomainObject<T>> void edit(T object,
                                                       boolean disposeOnDeleteOrSave)

Edits an Pdo in a non-modal dialog.

Type Parameters:

T - the PDO type

Parameters:

object - the Pdo to edit

disposeOnDeleteOrSave - true if dispose dialog after delete or save

edit

public <T extends PersistentDomainObject<T>> void edit(T object)

Edits an Pdo in a non-modal dialog.

Type Parameters:

T - the PDO type

Parameters:

object - the Pdo to edit

editModal

public <T extends PersistentDomainObject<T>> T editModal(T object,
                                                         Component comp)

Edits an Pdo in a modal dialog.

Type Parameters:

T - the PDO type

Parameters:

object - the Pdo to edit

comp - optional component to determine the window owner, null = no owner

Returns:

the (possibly reloaded) object, null if cancel.

editModal

public <T extends PersistentDomainObject<T>> T editModal(T object)

Edits an Pdo in a modal dialog.

Type Parameters:

T - the PDO type

Parameters:

object - the Pdo to edit

Returns:

the (possibly reloaded) object, null if cancel.

delete

public boolean delete(PersistentDomainObject<?> object)

Deletes an Pdo.
The user will be prompted for confirmation. If the delete fails, an error message will be displayed.

Parameters:

object - the Pdo to delete

Returns:

true if deleted, false if user aborted or delete error.