net.sf.cuf.fw2

Class OpenDialogEvent

java.lang.Object

java.util.EventObject

net.sf.cuf.appevent.AppEvent

net.sf.cuf.fw2.OpenDialogEvent

All Implemented Interfaces:

Serializable

public class OpenDialogEvent
extends AppEvent

A OpenDialogEvent signals that a dialog should be opend.
For dialogs following the SimpleLifeCycle interface this will trigger a call to the doActivate() method. The dialog is referenced either by a Dc object or a symbolic name. If the to be opened dialog is modal, the open event contains also the information of the doPassivate() call.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
OpenDialogEvent(Object pSource, Dc pDialog) Create a new open dialog event.
OpenDialogEvent(Object pSource, Dc pDialog, Map<String,Object> pDialogArguments) Create a new open dialog event.
OpenDialogEvent(Object pSource, String pDialogId) Create a new open dialog event.
OpenDialogEvent(Object pSource, String pDialogId, Map<String,Object> pDialogArguments) Create a new open dialog event.

Method Summary

Methods

Modifier and Type	Method and Description
Dc	getDialog() The dialog Dc of this open event.
Map<String,Object>	getDialogArguments() Returns arguments for the doPassivate() call.
String	getDialogId() The dialog id of this open event.
Map<String,Object>	getDialogResults() Returns the result of a open, this is only useful for modal dialogs, non-modal dialogs will always return an empty map.
boolean	hasDialogId() Checks if the open event contains a dialog id and not a Dc object.
void	setDialogResults(Map<String,Object> pDialogResults) Set the results of the open, this should be used called after opening a model dialog.

Methods inherited from class net.sf.cuf.appevent.AppEvent

consume, forward, isConsumed, toString

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OpenDialogEvent

public OpenDialogEvent(Object pSource,
               String pDialogId)

Create a new open dialog event.

Parameters:

pSource - the object requesting the open, must not be null

pDialogId - the dialog id of the to be opend dialog

OpenDialogEvent

public OpenDialogEvent(Object pSource,
               String pDialogId,
               Map<String,Object> pDialogArguments)

Create a new open dialog event.

Parameters:

pSource - the object requesting the open, must not be null

pDialogId - the dialog id of the to be opend dialog

pDialogArguments - arguments for the doPassivate() call, may be null

OpenDialogEvent

public OpenDialogEvent(Object pSource,
               Dc pDialog)

Create a new open dialog event.

Parameters:

pSource - the object requesting the open, must not be null

pDialog - the dialog object that should be opend, must not be null

OpenDialogEvent

public OpenDialogEvent(Object pSource,
               Dc pDialog,
               Map<String,Object> pDialogArguments)

Create a new open dialog event.

Parameters:

pSource - the object requesting the open, must not be null

pDialog - the dialog object that should be opend, must not be null

pDialogArguments - arguments for the doActivate() call, may be null

Method Detail

hasDialogId

public boolean hasDialogId()

Checks if the open event contains a dialog id and not a Dc object.

Returns:

true if the event was generated with a dialog id

getDialogId

public String getDialogId()

The dialog id of this open event.

Returns:

dialog id, never null

Throws:

IllegalStateException - if this event contains no dialog string

getDialog

public Dc getDialog()

The dialog Dc of this open event.

Returns:

Dc object, never null

Throws:

IllegalStateException - if this event contains no Dc object

getDialogArguments

public Map<String,Object> getDialogArguments()

Returns arguments for the doPassivate() call.

Returns:

arguments, never null

getDialogResults

public Map<String,Object> getDialogResults()

Returns the result of a open, this is only useful for modal dialogs, non-modal dialogs will always return an empty map.

Returns:

results, never null

setDialogResults

public void setDialogResults(Map<String,Object> pDialogResults)

Set the results of the open, this should be used called after opening a model dialog.

Parameters:

pDialogResults - results, must not be null