net.sf.cuf.fw2

Class CloseDialogEvent

java.lang.Object

java.util.EventObject

net.sf.cuf.appevent.AppEvent

net.sf.cuf.fw2.CloseDialogEvent

All Implemented Interfaces:

Serializable

public class CloseDialogEvent
extends AppEvent

A CloseDialogEvent signals that a dialog should be closed.
For dialogs following the SimpleLifeCycle interface this will trigger a call to the doPassivate() method. The dialog is referenced either by a Dc object or a symbolic name. The close event contains also the information if the dialog should be disposed, if the dialog was closed and the result of the doPassivate() call. If the dialog implements the SimpleLifeCycle interface, the CloseDialogEvent should only be fired if the dialog is active. A dialog may choose this event because he has no direct or complete control about its frame/MDI frame, and therefore delegates this task to someone else.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
CloseDialogEvent(Object pSource, Dc pDialog) Creates a new close dialog.
CloseDialogEvent(Object pSource, Dc pDialog, boolean pDispose) Creates a new close dialog.
CloseDialogEvent(Object pSource, Dc pDialog, boolean pDispose, boolean pForceClose) Creates a new close dialog.
CloseDialogEvent(Object pSource, String pDialogName) Creates a new close dialog.
CloseDialogEvent(Object pSource, String pDialogName, boolean pDispose) Creates a new close dialog.
CloseDialogEvent(Object pSource, String pDialogName, boolean pDispose, boolean pForceClose) Creates a new close dialog.

Method Summary

Modifier and Type	Method and Description
Dc	getDialog() The dialog Dc of this close event.
String	getDialogId() The dialog id of this close event.
Map<String,Object>	getResult() Return the result of a close.
boolean	getWasClosed() Was the dialog really closed by this event?
boolean	hasDialogId() Checks if the close event contains a dialog id and not a Dc object.
boolean	isDispose() Returns if the dialog should be disposed after de-activating.
boolean	isForceClose() Returns if the close is forced.
void	setResult(Map<String,Object> pResult) Set the result of a close.
void	setWasClosed(boolean pWasClosed) Set the flag if the dialog was really closed.

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

CloseDialogEvent

public CloseDialogEvent(Object pSource,
                        String pDialogName)

Creates a new close dialog.

Parameters:

pSource - the sender

pDialogName - the dialog name

CloseDialogEvent

public CloseDialogEvent(Object pSource,
                        String pDialogName,
                        boolean pDispose)

Creates a new close dialog.

Parameters:

pSource - the sender

pDialogName - the dialog name

pDispose - flag if we should also dispose the dialog

CloseDialogEvent

public CloseDialogEvent(Object pSource,
                        String pDialogName,
                        boolean pDispose,
                        boolean pForceClose)

Creates a new close dialog.

Parameters:

pSource - the sender

pDialogName - the dialog name

pDispose - flag if we should also dispose the dialog

pForceClose - flag if we should skip asking the Dc if it can passivate

CloseDialogEvent

public CloseDialogEvent(Object pSource,
                        Dc pDialog)

Creates a new close dialog.

Parameters:

pSource - the sender

pDialog - the dialog object

CloseDialogEvent

public CloseDialogEvent(Object pSource,
                        Dc pDialog,
                        boolean pDispose)

Creates a new close dialog.

Parameters:

pSource - the sender

pDialog - the dialog object

pDispose - flag if we should also dispose the dialog

CloseDialogEvent

public CloseDialogEvent(Object pSource,
                        Dc pDialog,
                        boolean pDispose,
                        boolean pForceClose)

Creates a new close dialog.

Parameters:

pSource - the sender

pDialog - the dialog object

pDispose - flag if we should also dispose the dialog

pForceClose - flag if we should skip asking the Dc if it can passivate

Method Detail

hasDialogId

public boolean hasDialogId()

Checks if the close 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 close event.

Returns:

dialog id, never null

Throws:

IllegalStateException - if this event contains no dialog string

getDialog

public Dc getDialog()

The dialog Dc of this close event.

Returns:

Dc object, never null

Throws:

IllegalStateException - if this event contains no Dc object

isDispose

public boolean isDispose()

Returns if the dialog should be disposed after de-activating.

Returns:

true for dispose

isForceClose

public boolean isForceClose()

Returns if the close is forced.

Returns:

true if we should not ask the Dc if it can passivate

getResult

public Map<String,Object> getResult()

Return the result of a close.

Returns:

the result, never null

setResult

public void setResult(Map<String,Object> pResult)

Set the result of a close.

Parameters:

pResult - the result, must not be null

getWasClosed

public boolean getWasClosed()

Was the dialog really closed by this event?

Returns:

true if the dialog was closed

setWasClosed

public void setWasClosed(boolean pWasClosed)

Set the flag if the dialog was really closed.

Parameters:

pWasClosed - true if the dialog was closed