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

Class EmptyParameter

java.lang.Object

com.inductiveautomation.vision.api.client.binding.EmptyParameter

All Implemented Interfaces:

BindingParameter<String>

public final class EmptyParameter
extends Object
implements BindingParameter<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.

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.vision.api.client.binding.BindingParameter

BindingParameter.BrowseHelper

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
EmptyParameter()

Method Summary

Modifier and Type	Method	Description
String	coerce(String rawValue)	Provides a chance for the parameter to use custom coercion 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.
String	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<String>	getParameterType()	The data type of the parameter.
String	getTitleKey()	A resource bundle key to use as the parameter'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

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

Constructor Details

EmptyParameter

public EmptyParameter()

Method Details

get

public static EmptyParameter get()

coerce

public String coerce(String rawValue)
              throws ClassCastException

Description copied from interface: BindingParameter

Provides a chance for the parameter to use custom coercion logic, allowing for default values.

Specified by:

coerce in interface BindingParameter<String>

Parameters:

rawValue - the string representation of the parameter value.

Returns:

the coerced value of type T.

Throws:

ClassCastException - If this is thrown, the binding will not be executed, instead the property will receive a poor data quality.

getBrowseHelper

public BindingParameter.BrowseHelper getBrowseHelper()

Description copied from interface: BindingParameter

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

Specified by:

getBrowseHelper in interface BindingParameter<String>

getDefaultValue

public String getDefaultValue()

Specified by:

getDefaultValue in interface BindingParameter<String>

getOptionMap

public 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<String>

getParameterName

public 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<String>

getParameterType

public Class<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. Coercion is handled by the BindingParameter.coerce(String) function.

Specified by:

getParameterType in interface BindingParameter<String>

Returns:

the expected class of the parameter.

getTitleKey

public String getTitleKey()

Description copied from interface: BindingParameter

A resource bundle key to use as the parameter's title for display purposes.

Specified by:

getTitleKey in interface BindingParameter<String>

Returns:

the resource bundle key for the title.

getTooltipKey

public 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<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<String>