org.dominokit.domino.ui.utils

Interface IsRequired<T>

Type Parameters:

T - the type of the component implementing this interface

All Known Subinterfaces:

FormElement<T,V>, HasGrouping<T>

All Known Implementing Classes:

AbstractSelect, AbstractSuggestBox, AbstractTagsInput, AbstractValueBox, BasicFormElement, BigDecimalBox, CheckBox, DateBox, DoubleBox, EmailBox, FloatBox, InputTimeBox, InputValueBox, IntegerBox, LongBox, MultiSelect, NumberBox, RadioGroup, Select, ShortBox, SuggestBox, SwitchButton, TagsInput, TelephoneBox, TextArea, TextBox, TimeBox, ValueBox

public interface IsRequired<T>

Components that need to have required value validation should implement this interface

Method Summary

Modifier and Type	Method and Description
String	getRequiredErrorMessage()
boolean	isRequired()
T	setRequired(boolean required)
T	setRequired(boolean required, String message)
T	setRequiredErrorMessage(String requiredErrorMessage)

Method Detail

setRequired

@Editor.Ignore
T setRequired(boolean required)

Parameters:

required - boolean, true to make the component value as required

Returns:

same implementing component instance

setRequired

@Editor.Ignore
T setRequired(boolean required,
                             String message)

Parameters:

required - boolean, true to make the component value required

message - String to show as error message when the value is missing

Returns:

same implementing component instance

isRequired

@Editor.Ignore
boolean isRequired()

Returns:

boolean, true if the component value is required

setRequiredErrorMessage

@Editor.Ignore
T setRequiredErrorMessage(String requiredErrorMessage)

Parameters:

requiredErrorMessage - String error message to show when the value is missing

Returns:

same implementing component instance

getRequiredErrorMessage

@Editor.Ignore
String getRequiredErrorMessage()

Returns:

String required error message