DefaultGuiProvider (Tentackle Swing Rich Desktop Client 2.1.2 API)

java.lang.Object
- org.tentackle.swing.rdc.DefaultGuiProvider<T>

Type Parameters:

T - the PDOs class

All Implemented Interfaces:

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

Direct Known Subclasses:

SecurityGuiProvider
```
public class DefaultGuiProvider<T extends PersistentDomainObject<T>>
extends Object
implements GuiProvider<T>
```
Default implementation of a GuiProvider.
Can be used as an adapter.

Author:

harald

Constructor Summary

Constructors
Constructor and Description

DefaultGuiProvider(T pdo)
Creates a default GUI provider.

Constructors
Constructor and Description
`DefaultGuiProvider(T pdo)` Creates a default GUI provider.

Method Summary

All Methods Instance Methods Concrete Methods
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.
`DomainContext`	`getDomainContext()`
`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.
`T`	`getPdo()`
`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.
`void`	`setPdo(T pdo)`
`boolean`	`stopTreeExpansion()` Determines whether tree explansion should stop at this object. Sometimes treechilds should not be expanded if in a recursive "expand all".
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.tentackle.pdo.PdoHolder
on

Methods inherited from interface org.tentackle.pdo.DomainContextProvider
on, op

- Constructor Detail
  - DefaultGuiProvider
```
public DefaultGuiProvider(T pdo)
```
    Creates a default GUI provider.
    
    Parameters:
    
    pdo - the PDO
- Method Detail
  - getPdo
```
public T getPdo()
```
    Specified by:
    
    getPdo in interface PdoHolder<T extends PersistentDomainObject<T>>
  - setPdo
```
public void setPdo(T pdo)
```
    Specified by:
    
    setPdo in interface PdoHolder<T extends PersistentDomainObject<T>>
  - getDomainContext
```
public DomainContext getDomainContext()
```
    Specified by:
    
    getDomainContext in interface DomainContextProvider
  - getIcon
```
public ImageIcon getIcon()
```
    Description copied from interface: GuiProvider
    
    Gets the PDO's icon.
    The icon is displayed in trees, for example.
    
    Specified by:
    
    getIcon in interface GuiProvider<T extends PersistentDomainObject<T>>
    
    Returns:
    
    the icon
  - panelExists
```
public boolean panelExists()
```
    Description copied from interface: GuiProvider
    
    Determines whether a panel exists to edit or view this object. The default is false.
    
    Specified by:
    
    panelExists in interface GuiProvider<T extends PersistentDomainObject<T>>
    
    Returns:
    
    true if a panel exists
    
    See Also:
    
    GuiProvider.createPanel()
  - createPanel
```
public FormPanel createPanel()
```
    Description copied from interface: GuiProvider
    
    Creates a panel to edit or view this object. The default implementation returns null.
    
    Specified by:
    
    createPanel in interface GuiProvider<T extends PersistentDomainObject<T>>
    
    Returns:
    
    the panel, null if none
    
    See Also:
    
    GuiProvider.panelExists()
  - createDialog
```
public PdoEditDialog<T> createDialog(Component comp,
                                     boolean modal)
```
    Description copied from interface: GuiProvider
    
    Creates a new dialog to edit this object.
    
    Specified by:
    
    createDialog in interface GuiProvider<T extends PersistentDomainObject<T>>
    
    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
```
public T getPanelObject()
```
    Description copied from interface: GuiProvider
    
    Gets the effective object that should be edited or viewed in a panel.
    
    Specified by:
    
    getPanelObject in interface GuiProvider<T extends PersistentDomainObject<T>>
    
    Returns:
    
    the object to be edited or viewed in a panel
  - getTransferable
```
public PdoTransferable<T> getTransferable()
```
    Description copied from interface: GuiProvider
    
    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.
    
    Specified by:
    
    getTransferable in interface GuiProvider<T extends PersistentDomainObject<T>>
    
    Returns:
    
    the transferable, null if none
    
    See Also:
    
    PdoTransferable
  - dropTransferable
