Package io.micronaut.views.turbo

Enum Class TurboStreamAction

java.lang.Object
java.lang.Enum<TurboStreamAction>
io.micronaut.views.turbo.TurboStreamAction
All Implemented Interfaces:
Serializable, Comparable<TurboStreamAction>, Constable
public enum TurboStreamAction extends Enum<TurboStreamAction>
Turbo Seven Actions. Turbo Seven Actions
Since:
3.3.0
Author:
Sergio del Amo

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    AFTER
    Inserts the content within the template tag after the element designated by the target dom id.
    APPEND
    Appends the content within the template tag to the container designated by the target dom id.
    BEFORE
    Inserts the content within the template tag before the element designated by the target dom id.
    MORPH
    Replaces the element designated by the target dom id via morph.
    PREPEND
    Prepends the content within the template tag to the container designated by the target dom id.
    REFRESH
    Initiates a Page Refresh to render new content with morphing.
    REMOVE
    Removes the element designated by the target dom id.
    REPLACE
    Replaces the element designated by the target dom id.
    UPDATE
    Updates the content within the template tag to the container designated by the target dom id.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull String
    getAction()
     
    String
    toString()
     
    static TurboStreamAction
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static TurboStreamAction[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • APPEND

      public static final TurboStreamAction APPEND
      Appends the content within the template tag to the container designated by the target dom id.

    • PREPEND

      public static final TurboStreamAction PREPEND
      Prepends the content within the template tag to the container designated by the target dom id.

    • REPLACE

      public static final TurboStreamAction REPLACE
      Replaces the element designated by the target dom id.

    • UPDATE

      public static final TurboStreamAction UPDATE
      Updates the content within the template tag to the container designated by the target dom id.

    • REMOVE

      public static final TurboStreamAction REMOVE
      Removes the element designated by the target dom id.

    • BEFORE

      public static final TurboStreamAction BEFORE
      Inserts the content within the template tag before the element designated by the target dom id.

    • AFTER

      public static final TurboStreamAction AFTER
      Inserts the content within the template tag after the element designated by the target dom id.

    • MORPH

      public static final TurboStreamAction MORPH
      Replaces the element designated by the target dom id via morph.

    • REFRESH

      public static final TurboStreamAction REFRESH
      Initiates a Page Refresh to render new content with morphing.

  • Method Details

    • values

      public static TurboStreamAction[] 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 TurboStreamAction 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

    • getAction

      @NonNull public @NonNull String getAction()
      Returns:
      Turbo action in lowercase

    • toString

      public String toString()
      Overrides:
      toString in class Enum<TurboStreamAction>
      Returns:
      Turbo action in lowercase