Package com.luciad.lucy

Class 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:

  • Field Summary

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

    Fields inherited from class java.util.EventObject

    source

  • Constructor Summary

    Constructors
    Constructor
    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
    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 Details

    • INITIALIZING

      public static final int INITIALIZING
      Indicates that the ILcyLucyEnv is initializing.
      See Also:

    • INITIALIZED

      public static final int INITIALIZED
      Indicates that the ILcyLucyEnv has finished initializing. All resources are created and the addons are plugged.
      See Also:

    • CLOSING

      public static final int CLOSING
      Indicates that the ILcyLucyEnv is going to close.
      See Also:

    • CLOSED

      public static final int CLOSED
      Indicates that the ILcyLucyEnv has finished the closing operation.
      See Also:

    • DISPOSING

      public static final int DISPOSING
      Indicates that the ILcyLucyEnv is disposing.
      See Also:

    • DISPOSED

      public static final int DISPOSED
      Indicates that the ILcyLucyEnv is disposed.
      See Also:

  • Constructor Details

    • 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 Details

    • 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: