com.sdm.quasar.client.core.dialog
Interface DialogControl

All Superinterfaces:

DialogServiceAccess, FeatureManager, LifeCycleControl, LifeCycleStateProvider

All Known Implementing Classes:

DefaultDialogControl

public interface DialogControl

extends DialogServiceAccess, LifeCycleControl, LifeCycleStateProvider, FeatureManager

DialogControl is the central interface for dialog implementors, to

1. create and control subdialogs, that are managed by the dialog environment (see methods of this interface directly),
2. access Services of other dialogs (see DialogServiceAccess subinterface),
3. provide Services to other dialogs (see DialogServiceAccess subinterface),
4. manage Features for this dialog node (see FeatureManager subinterface)
5. take part of this dialog node's lifecycle (see LifeCycleControl subinterface (but mostly this will be done by writing and installing a Feature)

This interface is offered to all dialogs that are managed by the dialog environment.

Note: Every dialog is part of a dialog hierarchy the dialog hierarchy will be created step by step by the dialogs that create and control their direct subdialogs. Because of this fact, the dialog hierarchy is also a dialog creation hierarchy. The main idea is, that the one that created a dialog, is responsible for the lifecycle of it. Every dialog instance has only limited access to the dialog hierarchy - limited to it's direct childs. If - e.g. - some dialog wishes, that another dialog creates a subdialog of itself, the first dialog can't do this directly; it has to ask the second dialog politely using a service, that this dialog must provide. This expresses the capsulation of responsibility and functionality often mentioned together with the concept of components. In this manner, a dialog is somehow like a component.

Because this main interface integrates various concepts (the 5 points from above), it has only few methods but inherits it's functionality from more specialized interfaces.

Version:

1.0

Author:

Thomas Wolf, sd&m AG, Bernd Olleck, sd&m AG, Martin Haft, sd&m AG

Method Summary

boolean	canCreateSubDialog(java.lang.String dialogId) Tests, whether the dialog with the given id can be created as subdialog.
SubDialogControl	createSubDialog(java.lang.String dialogId, java.lang.Object context) Creates a new dialog that is dependent on this dialog.
java.lang.Object	getCreationContext() Returns the creation context passed by the dialog instance creation of this dialog instance.
DialogInstanceId	getDialogInstanceId()
boolean	hasSubDialog(SubDialogControl subDialogControl) Returns true, if the SubDialogControl given is a valid sub dialog of this DialogControl (created via createSubDialog(String, Object)), that is currently not disposed.

Methods inherited from interface com.sdm.quasar.client.core.dialog.DialogServiceAccess

findServiceInHierarchy, findServiceInParentHierarchy, getServiceDirect, hasServiceDirect, hasServiceInHierarchy, hasServiceInParentHierarchy, registerService, registerServiceForHierarchy, unregisterService

Methods inherited from interface com.sdm.quasar.client.core.dialog.lifecycle.LifeCycleControl

attachToLifeCycle, detachFromLifeCycle

Methods inherited from interface com.sdm.quasar.client.core.dialog.lifecycle.LifeCycleStateProvider

getLifeCycleState

Methods inherited from interface com.sdm.quasar.client.core.dialog.FeatureManager

getFeature, hasFeature, installFeature, installFeature, installFeature, installFeature, requireFeature, uninstallFeature

Method Detail

getDialogInstanceId

public DialogInstanceId getDialogInstanceId()

Returns:

the instance id of the dialog that this control is assigned to

getCreationContext

public java.lang.Object getCreationContext()

Returns the creation context passed by the dialog instance creation of this dialog instance.

createSubDialog

public SubDialogControl createSubDialog(java.lang.String dialogId,
                                        java.lang.Object context)

Creates a new dialog that is dependent on this dialog.

Parameters:

dialogId - the dialog id of the new dialog

context - the initialization context of the new dialog

Returns:

the interface to control the lifecycle of a sub dialog

hasSubDialog

public boolean hasSubDialog(SubDialogControl subDialogControl)

Returns true, if the SubDialogControl given is a valid sub dialog of this DialogControl (created via createSubDialog(String, Object)), that is currently not disposed.

Parameters:

subDialogControl - the SubDialogControl to check

Returns:

true, if the SubDialogControl is created by this DialogControl and

canCreateSubDialog

public boolean canCreateSubDialog(java.lang.String dialogId)

Tests, whether the dialog with the given id can be created as subdialog.

Parameters:

dialogId - Id of the dialog to be created

Returns:

true, iff the dialog can be created