```
public boolean dropTransferable(Transferable transferable)
```
    Description copied from interface: GuiProvider
    
    Drops a transferable on this object.
    
    Specified by:
    
    dropTransferable in interface GuiProvider<T extends PersistentDomainObject<T>>
    
    Parameters:
    
    transferable - the Transferable
    
    Returns:
    
    true if drop succeeded, else false
  - createPdoSearch
```
public PdoSearch<T> createPdoSearch()
```
    Description copied from interface: GuiProvider
    
    Creates the search plugin for the search dialog.
    
    Specified by:
    
    createPdoSearch in interface GuiProvider<T extends PersistentDomainObject<T>>
    
    Returns:
    
    the plugin
  - getFormTableEntry
```
public FormTableEntry<T> getFormTableEntry()
```
    Description copied from interface: GuiProvider
    
    Gets the table entry for viewing lists of this object in a FormTable.
    
    Specified by:
    
    getFormTableEntry in interface GuiProvider<T extends PersistentDomainObject<T>>
    
    Returns:
    
    the formtable entry
    
    See Also:
    
    GuiProvider.getFormTableName()
  - getFormTableName
```
public String getFormTableName()
```
    Description copied from interface: GuiProvider
    
    Gets the tablename used in to initialize the table's gui.
    
    Specified by:
    
    getFormTableName in interface GuiProvider<T extends PersistentDomainObject<T>>
    
    Returns:
    
    the table name
    
    See Also:
    
    GuiProvider.getFormTableEntry()
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getTreeFilter
```
public org.tentackle.misc.ObjectFilter<T> getTreeFilter()
```
    Description copied from interface: GuiProvider
    
    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.
    
    Specified by:
    
    getTreeFilter in interface GuiProvider<T extends PersistentDomainObject<T>>
    
    Returns:
    
    the filter, null if none
  - allowsTreeChildObjects
```
public boolean allowsTreeChildObjects()
```
    Description copied from interface: GuiProvider
    
    Determines whether this object may have child objects that should be visible in a navigatable tree.
    
    Specified by:
    
    allowsTreeChildObjects in interface GuiProvider<T extends PersistentDomainObject<T>>
    
    Returns:
    
    true if object may have childs
    
    See Also:
    
    PdoTree
  - getTreeChildObjects
```
public Collection getTreeChildObjects()
```
    Description copied from interface: GuiProvider
    
    Gets all childs of this objects that should be visible to the user in a navigatable object tree.
    
    Specified by:
    
    getTreeChildObjects in interface GuiProvider<T extends PersistentDomainObject<T>>
    
    Returns:
    
    the childs (may be of any type, not only PDOs, and mixed!)
    
    See Also:
    
    PdoTree
  - getTreeChildObjects
```
public Collection getTreeChildObjects(Object parentObject)
```
    Description copied from interface: GuiProvider
    
    Gets the childs with respect to the parent object this object is displayed in the current tree.
    
    Specified by:
    
    getTreeChildObjects in interface GuiProvider<T extends PersistentDomainObject<T>>
    
    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
```
public int getTreeExpandMaxDepth()
```
    Description copied from interface: GuiProvider
    
    Gets the maximum level of expansion allowed in a navigatable object tree.
    The default is 0, i.e. no limit.
    
    Specified by:
    
    getTreeExpandMaxDepth in interface GuiProvider<T extends PersistentDomainObject<T>>
    
    Returns:
    
    the maximum depth of a subtree of this object, 0 = no limit (default)
    
    See Also:
    
    PdoTree
  - allowsTreeParentObjects
```
public boolean allowsTreeParentObjects()
```
    Description copied from interface: GuiProvider
    
    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.
    
    Specified by:
    
    allowsTreeParentObjects in interface GuiProvider<T extends PersistentDomainObject<T>>
    
    Returns:
    
    true if showing parents is enabled
    
    See Also:
    
    PdoTree
  - getTreeParentObjects
