Enum WTemplate.WidgetIdMode

java.lang.Object
java.lang.Enum<WTemplate.WidgetIdMode>
eu.webtoolkit.jwt.WTemplate.WidgetIdMode
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<WTemplate.WidgetIdMode>, java.lang.constant.Constable
Enclosing class:
WTemplate

public static enum WTemplate.WidgetIdMode
extends java.lang.Enum<WTemplate.WidgetIdMode>
Enumeration that indicates how a widget's ID may be set.

See Also:
WTemplate.setWidgetIdMode(WTemplate.WidgetIdMode mode)
  • Nested Class Summary

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

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
  • Enum Constant Summary

    Enum Constants
    Enum Constant Description
    SetNoWidgetId
    Do not set the widget ID.
    SetWidgetId
    Use WWebWidget#setId() to set the ID as the varName.
    SetWidgetObjectName
    Use WWidget#setObjectName() to prefix the ID with the varName.
  • Method Summary

    Modifier and Type Method Description
    int getValue()
    Returns the numerical representation of this enum.
    static WTemplate.WidgetIdMode valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static WTemplate.WidgetIdMode[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • SetNoWidgetId

      public static final WTemplate.WidgetIdMode SetNoWidgetId
      Do not set the widget ID.
    • SetWidgetObjectName

      public static final WTemplate.WidgetIdMode SetWidgetObjectName
      Use WWidget#setObjectName() to prefix the ID with the varName. This is a safe choice since JWt still guarantees that the IDs are unique.
    • SetWidgetId

      public static final WTemplate.WidgetIdMode SetWidgetId
      Use WWebWidget#setId() to set the ID as the varName.

      Warning: You must be careful that there are no two widgets with the same ID in yor application.

  • Method Details

    • values

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

      public static WTemplate.WidgetIdMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null
    • getValue

      public int getValue()
      Returns the numerical representation of this enum.