org.hkijena.jipipe.extensions.parameters.api.enums

Class DynamicEnumParameter<T>

java.lang.Object

org.hkijena.jipipe.extensions.parameters.api.enums.DynamicEnumParameter<T>

Direct Known Subclasses:

DynamicDataDisplayOperationIdEnumParameter, DynamicDataImportOperationIdEnumParameter, DynamicStringEnumParameter, ProjectsSettings.ProjectTemplateEnum, TableColumnConversionParameter, TableColumnIntegrationParameter, UIPlotDataSeriesColumnEnum

public abstract class DynamicEnumParameter<T>
extends Object

Parameter that acts as dynamic enum. Use DynamicEnumParameterSettings to define a supplier for the items. Alternatively, use allowedValues to supply items. allowedValues is preferred. If allowedValues is null, you have to use DynamicEnumParameterSettings.

Constructor Summary

Constructors

Constructor and Description
DynamicEnumParameter() Creates a new instance with null value
DynamicEnumParameter(T value) Creates a new instance

Method Summary

Modifier and Type	Method and Description
List<T>	getAllowedValues() Returns the list of allowed choices Please note that if isEditable() is true, other options might be available
String	getSearchString(T value) The search string used for the searchable mode
T	getValue()
boolean	isEditable() If this returns true, the user can freely edit the entry
Icon	renderIcon(T value) Function that renders the icon.
String	renderLabel(T value) Function that renders the label.
String	renderTooltip(T value) Function that renders the tooltip.
void	setAllowedValues(List<T> allowedValues)
void	setValue(T value)

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicEnumParameter

public DynamicEnumParameter()

Creates a new instance with null value

DynamicEnumParameter

public DynamicEnumParameter(T value)

Creates a new instance

Parameters:

value - initial value

Method Detail

getValue

public T getValue()

setValue

public void setValue(T value)

getAllowedValues

public List<T> getAllowedValues()

Returns the list of allowed choices Please note that if isEditable() is true, other options might be available

Returns:

the allowed values

setAllowedValues

public void setAllowedValues(List<T> allowedValues)

renderLabel

public String renderLabel(T value)

Function that renders the label. This is used in UI.

Parameters:

value - the value

Returns:

the rendered text

renderTooltip

public String renderTooltip(T value)

Function that renders the tooltip. This is used in UI.

Parameters:

value - the tooltip

Returns:

the rendered tooltip

renderIcon

public Icon renderIcon(T value)

Function that renders the icon. This is used in UI.

Parameters:

value - the value

Returns:

the rendered icon

getSearchString

public String getSearchString(T value)

The search string used for the searchable mode

Returns:

the search string

isEditable

public boolean isEditable()

If this returns true, the user can freely edit the entry

Returns:

if the user can freely edit the entry