```
public Collection getTreeParentObjects()
```
    Description copied from interface: GuiProvider
    
    Gets the parents of this object.
    
    Specified by:
    
    getTreeParentObjects in interface GuiProvider<T extends PersistentDomainObject<T>>
    
    Returns:
    
    the parents (may be of any type, not only PDOs, and mixed!)
    
    See Also:
    
    PdoTree, GuiProvider.allowsTreeParentObjects()
  - getTreeParentObjects
```
public Collection getTreeParentObjects(Object parentObject)
```
    Description copied from interface: GuiProvider
    
    Gets the parents with respect to the parent object this object is displayed in the current tree.
    
    Specified by:
    
    getTreeParentObjects in interface GuiProvider<T extends PersistentDomainObject<T>>
    
    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
  - getTreeRoot
```
public T getTreeRoot()
```
    Description copied from interface: GuiProvider
    
    Gets the object to be displayed in trees in place of this object. The default implementation returns "this". Override if necessary.
    
    Specified by:
    
    getTreeRoot in interface GuiProvider<T extends PersistentDomainObject<T>>
    
    Returns:
    
    the object to be displayed in a tree instead of this.
    
    See Also:
    
    PdoTree
  - getTreeText
```
public String getTreeText()
```
    Description copied from interface: GuiProvider
    
    Gets the text to be displayed in trees for this object.
    
    Specified by:
    
    getTreeText in interface GuiProvider<T extends PersistentDomainObject<T>>
    
    Returns:
    
    the tree text
    
    See Also:
    
    PdoTree
  - getTreeText
```
public String getTreeText(Object parent)
```
    Description copied from interface: GuiProvider
    
    Gets the tree text with respect to the parent object this object is displayed in a tree.
    
    Specified by:
    
    getTreeText in interface GuiProvider<T extends PersistentDomainObject<T>>
    
    Parameters:
    
    parent - is the parent object, null if no parent
    
    Returns:
    
    the tree text
    
    See Also:
    
    PdoTree
  - getToolTipText
```
public String getToolTipText()
```
    Description copied from interface: GuiProvider
    
    Gets the tooltip to be displayed for an object in a tree.
    
    Specified by:
    
    getToolTipText in interface GuiProvider<T extends PersistentDomainObject<T>>
    
    Returns:
    
    the tooltip text
    
    See Also:
    
    PdoTree
  - getToolTipText
```
public String getToolTipText(Object parent)
```
    Description copied from interface: GuiProvider
    
    Gets the tooltip text with respect to the parent object this object is displayed in a tree.
    
    Specified by:
    
    getToolTipText in interface GuiProvider<T extends PersistentDomainObject<T>>
    
    Parameters:
    
    parent - is the parent object, null if no parent
    
    Returns:
    
    the tooltip text
    
    See Also:
    
    PdoTree
  - stopTreeExpansion
```
public boolean stopTreeExpansion()
```
    Description copied from interface: GuiProvider
    
    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).
    
    Specified by:
    
    stopTreeExpansion in interface GuiProvider<T extends PersistentDomainObject<T>>
    
    Returns:
    
    true if expansion should stop.
    
    See Also:
    
    PdoTree

Class DefaultGuiProvider<T extends PersistentDomainObject<T>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.tentackle.pdo.PdoHolder

Methods inherited from interface org.tentackle.pdo.DomainContextProvider

Constructor Detail

DefaultGuiProvider

Method Detail

getPdo

setPdo

getDomainContext

getIcon

panelExists

createPanel

createDialog

getPanelObject

getTransferable

dropTransferable

createPdoSearch

getFormTableEntry

getFormTableName

toString

getTreeFilter

allowsTreeChildObjects

getTreeChildObjects

getTreeChildObjects

getTreeExpandMaxDepth

allowsTreeParentObjects

getTreeParentObjects

getTreeParentObjects

getTreeRoot

getTreeText

getTreeText

getToolTipText

getToolTipText

stopTreeExpansion