com.luciad.lucy

LuciadLightspeedClass TLcyLucyEnvEvent

java.lang.Object

java.util.EventObject

com.luciad.lucy.TLcyLucyEnvEvent

All Implemented Interfaces:

Serializable

public class TLcyLucyEnvEvent
extends EventObject

Event describing significant state changes in the Lucy backend.

See Also:

ILcyLucyEnv.setLucyEnvState(int), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLOSED Indicates that the ILcyLucyEnv has finished the closing operation.
static int	CLOSING Indicates that the ILcyLucyEnv is going to close.
static int	DISPOSED Indicates that the ILcyLucyEnv is disposed.
static int	DISPOSING Indicates that the ILcyLucyEnv is disposing.
static int	INITIALIZED Indicates that the ILcyLucyEnv has finished initializing.
static int	INITIALIZING Indicates that the ILcyLucyEnv is initializing.

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
TLcyLucyEnvEvent(ILcyLucyEnv aLucyEnv, int aID) Creates a new TLcyLucyEnvEvent for the given ILcyLucyEnv and ID.
TLcyLucyEnvEvent(ILcyLucyEnv aLucyEnv, int aID, Runnable aRevokeVetoRunnable) Creates a new TLcyLucyEnvEvent for the given ILcyLucyEnv and ID, with the ability to revoke a veto.

Method Summary

Modifier and Type	Method and Description
boolean	canRevokeVeto() Returns true if a veto can be revoked.
int	getID() Returns the ID that describes the type of the event.
ILcyLucyEnv	getLucyEnv() Returns the ILcyLucyEnv that originated this event.
void	revokeVeto() Revokes the veto, re-triggering the action that was revoked.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Detail

INITIALIZING

public static final int INITIALIZING

Indicates that the ILcyLucyEnv is initializing.

See Also:

Constant Field Values

INITIALIZED

public static final int INITIALIZED

Indicates that the ILcyLucyEnv has finished initializing. All resources are created and the addons are plugged.

See Also:

Constant Field Values

CLOSING

public static final int CLOSING

Indicates that the ILcyLucyEnv is going to close.

See Also:

Constant Field Values

CLOSED

public static final int CLOSED

Indicates that the ILcyLucyEnv has finished the closing operation.

See Also:

Constant Field Values

DISPOSING

public static final int DISPOSING

Indicates that the ILcyLucyEnv is disposing.

See Also:

Constant Field Values

DISPOSED

public static final int DISPOSED

Indicates that the ILcyLucyEnv is disposed.

See Also:

Constant Field Values

Constructor Detail

TLcyLucyEnvEvent

public TLcyLucyEnvEvent(ILcyLucyEnv aLucyEnv,
                        int aID)

Creates a new TLcyLucyEnvEvent for the given ILcyLucyEnv and ID.

Parameters:

aLucyEnv - The ILcyLucyEnv that originates this event.

aID - The ID describing the type of the event.

TLcyLucyEnvEvent

public TLcyLucyEnvEvent(ILcyLucyEnv aLucyEnv,
                        int aID,
                        Runnable aRevokeVetoRunnable)

Creates a new TLcyLucyEnvEvent for the given ILcyLucyEnv and ID, with the ability to revoke a veto.

Parameters:

aLucyEnv - The ILcyLucyEnv that originates this event.

aID - The ID describing the type of the event.

aRevokeVetoRunnable - A runnable to revoke the veto, or null. It typically re-triggers the action that lead to the TLcyVetoException. For example, if exiting the application was vetoed, this action tries to exit once more. Refer to ILcyLucyEnv.setLucyEnvState(int) for more information.

Since:

2022.1

Method Detail

getLucyEnv

public ILcyLucyEnv getLucyEnv()

Returns the ILcyLucyEnv that originated this event.

Returns:

the ILcyLucyEnv that originated this event.

getID

public int getID()

Returns the ID that describes the type of the event.

Returns:

the ID that describes the type of the event.

revokeVeto

public void revokeVeto()

Revokes the veto, re-triggering the action that was revoked.

Since:

2022.1

See Also:

()

canRevokeVeto

public boolean canRevokeVeto()

Returns true if a veto can be revoked. If true, you can revoke a TLcyVetoException you threw. This is especially useful if you need to perform asynchronous work upon a state change, such as saving the workspace before exiting the application. Refer to ILcyLucyEnv.setLucyEnvState(int) for more information.

Returns:

true if #revokeVeto can be called after throwing a TLcyVetoException

Since:

2022.1

See Also:

revokeVeto()