HasHelperPositionable (SuperFields 0.17.0 API)

All Superinterfaces:

com.vaadin.flow.component.HasElement, Serializable

All Known Subinterfaces:

WithHelperPositionableMixin<SELF>

All Known Implementing Classes:

AbstractSuperFloatingPointField, AbstractSuperNumberField, CollectionField, GridMultiSelect, GridSelect, HeaderFooterFieldWrapper, ItemGrid, LabelField, MapField, ObjectField, SuperBigDecimalField, SuperDatePicker, SuperDateTimePicker, SuperDoubleField, SuperIntegerField, SuperLongField, SuperTabs, SuperTextArea, SuperTextField, VariantField
```
public interface HasHelperPositionable
extends com.vaadin.flow.component.HasElement
```
Allows controlling position of the helper text/component.

Since:

2021-10-29

Author:

miki

Field Summary

Fields
Modifier and Type Field Description

static String HELPER_ABOVE_THEME_VARIANT
Vaadin expects this in the theme list.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method	Description
`default boolean`	`isHelperAbove()`	Checks if the helper is positioned above.
`default void`	`setHelperAbove()`	Positions the helper above the component.
`default void`	`setHelperAbove(boolean above)`	Positions the helper above or below the component.
`default void`	`setHelperBelow()`	Positions the helper below the component.

Methods inherited from interface com.vaadin.flow.component.HasElement
getElement

- Field Detail
  - HELPER_ABOVE_THEME_VARIANT
```
static final String HELPER_ABOVE_THEME_VARIANT
```
    Vaadin expects this in the theme list.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - setHelperAbove
```
default void setHelperAbove()
```
    Positions the helper above the component.
  - setHelperBelow
```
default void setHelperBelow()
```
    Positions the helper below the component.
  - setHelperAbove
```
default void setHelperAbove(boolean above)
```
    Positions the helper above or below the component.
    
    Parameters:
    
    above - When true, helper should be positioned above.
    
    See Also:
    
    setHelperAbove(), setHelperBelow()
  - isHelperAbove
```
default boolean isHelperAbove()
```
    Checks if the helper is positioned above.
    
    Returns:
    
    When true, helper should be positioned above.