Package org.uberfire.client.workbench.events

Class BeforeClosePlaceEvent

java.lang.Object

org.uberfire.client.workbench.events.AbstractPlaceEvent

org.uberfire.client.workbench.events.BeforeClosePlaceEvent

All Implemented Interfaces:

org.uberfire.workbench.events.UberFireEvent

public class BeforeClosePlaceEvent
extends AbstractPlaceEvent

Fired by the PlaceManager before the process of closing a place begins.

Constructor Summary

Constructors

Constructor	Description
BeforeClosePlaceEvent(org.uberfire.mvp.PlaceRequest place)	Deprecated. Prior to UberFire 0.5, it was possible for an application to close a place by firing this event.
BeforeClosePlaceEvent(org.uberfire.mvp.PlaceRequest place, boolean force)	Deprecated. Prior to UberFire 0.5, it was possible for an application to close a place by firing this event.
BeforeClosePlaceEvent(org.uberfire.mvp.PlaceRequest place, boolean force, boolean frameworkInternal)	Internal workbench API.

Method Summary

Modifier and Type	Method	Description
boolean	isForce()	Indicates whether or not the place is being closed forcibly.
String	toString()

Methods inherited from class org.uberfire.client.workbench.events.AbstractPlaceEvent

getPlace

Methods inherited from class java.lang.Object

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

Constructor Detail

BeforeClosePlaceEvent

@Deprecated
public BeforeClosePlaceEvent(org.uberfire.mvp.PlaceRequest place)

Deprecated.

Prior to UberFire 0.5, it was possible for an application to close a place by firing this event. This no longer works. Instead, use one of the PlaceManager.closeXXX methods.

Applications should not fire this event, so there is no reason to create instances of this class!

This constructor will be removed in UberFire 0.6.

BeforeClosePlaceEvent

@Deprecated
public BeforeClosePlaceEvent(org.uberfire.mvp.PlaceRequest place,
                             boolean force)

Deprecated.

Prior to UberFire 0.5, it was possible for an application to close a place by firing this event. This no longer works. Instead, use one of the PlaceManager.closeXXX methods.

Applications should not fire this event, so there is no reason to create instances of this class!

This constructor will be removed in UberFire 0.6.

BeforeClosePlaceEvent

public BeforeClosePlaceEvent(org.uberfire.mvp.PlaceRequest place,
                             boolean force,
                             boolean frameworkInternal)

Internal workbench API. Don't use! If you want to close a place, use PlaceManager.closePlace(PlaceRequest).

Parameters:

place - The place that's about to be closed. Not null.

force - Whether this will be a forced close operation.

frameworkInternal - flag to differentiate from the deprecated/disabled constructors.

Method Detail

isForce

public boolean isForce()

Indicates whether or not the place is being closed forcibly. See PlaceManager.forceClosePlace(PlaceRequest) for details.

toString

public String toString()

Overrides:

toString in class Object