Enum Class EmbedShape

java.lang.Object
java.lang.Enum<EmbedShape>
com.inductiveautomation.ignition.designer.ai.EmbedShape
All Implemented Interfaces:
Serializable, Comparable<EmbedShape>, Constable

public enum EmbedShape extends Enum<EmbedShape>
Declares how an AssistSession will be presented to the user. Passed at creation time so the panel can configure its chrome and dismissal affordances up front; sessions are immutable in this dimension once built.

Adding a new shape: define the value here, update the AI-module panel to honor it (chrome, close affordance, sizing defaults), and document the dismissal contract callers can rely on.

  • Enum Constant Details

    • INLINE

      public static final EmbedShape INLINE
      Permanently mounted (e.g. inside a split pane). The panel renders no close affordance and does not bind Esc — the host controls when the session goes away by calling AssistSession.close(). AssistSession.onCloseRequested(Runnable) will never fire from chrome under this shape; the listener hook remains for future shapes that may add other dismissal mechanisms.
  • Method Details

    • values

      public static EmbedShape[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static EmbedShape valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null