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

All Superinterfaces:

LifeCycleStateProvider, SubDialogServiceAccess

All Known Implementing Classes:

DefaultSubDialogControl

public interface SubDialogControl

extends LifeCycleStateProvider, SubDialogServiceAccess

Controls a sub dialog, that was created by the using dialog. A SubDialogControl is returned control of DialogControl.createSubDialog(String, Object).

The SubDialogControl is used to

• Identify the sub dialog (see getDialogInstanceId()),
• Provide services specific to the sub dialog (see SubDialogServiceAccess),
• Control the lifecycle of the subdialog (see createAndActivateSubDialogLifeCycleController(), details described in SubDialogLifeCycleController) and
• Dispose the created dialog - remove it from the dialog hierarchy.

Some details

Version:

1.0

Author:

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

Method Summary

SubDialogLifeCycleController	createAndActivateSubDialogLifeCycleController() Creates a new SubDialogLifeCycleController and sets it as current one for this DialogControl.
void	disposeDialog() Disposes the dialog and its children, independently of the current state.
DialogInstanceId	getDialogInstanceId()

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

getLifeCycleState

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

getService, hasService, registerService, registerService, unregisterService, unregisterServices

Method Detail

getDialogInstanceId

public DialogInstanceId getDialogInstanceId()

Returns:

the instance id of the dialog that is controlled by this SubDialogControl.

createAndActivateSubDialogLifeCycleController

public SubDialogLifeCycleController createAndActivateSubDialogLifeCycleController()

Creates a new SubDialogLifeCycleController and sets it as current one for this DialogControl. The SubDialogLifeCycleController is used to control the lifecycle state (prepared, active...) of the controlled subdialog.

Note: A SubDialogControl has only a single active SubDialogLifeCycleController. This is the last one created by this method. So calling this method grabs the control of the child's lifecycles completely! Use with caution; normally calls to this method are made only by technical helper classes, that are managing the lifecycle states together with the visual representations to get them in sync.

Returns:

the new created and activated SubDialogLifeCycleController.

disposeDialog

public void disposeDialog()
                   throws DisposeException

Disposes the dialog and its children, independently of the current state.

The call to this method is irrevokable. If you want to allow for user interaction or server calls before the dialog or its children are disposed, you should do so before calling this method.

Throws:

DisposeException - if the dialog could not be disposed due to an error in the dialog implementation.

See Also:

Disposable.dispose()