Package org.talend.sdk.component.api.configuration.action

Annotation Interface Suggestable

@Target({FIELD,PARAMETER}) @Retention(RUNTIME) public @interface Suggestable

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    Suggestable.LabelDisplayMode
    Defines how suggestion options are displayed in the UI.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
     

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Suggestable.LabelDisplayMode
    labelDisplayMode
    Controls how each suggestion option is rendered in the UI.
    String[]
    parameters
    This "list" will represent the parameter the caller will send to the suggestions implementation.

  • Element Details

    • parameters

      String[] parameters
      This "list" will represent the parameter the caller will send to the suggestions implementation. Syntax is the following:
      • .: represents the decorated option (aka "this")
      • ../foo: represents the 
         foo
        option of the parent (if exists) of "."
      • bar: represents the 
         bar
        sibling option of the decorated field
      • bar/dummy: represents the 
         dummy
        option of the child bar of the decorated field
      This syntax is close to path syntax but the important point is all the parameters are related to the decorated option.
      Returns:
      parameters for the validation.
      Default:
      {"."}

    • labelDisplayMode

      Suggestable.LabelDisplayMode labelDisplayMode
      Controls how each suggestion option is rendered in the UI. Use Suggestable.LabelDisplayMode.LABEL_ID when option labels may not be unique, so that the identifier is shown alongside the label to allow unambiguous selection. Defaults to Suggestable.LabelDisplayMode.LABEL — preserves full backward compatibility.
      Returns:
      the display mode for suggestion options.
      Default:
      LABEL