Package io.openems.edge.core.appmanager.formly.builder

Class InputBuilder

java.lang.Object

io.openems.edge.core.appmanager.formly.builder.FormlyBuilder<InputBuilder>

io.openems.edge.core.appmanager.formly.builder.InputBuilder

All Implemented Interfaces:

OnlyIf<InputBuilder>, Self<InputBuilder>

public final class InputBuilder
extends FormlyBuilder<InputBuilder>

A Builder for a Formly Input.

 {
        "key": "key",
        "type": "input",
        "templateOptions": {
                "type": "number",
                "label": "label",
                "placeholder": "placeholder",
                "required": true,
                "min": 0,
                "max": 100,
                "minLenght": 6,
                "maxLenght": 18,
                "pattern": /(\d{1,3}\.){3}\d{1,3}/
        },
        "validation": {
                "messages": {
                        "pattern": "Input is not a valid IP Address!",
                },
        },
        "expressionProperties": {
                "templateOptions.required": "model.PROPERTY"
        },
        "hideExpression": "!model.PROPERTY",
        "defaultValue": "defaultValue"
 }
 

Field Summary

Fields inherited from class io.openems.edge.core.appmanager.formly.builder.FormlyBuilder

jsonObject, templateOptions

Constructor Summary

Constructors

Constructor	Description
InputBuilder(Nameable property)

Method Summary

Modifier and Type	Method	Description
com.google.gson.JsonObject	build()
protected String	getType()
protected final com.google.gson.JsonObject	getValidation()
InputBuilder	onlyPositiveNumbers()	Only allows positive number as a input.
InputBuilder	setInputType(InputType type)	Sets the type of the input.
InputBuilder	setMax(int max)	Sets the max value of the input.
InputBuilder	setMaxLenght(int maxLength)	Sets the minLength of the input.
InputBuilder	setMin(int min)	Sets the min value of the input.
InputBuilder	setMinLenght(int minLength)	Sets the minLength of the input.
InputBuilder	setPlaceholder(String placeholder)
InputBuilder	setUnit(Unit unit, Language l)
InputBuilder	setValidation(Validation validation)	Sets the validation of the Input.

Methods inherited from class io.openems.edge.core.appmanager.formly.builder.FormlyBuilder

addWrapper, disabled, getDefaultValue, getExpressionProperties, getValidators, hide, hideKey, isRequired, onlyShowIf, readonly, self, setCustomValidation, setCustomValidation, setCustomValidation, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValueCases, setDefaultValueWithBooleanSupplier, setDefaultValueWithStringSupplier, setDescription, setKey, setLabel, setLabelExpression

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.openems.edge.core.appmanager.OnlyIf

onlyIf

Constructor Details

InputBuilder

public InputBuilder(Nameable property)

Method Details

setInputType

public InputBuilder setInputType(InputType type)

Sets the type of the input.

Default: InputType.TEXT

Parameters:

type - to be set

Returns:

this

setPlaceholder

public InputBuilder setPlaceholder(String placeholder)

setMin

public InputBuilder setMin(int min)

Sets the min value of the input.

Parameters:

min - the min number that can be set

Returns:

this

Throws:

IllegalArgumentException - if the type is not set to number

setMax

public InputBuilder setMax(int max)

Sets the max value of the input.

Parameters:

max - the max number that can be set

Returns:

this

Throws:

IllegalArgumentException - if the type is not set to number

setMinLenght

public InputBuilder setMinLenght(int minLength)

Sets the minLength of the input.

Parameters:

minLength - the min length the input needs

Returns:

this

Throws:

IllegalArgumentException - if the type is not set to password or text

setMaxLenght

public InputBuilder setMaxLenght(int maxLength)

Sets the minLength of the input.

Parameters:

maxLength - the max length the input needs

Returns:

this

Throws:

IllegalArgumentException - if the type is not set to password or text

setValidation

public InputBuilder setValidation(Validation validation)

Sets the validation of the Input.

e. g. to set the validation of an IP use Validation.IP

Parameters:

validation - the validation to be set

Returns:

this

onlyPositiveNumbers

public InputBuilder onlyPositiveNumbers()

Only allows positive number as a input.

Returns:

this

Throws:

IllegalArgumentException - if this InputBuilder has not been set to a InputType.NUMBER input via the InputBuildersetInputType(InputType) method.

setUnit

public InputBuilder setUnit(Unit unit,
 Language l)

getType

protected String getType()

Specified by:

getType in class FormlyBuilder<InputBuilder>

build

public com.google.gson.JsonObject build()

Overrides:

build in class FormlyBuilder<InputBuilder>

getValidation

protected final com.google.gson.JsonObject getValidation()