Class TextField

java.lang.Object

com.inet.taskplanner.server.api.field.Field

com.inet.taskplanner.server.api.field.TextField

@JsonData
public class TextField
extends Field

A text field that allows any value.

Since:

taskplanner 3.0

Constructor Summary

Constructors

Constructor	Description
TextField(String key, String label)	Creates the field for setting a text

Method Summary

Modifier and Type	Method	Description
String	patchResultPlaceholderInValue(String value, List<JobResultContainer> results)	Override to replace the placeholders with the values from the results
String	patchSeriesPlaceholderInValue(String value, Map<String,String> seriesProperties)	Override to replace the placeholders with the values from the series

Methods inherited from class Field

getConditions, getKey, getLabel, getPlaceholder, getType, getValue, isUpdateValuesOnChange, isValueSavable, replaceSeriesPlaceholders, setConditions, setKey, setLabel, setPlaceholder, setType, setType, setUpdateValuesOnChange, setValue, setValueSavable

Methods inherited from class Object

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

Constructor Details

TextField

public TextField(String key,
 String label)

Creates the field for setting a text

Parameters:

key - the key of the field

label - the label to be displayed in front of the field

Since:

taskplanner 3.0

Method Details

patchSeriesPlaceholderInValue

public String patchSeriesPlaceholderInValue(String value,
 Map<String,String> seriesProperties)

Override to replace the placeholders with the values from the series

Overrides:

patchSeriesPlaceholderInValue in class Field

Parameters:

value - the value to be patched

seriesProperties - properties from the current series set

Returns:

the new value with replaced placeholders

patchResultPlaceholderInValue

public String patchResultPlaceholderInValue(String value,
 List<JobResultContainer> results)

Override to replace the placeholders with the values from the results

Overrides:

patchResultPlaceholderInValue in class Field

Parameters:

value - the value to be patched

results - the results that contain the meta properties that are replaced

Returns:

the new value with replaced placeholders