Package com.inductiveautomation.vision.api.client.binding

Interface BindingParameter<T>

All Known Implementing Classes:
DefaultBindingParameter, EmptyParameter
public interface BindingParameter<T>
Describes a single parameter that will be used in an extensible BindingType

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    BindingParameter.BrowseHelper
    Contains the functions needed for a binding parameter's editor to display a popup-tree so that the user can browse for the possible values for this parameter

  • Method Summary

    Modifier and Type
    Method
    Description
    T
    coerce(String rawValue)
    Provides a chance for the parameter to use custom coersion logic, allowing for default values.
    BindingParameter.BrowseHelper
    getBrowseHelper()
    If non-null, the editor will display a popup tree to browse for values.
    T
    getDefaultValue()
     
    List<StringPair>
    getOptionMap()
    If non-null, the editor will become a combo box, providing a list of possible options for this parameter.
    String
    getParameterName()
    The name of this parameter.
    Class<T>
    getParameterType()
    The data type of the parameter.
    String
    getTitleKey()
    A resource bundle key to use as the param's title for display purposes.
    String
    getTooltipKey()
    A resource bundle key to use for the GUI control's tooltip
    boolean
    isBindingAllowed()
    If true, the user will be allowed to bind this parameter's runtime value to tags and/or properties

  • Method Details

    • getParameterName

      String getParameterName()
      The name of this parameter. This is the string that will be used to identify this parameter's value when executing the binding. Must be unique amongst the list of binding parameters for a given binding type.

    • getParameterType

      Class<T> getParameterType()
      The data type of the parameter. All parameters are treated as Strings during the design phase, but will be coerced to this type right before execution. Coersion is handled by the coerce(String) function.

    • coerce

      T coerce(String rawValue) throws ClassCastException
      Provides a chance for the parameter to use custom coersion logic, allowing for default values.
      Throws:
      ClassCastException - If this is thrown, the binding will not be executed, instead the property will receive a poor data quality.

    • getTitleKey

      String getTitleKey()
      A resource bundle key to use as the param's title for display purposes.

    • getTooltipKey

      String getTooltipKey()
      A resource bundle key to use for the GUI control's tooltip

    • getDefaultValue

      T getDefaultValue()

    • getOptionMap

      List<StringPair> getOptionMap()

      If non-null, the editor will become a combo box, providing a list of possible options for this parameter.

      The "names" of the string pairs the literal values of the options, the "Values" are what gets displayed in the combo box.

    • getBrowseHelper

      BindingParameter.BrowseHelper getBrowseHelper()
      If non-null, the editor will display a popup tree to browse for values. This takes precedence over the option map feature.

    • isBindingAllowed

      boolean isBindingAllowed()
      If true, the user will be allowed to bind this parameter's runtime value to tags and/or properties