Enum TemplateWidgetIdMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<TemplateWidgetIdMode>

    public enum TemplateWidgetIdMode
    extends java.lang.Enum<TemplateWidgetIdMode>
    Enumeration that indicates how a widget's ID may be set.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      None
      Do not set the widget ID.
      SetId
      Use setId() to set the ID as the varName.
      SetObjectName
      Use setObjectName() to add a 'data-object-name' attribute.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getValue()
      Returns the numerical representation of this enum.
      static TemplateWidgetIdMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static TemplateWidgetIdMode[] 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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

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

      • SetObjectName

        public static final TemplateWidgetIdMode SetObjectName
        Use setObjectName() to add a 'data-object-name' attribute. This is a safe choice since it does not affect the ID.
      • SetId

        public static final TemplateWidgetIdMode SetId
        Use 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 Detail

      • values

        public static TemplateWidgetIdMode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (TemplateWidgetIdMode c : TemplateWidgetIdMode.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static TemplateWidgetIdMode 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.