net.sf.cuf.fw2

Interface SimpleLifeCycle

All Known Subinterfaces:

AppDc, DialogDc

All Known Implementing Classes:

AbstractAppDc, AbstractDialogDc

public interface SimpleLifeCycle

The SimpleLifeCycle interface describes a part of a more complex lifecycle, and is used to encapsulate the common life cycle of AppDc and DialogDc.
The lifecycle that is described by the SimpleLifeCycle interface is shown below: doActivate() doPassivate() [initialized] -----------> [active] ------------> [passive] <------------ doActivate() The arguments of the doActivate(Map) and doPassivate(Map) calls may also be used to return stuff to the caller.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FORCE_CLOSE_KEY Key for the parameter of the doPassivate(Map), the value is the optional flag (value type Boolean) which is true if the method is called directly after a call to canPassivate().

Method Summary

Modifier and Type	Method and Description
boolean	canPassivate() Test to check if a dialog in the active state can be moved to the passive state.
void	doActivate(Map<String,? super Object> pArgs) Called from the dialog coordinator to tell the dialog to switch to the active state.
void	doPassivate(Map<String,? super Object> pArgs) Called from the dialog coordinator to tell the dialog to switch to the passive state.

Field Detail

FORCE_CLOSE_KEY

static final String FORCE_CLOSE_KEY

Key for the parameter of the doPassivate(Map), the value is the optional flag (value type Boolean) which is true if the method is called directly after a call to canPassivate(). In that case, the implementation should also use the force mode for its child dialog hierarchy (if any) to avoid duplicate calls to the canPassivate().

See Also:

Constant Field Values

Method Detail

canPassivate

boolean canPassivate()

Test to check if a dialog in the active state can be moved to the passive state.
The dialog may e.g. check if it has unsaved data and prompt the user for information how to proceed.
If the dialog returns true, it may be moved to the passive state by a call to doPassivate(Map), if it returns false, it will remain in the active state and no doPassivate(Map) call will happen. In the call to doPassivate(Map) directly after this method returned true, the additional value FORCE_CLOSE_KEY is passed.

Returns:

true if the dialog can be passivated

doActivate

void doActivate(Map<String,? super Object> pArgs)

Called from the dialog coordinator to tell the dialog to switch to the active state. If the dialog is an modal dialog, this method returns after the dialog closed.

Parameters:

pArgs - arguments, key is a String, value is any suitable object for the key

doPassivate

void doPassivate(Map<String,? super Object> pArgs)

Called from the dialog coordinator to tell the dialog to switch to the passive state. If the dialog is a modal dialog, this method is called "inside" the doActivate(Map) method. If canPassivate() was called directly before this method, then the parameter will contain the flag FORCE_CLOSE_KEY to indicate that calls to the child dialog hierarchy (if any) should also use the force mode to avoid duplicate calls to canPassivate().

Parameters:

pArgs - arguments, key is a String, value is any suitable object for the key