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

Class SelectBuilder

java.lang.Object

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

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

All Implemented Interfaces:

OnlyIf<SelectBuilder>, Self<SelectBuilder>

public final class SelectBuilder
extends FormlyBuilder<SelectBuilder>

A Builder for a Formly Select.

 {
        "key": "key",
        "type": "select",
        "templateOptions": {
                "label": "label",
                "required": true,
                "multiple": true,
                "options": [
                        {
                                "label": "label",
                                "value": "value"
                        }, ...
                ]
        },
        "expressionProperties": {
                "templateOptions.required": "model.PROPERTY"
        },
        "hideExpression": "!model.PROPERTY",
        "defaultValue": "defaultValue"
 }
 

Field Summary

Fields

Modifier and Type	Field	Description
static final Function<OpenemsComponent,com.google.gson.JsonElement>	DEFAULT_COMPONENT_2_LABEL
static final Function<OpenemsComponent,com.google.gson.JsonElement>	DEFAULT_COMPONENT_2_VALUE

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

jsonObject, templateOptions

Constructor Summary

Constructors

Constructor	Description
SelectBuilder(Nameable property)

Method Summary

Modifier and Type	Method	Description
protected String	getType()
SelectBuilder	isMulti(boolean isMulti)	Sets if more than one options can be selected.
SelectBuilder	setOptions(com.google.gson.JsonArray options)
SelectBuilder	setOptions(OptionsFactory factory, Language l)
<T> SelectBuilder	setOptions(List<? extends T> items, Function<T,com.google.gson.JsonElement> item2Label, Function<T,com.google.gson.JsonElement> item2Value)
SelectBuilder	setOptions(List<String> items)
SelectBuilder	setOptions(Set<Map.Entry<String,String>> items)	Note the Map.entry(Object, Object) does not return a Comparable Object so the Set can not be a TreeSet.
<T, C> SelectBuilder	setOptions(Set<Map.Entry<T,C>> items, Function<T,String> item2Label, Function<C,String> item2Value)

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

addWrapper, build, 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

Field Details

DEFAULT_COMPONENT_2_LABEL

public static final Function<OpenemsComponent,com.google.gson.JsonElement> DEFAULT_COMPONENT_2_LABEL

DEFAULT_COMPONENT_2_VALUE

public static final Function<OpenemsComponent,com.google.gson.JsonElement> DEFAULT_COMPONENT_2_VALUE

Constructor Details

SelectBuilder

public SelectBuilder(Nameable property)

Method Details

setOptions

public SelectBuilder setOptions(com.google.gson.JsonArray options)

setOptions

public SelectBuilder setOptions(Set<Map.Entry<String,String>> items)

Note the Map.entry(Object, Object) does not return a Comparable Object so the Set can not be a TreeSet.

Parameters:

items - the options

Returns:

this

setOptions

public <T,
C> SelectBuilder setOptions(Set<Map.Entry<T,C>> items,
 Function<T,String> item2Label,
 Function<C,String> item2Value)

setOptions

public SelectBuilder setOptions(List<String> items)

setOptions

public <T> SelectBuilder setOptions(List<? extends T> items,
 Function<T,com.google.gson.JsonElement> item2Label,
 Function<T,com.google.gson.JsonElement> item2Value)

setOptions

public SelectBuilder setOptions(OptionsFactory factory,
 Language l)

isMulti

public SelectBuilder isMulti(boolean isMulti)

Sets if more than one options can be selected.

Parameters:

isMulti - if more options can be selected

Returns:

this

getType

protected String getType()

Specified by:

getType in class FormlyBuilder<SelectBuilder>