com.sdm.quasar.client.core.embedding
Interface SingleActivationController

All Superinterfaces:
ActivationController
All Known Implementing Classes:
SingleActivationControllerFeature

public interface SingleActivationController
extends ActivationController

An ActivationController, that manages a set of sub dialogs with a local name. Only a single sub dialog can be active at a time. The active sub dialog can be set via setSubDialogActive(String).

Version:
1.$Revision$
Author:
Thomas Wolf

Method Summary
 void addSubDialog(java.lang.String localName, SubDialogControl subDialogControl)
          Adds a new subdialog to get controlled by this controller.
 SubDialogControl getSubDialogControl(java.lang.String localName)
          Returns the SubDialogControl of an controlled subdialog which was registered under the local name given.
 void removeSubDialog(java.lang.String localName)
          Removes the specified previously added subdialog from this controller.
 void removeSubDialog(SubDialogControl subDialogControl)
          Removes the specified previously added subdialog from this controller.
 void setSubDialogActive(java.lang.String localName)
          Sets the controlled sub dialog with the given local name to active.
 
Methods inherited from interface com.sdm.quasar.client.core.embedding.ActivationController
addActivationControllerListener, removeActivationControllerListener
 

Method Detail

addSubDialog

public void addSubDialog(java.lang.String localName,
                         SubDialogControl subDialogControl)
Adds a new subdialog to get controlled by this controller.

Parameters:
localName - a local name to choose (must be unique for this controller)
subDialogControl - the SubDialogControl for the controlled subdialog

removeSubDialog

public void removeSubDialog(SubDialogControl subDialogControl)
Removes the specified previously added subdialog from this controller.

Parameters:
subDialogControl - the SubDialogControl specifying the subdialog to remove

removeSubDialog

public void removeSubDialog(java.lang.String localName)
Removes the specified previously added subdialog from this controller.

Parameters:
localName - the local name specifying the subdialog to remove

getSubDialogControl

public SubDialogControl getSubDialogControl(java.lang.String localName)
Returns the SubDialogControl of an controlled subdialog which was registered under the local name given.

Parameters:
localName - the local name, where the subdialog was registered under
Returns:
the SubDialogControl of the controlled subdialog

setSubDialogActive

public void setSubDialogActive(java.lang.String localName)
Sets the controlled sub dialog with the given local name to active. If the given local name id null, no subdialog will become active.

Parameters:
localName - the local name of the subdialog to activate or null to deactivate