Package de.aristaflow.adept2.model.common.viewer

Annotation Interface Attribute

@Retention(RUNTIME) @Target(METHOD) public @interface Attribute
Annotates a method of a view interface, including the name of the attribute.
Author:
Kevin Goeser

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    Attribute.Type
    Type specialisation.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    name
    Returns the name of the attribute.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    defaultValue
    Returns the default value of an optional attribute.
    String
    description
    Returns the description of the attribute.
    String
    label
     
    boolean
    localised
    Returns true, if the field is translatable (only valid for strings).
    Attribute.Type
    type
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ATTRIBUTE_NO_DEFAULT_VALUE
    Constant expressing that no default value is provided.

  • Field Details

    • ATTRIBUTE_NO_DEFAULT_VALUE

      static final String ATTRIBUTE_NO_DEFAULT_VALUE
      Constant expressing that no default value is provided.
      See Also:

  • Element Details

    • name

      String name
      Returns the name of the attribute.
      Returns:
      The name of the attribute.

    • label

      String label
      Returns:
      A label, e.g. for the UI formatted name.
      Default:
      "ATTRIBUTE_NO_DEFAULT_VALUE"

    • description

      String description
      Returns the description of the attribute.
      Returns:
      The description of the attribute.
      Default:
      ""

    • type

      Attribute.Type type
      Returns:
      A type specialisation.
      Default:
      DEFAULT

    • defaultValue

      String defaultValue
      Returns the default value of an optional attribute.
      Returns:
      The default value of an optional attribute.
      Default:
      "ATTRIBUTE_NO_DEFAULT_VALUE"

    • localised

      boolean localised
      Returns true, if the field is translatable (only valid for strings).
      Returns:
      True, if the field is translatable (only valid for strings).
      Default:
      false