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

Class EmptyParameter

  • All Implemented Interfaces:
    BindingParameter<java.lang.String>
    public final class EmptyParameter
extends java.lang.Object
implements BindingParameter<java.lang.String>
    Special implementation of BindingParameter that essentially inserts a blank spot in the GUI. Used to make the 2-column layout look nicer in certain situations.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String NAME  

    • Constructor Summary

      Constructors 
      Constructor Description
      EmptyParameter()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String coerce​(java.lang.String rawValue)
      Provides a chance for the parameter to use custom coersion logic, allowing for default values.
      static EmptyParameter get()  
      BindingParameter.BrowseHelper getBrowseHelper()
      If non-null, the editor will display a popup tree to browse for values.
      java.lang.String getDefaultValue()  
      java.util.List<StringPair> getOptionMap()
      If non-null, the editor will become a combo box, providing a list of possible options for this parameter.
      java.lang.String getParameterName()
      The name of this parameter.
      java.lang.Class<java.lang.String> getParameterType()
      The data type of the parameter.
      java.lang.String getTitleKey()
      A resource bundle key to use as the param's title for display purposes.
      java.lang.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

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • NAME

        public static final java.lang.String NAME

    • Constructor Detail

      • EmptyParameter

        public EmptyParameter()

    • Method Detail

      • coerce

        public java.lang.String coerce​(java.lang.String rawValue)
                        throws java.lang.ClassCastException
        Description copied from interface: BindingParameter
        Provides a chance for the parameter to use custom coersion logic, allowing for default values.
        Specified by:
        coerce in interface BindingParameter<java.lang.String>
        Throws:
        java.lang.ClassCastException - If this is thrown, the binding will not be executed, instead the property will receive a poor data quality.

      • getOptionMap

        public java.util.List<StringPair> getOptionMap()
        Description copied from interface: BindingParameter

        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.

        Specified by:
        getOptionMap in interface BindingParameter<java.lang.String>

      • getParameterName

        public java.lang.String getParameterName()
        Description copied from interface: BindingParameter
        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.
        Specified by:
        getParameterName in interface BindingParameter<java.lang.String>

      • getParameterType

        public java.lang.Class<java.lang.String> getParameterType()
        Description copied from interface: BindingParameter
        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 BindingParameter.coerce(String) function.
        Specified by:
        getParameterType in interface BindingParameter<java.lang.String>

      • getTitleKey

        public java.lang.String getTitleKey()
        Description copied from interface: BindingParameter
        A resource bundle key to use as the param's title for display purposes.
        Specified by:
        getTitleKey in interface BindingParameter<java.lang.String>

      • getTooltipKey

        public java.lang.String getTooltipKey()
        Description copied from interface: BindingParameter
        A resource bundle key to use for the GUI control's tooltip
        Specified by:
        getTooltipKey in interface BindingParameter<java.lang.String>

      • isBindingAllowed

        public boolean isBindingAllowed()
        Description copied from interface: BindingParameter
        If true, the user will be allowed to bind this parameter's runtime value to tags and/or properties
        Specified by:
        isBindingAllowed in interface BindingParameter<java.lang.String>