public final class EmptyParameter extends java.lang.Object implements BindingParameter<java.lang.String>
BindingParameter.BrowseHelper
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
NAME |
Constructor and Description |
---|
EmptyParameter() |
Modifier and Type | Method and 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
|
public static EmptyParameter get()
public java.lang.String coerce(java.lang.String rawValue) throws java.lang.ClassCastException
BindingParameter
coerce
in interface BindingParameter<java.lang.String>
java.lang.ClassCastException
- If this is thrown, the binding will not be executed, instead the property will recieve a poor data
quality.public BindingParameter.BrowseHelper getBrowseHelper()
BindingParameter
getBrowseHelper
in interface BindingParameter<java.lang.String>
public java.lang.String getDefaultValue()
getDefaultValue
in interface BindingParameter<java.lang.String>
public java.util.List<StringPair> getOptionMap()
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.
getOptionMap
in interface BindingParameter<java.lang.String>
public java.lang.String getParameterName()
BindingParameter
getParameterName
in interface BindingParameter<java.lang.String>
public java.lang.Class<java.lang.String> getParameterType()
BindingParameter
BindingParameter.coerce(String)
function.getParameterType
in interface BindingParameter<java.lang.String>
public java.lang.String getTitleKey()
BindingParameter
getTitleKey
in interface BindingParameter<java.lang.String>
public java.lang.String getTooltipKey()
BindingParameter
getTooltipKey
in interface BindingParameter<java.lang.String>
public boolean isBindingAllowed()
BindingParameter
isBindingAllowed
in interface BindingParameter<java.lang.String>