org.tentackle.swing.rdc

Interface GuiProvider<T extends PersistentDomainObject<T>>

Type Parameters:

T - the PDO type

All Superinterfaces:

DomainContextProvider, org.tentackle.reflect.Interceptable, PdoHolder<T>

All Known Implementing Classes:

DefaultGuiProvider, SecurityGuiProvider

public interface GuiProvider<T extends PersistentDomainObject<T>>
extends PdoHolder<T>, DomainContextProvider

Provider of GUI-functionality for a pdo.

Author:

harald

Method Summary

Modifier and Type	Method and Description
boolean	allowsTreeChildObjects() Determines whether this object may have child objects that should be visible in a navigatable tree.
boolean	allowsTreeParentObjects() Determines whether the navigatable object tree should show the parents of this object. Objects may be childs of different parents in terms of "being referenced from" or any other relation, for example: the warehouses this customer visited.
PdoEditDialog<T>	createDialog(Component comp, boolean modal) Creates a new dialog to edit this object.
FormPanel	createPanel() Creates a panel to edit or view this object.
PdoSearch<T>	createPdoSearch() Creates the search plugin for the search dialog.
boolean	dropTransferable(Transferable transferable) Drops a transferable on this object.
FormTableEntry<T>	getFormTableEntry() Gets the table entry for viewing lists of this object in a FormTable.
String	getFormTableName() Gets the tablename used in to initialize the table's gui.
ImageIcon	getIcon() Gets the PDO's icon. The icon is displayed in trees, for example.
T	getPanelObject() Gets the effective object that should be edited or viewed in a panel.
String	getToolTipText() Gets the tooltip to be displayed for an object in a tree.
String	getToolTipText(Object parent) Gets the tooltip text with respect to the parent object this object is displayed in a tree.
PdoTransferable<T>	getTransferable() Gets the Transferable for this object. Used for drag and drop.
Collection	getTreeChildObjects() Gets all childs of this objects that should be visible to the user in a navigatable object tree.
Collection	getTreeChildObjects(Object parentObject) Gets the childs with respect to the parent object this object is displayed in the current tree.
int	getTreeExpandMaxDepth() Gets the maximum level of expansion allowed in a navigatable object tree. The default is 0, i.e.
org.tentackle.misc.ObjectFilter<T>	getTreeFilter() Gets the optional tree-view filter. The filter is used in PdoNavigationPanel to show only certain objects in the tree view as root nodes.
Collection	getTreeParentObjects() Gets the parents of this object.
Collection	getTreeParentObjects(Object parentObject) Gets the parents with respect to the parent object this object is displayed in the current tree.
T	getTreeRoot() Gets the object to be displayed in trees in place of this object.
String	getTreeText() Gets the text to be displayed in trees for this object.
String	getTreeText(Object parent) Gets the tree text with respect to the parent object this object is displayed in a tree.
boolean	panelExists() Determines whether a panel exists to edit or view this object.
boolean	stopTreeExpansion() Determines whether tree explansion should stop at this object. Sometimes treechilds should not be expanded if in a recursive "expand all".

Methods inherited from interface org.tentackle.pdo.PdoHolder

getPdo, on, setPdo

Methods inherited from interface org.tentackle.pdo.DomainContextProvider

getDomainContext, on, op

Method Detail

getIcon

ImageIcon getIcon()

Gets the PDO's icon.
The icon is displayed in trees, for example.

Returns:

the icon

panelExists

boolean panelExists()

Determines whether a panel exists to edit or view this object. The default is false.

Returns:

true if a panel exists

See Also:

createPanel()

createPanel

FormPanel createPanel()

Creates a panel to edit or view this object. The default implementation returns null.

Returns:

the panel, null if none

See Also:

panelExists()

createDialog

PdoEditDialog<T> createDialog(Component comp,
                              boolean modal)

Creates a new dialog to edit this object.

Parameters:

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

modal - true if dialog should be modal

Returns:

the dialog or null if use default

getPanelObject

T getPanelObject()

Gets the effective object that should be edited or viewed in a panel.

Returns:

the object to be edited or viewed in a panel

getTransferable

PdoTransferable<T> getTransferable()

Gets the Transferable for this object.
Used for drag and drop. If the object is new, null is returned because the object has no ID yet.

