Annotation Interface FieldBuilder.CustomField
- Enclosing class:
- FieldBuilder<T>
Specifies how a Java bean property should be edited using a
CustomField
.- See Also:
-
Required Element Summary
Modifier and TypeRequired ElementDescriptionClass<? extends CustomField>
Get the sub-type ofCustomField
that will edit the property. -
Optional Element Summary
Modifier and TypeOptional ElementDescriptionString[]
Add the specified class names.String[]
Add the specified theme names.Add the specified theme variants.boolean
Get the value desired for theenabled
property.Get the value desired for theerrorMessage
property.Get the value desired for theheight
property.Get the class to instantiate for thehelperComponent
property.Get the value desired for thehelperText
property.Get the value desired for theid
property.Get the value desired for thelabel
property.boolean
Get the value desired for themanualValidation
property.Get the value desired for themaxHeight
property.Get the value desired for themaxWidth
property.Get the value desired for theminHeight
property.Get the value desired for theminWidth
property.boolean
Get the value desired for thereadOnly
property.boolean
Get the value desired for therequiredIndicatorVisible
property.String[]
Specify CSS properties to be set viaStyle.set()
.int
Get the value desired for thetabIndex
property.Get the value desired for thetooltipText
property.boolean
Get the value desired for thevisible
property.Get the value desired for thewidth
property.
-
Element Details
-
implementation
Class<? extends CustomField> implementationGet the sub-type ofCustomField
that will edit the property.This property is required because
CustomField
is an abstract class.The specified type must have a public constructor that takes either no arguments, or one
FieldBuilderContext
.- Returns:
- field type
-
-
-
styleProperties
String[] stylePropertiesSpecify CSS properties to be set viaStyle.set()
.The array value consists of name, value pairs. If the array has odd length, the last element is ignored.
- Default:
- {}
-
addClassNames
String[] addClassNamesAdd the specified class names.- Returns:
- zero or more class names to add
- See Also:
- Default:
- {}
-
enabled
boolean enabledGet the value desired for theenabled
property.- Returns:
- desired
enabled
property value - See Also:
- Default:
- true
-
errorMessage
String errorMessageGet the value desired for theerrorMessage
property.- Returns:
- desired
errorMessage
property value - See Also:
- Default:
- ""
-
height
String heightGet the value desired for theheight
property.- Returns:
- desired
height
property value - See Also:
- Default:
- ""
-
helperComponent
Get the class to instantiate for thehelperComponent
property.- Returns:
- desired
helperComponent
property value type - See Also:
- Default:
- com.vaadin.flow.component.Component.class
-
helperText
String helperTextGet the value desired for thehelperText
property.- Returns:
- desired
helperText
property value - See Also:
- Default:
- ""
-
id
String idGet the value desired for theid
property.- Returns:
- desired
id
property value - See Also:
- Default:
- ""
-
label
String labelGet the value desired for thelabel
property.- Returns:
- desired
label
property value - See Also:
- Default:
- ""
-
manualValidation
boolean manualValidationGet the value desired for themanualValidation
property.- Returns:
- desired
manualValidation
property value - See Also:
- Default:
- false
-
maxHeight
String maxHeightGet the value desired for themaxHeight
property.- Returns:
- desired
maxHeight
property value - See Also:
- Default:
- ""
-
maxWidth
String maxWidthGet the value desired for themaxWidth
property.- Returns:
- desired
maxWidth
property value - See Also:
- Default:
- ""
-
minHeight
String minHeightGet the value desired for theminHeight
property.- Returns:
- desired
minHeight
property value - See Also:
- Default:
- ""
-
minWidth
String minWidthGet the value desired for theminWidth
property.- Returns:
- desired
minWidth
property value - See Also:
- Default:
- ""
-
readOnly
boolean readOnlyGet the value desired for thereadOnly
property.- Returns:
- desired
readOnly
property value - See Also:
- Default:
- false
-
requiredIndicatorVisible
boolean requiredIndicatorVisibleGet the value desired for therequiredIndicatorVisible
property.- Returns:
- desired
requiredIndicatorVisible
property value - See Also:
- Default:
- false
-
tabIndex
int tabIndexGet the value desired for thetabIndex
property.- Returns:
- desired
tabIndex
property value - See Also:
- Default:
- 0
-
addThemeNames
String[] addThemeNamesAdd the specified theme names.- Returns:
- zero or more theme names to add
- See Also:
- Default:
- {}
-
addThemeVariants
CustomFieldVariant[] addThemeVariantsAdd the specified theme variants.- Returns:
- zero or more theme variants to add
- See Also:
- Default:
- {}
-
tooltipText
String tooltipTextGet the value desired for thetooltipText
property.- Returns:
- desired
tooltipText
property value - See Also:
- Default:
- ""
-
visible
boolean visibleGet the value desired for thevisible
property.- Returns:
- desired
visible
property value - See Also:
- Default:
- true
-
width
String widthGet the value desired for thewidth
property.- Returns:
- desired
width
property value - See Also:
- Default:
- ""
-