net.sf.mmm.client.ui.api.attribute

Interface AttributeReadAllowCustomInput

All Known Subinterfaces:

AttributeWriteAllowCustomInput, UiWidgetComboboxField<VALUE>

All Known Implementing Classes:

AbstractUiWidgetComboboxField, AbstractUiWidgetListBoxField, AbstractUiWidgetOptionsField, AbstractUiWidgetRadioButtonsField, AbstractUiWidgetRadioButtonsVerticalField, UiWidgetComboboxFieldGwt, UiWidgetComboboxFieldTestImpl, UiWidgetRadioButtonsFieldGwt, UiWidgetRadioButtonsTestImpl, UiWidgetRadioButtonsVerticalFieldGwt, UiWidgetRadioButtonsVerticalFieldTestImpl

public interface AttributeReadAllowCustomInput

This interface gives read access to the allowCustomInput attribute of an object.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
boolean	isAllowCustomInput() This method determines if custom input is allowed by this object (widget).

Method Detail

isAllowCustomInput

boolean isAllowCustomInput()

This method determines if custom input is allowed by this object (widget). This is typically used in combination with options, that predefine values the user can select from. Some widgets like a combo box allow the user to enter any text. If this method returns false the entered text is only valid if it matches one of the predefined options. The default is false. You may change this by setting this flat to true. Please note that depending on the datatype this might not make sense. E.g. if you are using an Enum as value and the user enters arbitrary text this can not be converted to a non existent enum constant and therefore will only return null without causing a validation failure.

Returns:

true if custom input is allowed and accepted, false otherwise.