Returns:

the transferable, null if none

See Also:

PdoTransferable

dropTransferable

boolean dropTransferable(Transferable transferable)

Drops a transferable on this object.

Parameters:

transferable - the Transferable

Returns:

true if drop succeeded, else false

getTreeRoot

T getTreeRoot()

Gets the object to be displayed in trees in place of this object. The default implementation returns "this". Override if necessary.

Returns:

the object to be displayed in a tree instead of this.

See Also:

PdoTree

getTreeText

String getTreeText()

Gets the text to be displayed in trees for this object.

Returns:

the tree text

See Also:

PdoTree

getTreeText

String getTreeText(Object parent)

Gets the tree text with respect to the parent object this object is displayed in a tree.

Parameters:

parent - is the parent object, null if no parent

Returns:

the tree text

See Also:

PdoTree

getToolTipText

String getToolTipText()

Gets the tooltip to be displayed for an object in a tree.

Returns:

the tooltip text

See Also:

PdoTree

getToolTipText

String getToolTipText(Object parent)

Gets the tooltip text with respect to the parent object this object is displayed in a tree.

Parameters:

parent - is the parent object, null if no parent

Returns:

the tooltip text

See Also:

PdoTree

stopTreeExpansion

boolean stopTreeExpansion()

Determines whether tree explansion should stop at this object.
Sometimes treechilds should not be expanded if in a recursive "expand all". However they should expand if the user explicitly wants to. If this method returns true, the tree will not further expand this node automatically (only on demand).

Returns:

true if expansion should stop.

See Also:

PdoTree

getTreeFilter

org.tentackle.misc.ObjectFilter<T> getTreeFilter()

Gets the optional tree-view filter.
The filter is used in PdoNavigationPanel to show only certain objects in the tree view as root nodes. Nice for hierarchical data.

Returns:

the filter, null if none

allowsTreeChildObjects

boolean allowsTreeChildObjects()

Determines whether this object may have child objects that should be visible in a navigatable tree.

Returns:

true if object may have childs

See Also:

PdoTree

getTreeChildObjects

Collection getTreeChildObjects()

Gets all childs of this objects that should be visible to the user in a navigatable object tree.

Returns:

the childs (may be of any type, not only PDOs, and mixed!)

See Also:

PdoTree

getTreeChildObjects

Collection getTreeChildObjects(Object parentObject)

Gets the childs with respect to the parent object this object is displayed in the current tree.

Parameters:

parentObject - the parent object of this object in the tree, null = no parent

Returns:

the childs (may be of any type, not only PDOs, and mixed!)

See Also:

PdoTree

getTreeExpandMaxDepth

int getTreeExpandMaxDepth()

Gets the maximum level of expansion allowed in a navigatable object tree.
The default is 0, i.e. no limit.

Returns:

the maximum depth of a subtree of this object, 0 = no limit (default)

See Also:

PdoTree

allowsTreeParentObjects

boolean allowsTreeParentObjects()

Determines whether the navigatable object tree should show the parents of this object.
Objects may be childs of different parents in terms of "being referenced from" or any other relation, for example: the warehouses this customer visited. Trees may provide a button to make these parents visible. The default implementation returns false.

Returns:

true if showing parents is enabled

See Also:

PdoTree

getTreeParentObjects

Collection getTreeParentObjects()

Gets the parents of this object.

Returns:

the parents (may be of any type, not only PDOs, and mixed!)

See Also:

PdoTree, allowsTreeParentObjects()

getTreeParentObjects

Collection getTreeParentObjects(Object parentObject)

Gets the parents with respect to the parent object this object is displayed in the current tree.

Parameters:

parentObject - the parent object, null if no parent

Returns:

the parents (may be of any type, not only PDOs, and mixed!)

See Also:

PdoTree

getFormTableEntry

FormTableEntry<T> getFormTableEntry()

Gets the table entry for viewing lists of this object in a FormTable.

Returns:

the formtable entry

See Also:

getFormTableName()

getFormTableName

String getFormTableName()

Gets the tablename used in to initialize the table's gui.

Returns:

the table name

See Also:

getFormTableEntry()

createPdoSearch

PdoSearch<T> createPdoSearch()

Creates the search plugin for the search dialog.

Returns:

the plugin