
org.dellroad.stuff.vaadin24.field.FieldBuilder Maven / Gradle / Ivy
Show all versions of dellroad-stuff-vaadin24 Show documentation
/*
* Copyright (C) 2022 Archie L. Cobbs. All rights reserved.
*/
package org.dellroad.stuff.vaadin24.field;
import com.vaadin.flow.component.dependency.Uses;
import com.vaadin.flow.data.binder.Binder;
import com.vaadin.flow.data.binder.Validator;
import com.vaadin.flow.data.converter.Converter;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.dellroad.stuff.vaadin24.data.EnumDataProvider;
/**
* Automatically configures and binds fields using declarative method annotations.
*
*
*
*
*
*
* {@link FieldBuilder} annotations allow for the automatic construction and configuration of fields for editing a bean.
* Annotations on "getter" methods specify how the fields that edit the corresponding bean property should be constructed,
* configured, and bound to a {@link Binder}. This allows all information about how to edit a Java type
* to be specified declaratively. Annotations are also provided to configure how to add the generated fields to a
* {@link com.vaadin.flow.component.formlayout.FormLayout}.
*
*
* The primary method is {@link #bindFields bindFields()}, which automatically creates, configures, and binds fields
* into a given {@link Binder} based on information gleaned from scanned annotations.
*
*
{@code @FieldBuilder.Foo} vs. {@code @ProvidesField}
*
*
* {@link FieldBuilder} supports two types of annotations from which it infers how to construct and configure a field
* for editing an associated bean property.
*
*
* The various {@code @FieldBuilder.Foo} annotations are the purely declarative way to specify how to construct a field.
* Each annotation corresponds to a specific field class (e.g., {@link TextField @FieldBuilder.TextField}
* configures a {@link com.vaadin.flow.component.textfield.TextField}). The annotation's properties parallel the
* properties of the field and specify how to construct, configure, and bind an instance of the field.
* The annotation annotates the bean property's "getter" method.
*
*
* {@link AbstractFieldBuilder.ProvidesField @ProvidesField} provides a more general approach, but it requires writing code.
* Use {@link AbstractFieldBuilder.ProvidesField @ProvidesField} on a method that itself knows how to build a field suitable
* for editing the named property. The method should return a component for editing the property. Both instance and static
* methods are supported; instance methods require that the {@link Binder} being used has a bound bean.
*
*
* In all cases, an annotation on a subclass method will override the same annotation on the corresponding superclass method.
*
*
* Fields defined from these annotations are created, configured, and bound via {@link #bindFields bindFields()}.
*
*
Configuring the Binding
*
*
* In addition to constructing and configuring the fields associated with each bean property into the {@link Binder},
* you may also want to configure the bindings themselves, for example, to specify a {@link Converter} or {@link Validator}.
* The {@link AbstractFieldBuilder.Binding @FieldBuilder.Binding} annotation allows you to configure the
* binding using properties corresponding to methods in {@link Binder.BindingBuilder}.
*
*
Adding Fields to a {@link com.vaadin.flow.component.formlayout.FormLayout}
*
*
* The {@link FieldBuilder.FormLayout @FieldBuilder.FormLayout} annotation allows you to configure field labels,
* column span, and ordering of fields in a {@link com.vaadin.flow.component.formlayout.FormLayout}.
*
*
* Fields are added to a {@link com.vaadin.flow.component.formlayout.FormLayout} via
* {@link #addFieldComponents addFieldComponents()}.
*
*
Example
*
*
* A simple example shows how these annotations are used:
*
* @FieldBuilder.TextField(placeholder = "Enter your name...", maxLength = 64)
* @FieldBuilder.Binding(required = "Name is mandatory", validators = MyValidator.class)
* @FieldBuilder.FormLayout(label = "Name:", colspan = 2, order = 1)
* @NotNull
* public String getName() { ... }
*
* @FieldBuilder.ComboBox(items = EnumDataProvider.class)
* @FieldBuilder.Binding(required = "Status is mandatory")
* @FieldBuilder.FormLayout(label = "Status:", order = 2)
* @NotNull
* public Status getStatus() { ... }
*
* // A property that can't be edited with existing fields
* public Foobar getFoobar() { ... }
*
* // Instead, use my own custom field to edit "foobar"
* @FieldBuilder.ProvidesField("foobar")
* @FieldBuilder.FormLayout(label = "Your Foobar:", order = 3)
* private static CustomField<Foobar> createFoobarField() { ... }
*
*
*
* All of the declarative {@code @FieldBuilder.Foo} annotations have an {@code implementation()} property that allows you
* to specify a custom implementation. So a more consistent way to customize the {@code "foobar"} component would be:
*
*
* // Use my own custom FoobarField to edit "foobar"
* @FieldBuilder.CustomField(label = "Your Foobar:", implementation = FoobarField.class)
* public Foobar getFoobar() { ... }
*
*
* Building the Form
*
*
* First, use {@link #bindFields bindFields()} to create a new set of fields, configure them, and bind them into a {@link Binder}:
*
*
* // Create a FieldBuilder
* FieldBuilder<Person> fieldBuilder = new FieldBuilder<>(Person.class);
*
* // Create a Binder and bind fields
* Binder<Person> binder = new Binder<>(Person.class);
* fieldBuilder.bindFields(binder);
*
*
*
* Then (optionally) use {@link #addFieldComponents addFieldComponents()} to add and configure those fields into a
* {@link com.vaadin.flow.component.formlayout.FormLayout}:
*
*
* // Create form and add fields to it
* FormLayout form = new FormLayout();
* fieldBuilder.addFieldComponents(form);
*
*
*
* You can also access the fields directly via {@link #getFieldComponents getFieldComponents()}.
*
*
Efficient Reuse
*
*
* A {@link FieldBuilder} can be used multiple times. Each time {@link #bindFields bindFields()} is invoked any previously
* created fields are forgotten and a new set of fields is created and bound. This avoids the relatively expensive process
* of scanning the class hierarchy for annotations that occurs during construction.
*
*
* {@link FieldBuilder} also has a copy constructor, which accomplishes the same thing.
*
*
Alternate Defaults
*
*
* You can override the default value for specific field properties on a per-property-name basis by annotating static methods
* in the edited model class with {@link AbstractFieldBuilder.FieldDefault @FieldBuilder.FieldDefault}.
*
*
* For example:
*
*
* public class Person {
* public String getFirstName() { ... }
* public String getLastName() { ... }
*
* @FieldBuilder.FieldDefault("itemLabelGenerator")
* private static ItemLabelGenerator<Person> buildPersonILG() {
* return person -> person.getLastName() + ", " + person.getFirstName();
* }
* }
*
*
*
* These defaults can be accessed via {@link #getScannedFieldDefaults getScannedFieldDefaults()}.
*
*
* See {@link AbstractFieldBuilder.FieldDefault @FieldBuilder.FieldDefault} for details.
*
*
Providing Context via FieldBuilderContext
*
*
* All classes instantiated by {@link FieldBuilder} (fields, data providers, converters, validatiors, etc.) are instantiated
* using the default constructor, unless a constructor taking a {@link FieldBuilderContext} exists, in which case it will
* be used instead. In this latter case, the new object can do further introspection of the method and/or annotation
* for the purpose of doing additional automated self-configuration.
*
*
* For example, a {@link ComboBox @FieldBuilder.ComboBox} annotation might specify a general purpose
* {@link com.vaadin.flow.data.provider.DataProvider} implementation that determines which object type to provide from
* the method's return type. This is how {@link EnumDataProvider} automatically infers the {@link Enum} type to use.
*
*
* Override {@link #newFieldBuilderContext newFieldBuilderContext()} if you wish to pass a custom context; the constructor
* chosen will be the one with the narrowest type compatible with the actual {@link FieldBuilderContext} in use.
*
*
Automatic Validator Registration
*
*
* This class automatically registers validators with the {@link Binder} as follows:
*
* - If a field implements {@link ValidatingField}, a corresponding field validator will be registered
*
- If the target bean class implements {@link ValidatingBean}, a corresponding bean-level validator will be registered
*
*
*
* This allows for more modularity, especially when nested types having sub-fields are in use; for example,
* {@link FieldBuilderCustomField} relies on this mechanism.
*
*
Production Bundle Caveat
*
*
* If you build a Vaadin production bundle then you may run into an issue where a field does not appear and Vaadin logs
* a warning like this:
*
* The component class com.vaadin.flow.component.datepicker.DatePicker includes
* '@vaadin/date-picker/src/vaadin-date-picker.js' but this file was not included when creating the production
* bundle. The component will not work properly. Check that you have a reference to the component and that you are
* not using it only through reflection. If needed add a @Uses(DatePicker.class) where it is used.
*
* This happens because Vaadin thinks your application never uses {@link DatePicker} because it doesn't see your code
* directly instantiating one anywhere. In other words, the indirect instantiation by this class goes undetected.
* To fix this, either add the {@link Uses @Uses} annotation to one of your view classes as described in the warning,
* or else configure your Vaadin Maven plugin with {@code false }.
*
* Homebrew Your Own
*
* You can create your own version of this class containing auto-generated annotations for whatever classes you want
* simply by subclassing {@link AbstractFieldBuilder} and applying a Maven plugin. See source code for details.
*
* @param backing object type
* @see Checkbox
* @see CheckboxGroup
* @see ComboBox
* @see MultiSelectComboBox
* @see CustomField
* @see DatePicker
* @see DateTimePicker
* @see Input
* @see RangeInput
* @see ListBox
* @see MultiSelectListBox
* @see RadioButtonGroup
* @see Select
* @see BigDecimalField
* @see EmailField
* @see IntegerField
* @see NumberField
* @see PasswordField
* @see TextArea
* @see TextField
* @see TimePicker
*/
public class FieldBuilder extends AbstractGridFieldBuilder, T> {
private static final long serialVersionUID = -4876472481099484174L;
/**
* Constructor.
*
* @param type backing object type
*/
public FieldBuilder(Class type) {
super(type);
}
/**
* Static information copy constructor.
*
*
* Using this constructor is more efficient than repeatedly scanning the same classes for the same annotations.
*
*
* Only the static information gathered by this instance by scanning for annotations is copied.
* Any previously bound fields are not copied.
*
* @param original original instance
* @throws IllegalArgumentException if {@code original} is null
*/
public FieldBuilder(FieldBuilder original) {
super(original);
}
// EVERYTHING BELOW THIS LINE IS GENERATED
@Checkbox
@CheckboxGroup
@ComboBox
@MultiSelectComboBox
@CustomField(implementation = com.vaadin.flow.component.customfield.CustomField.class)
@DatePicker
@DateTimePicker
@Input
@RangeInput
@ListBox
@MultiSelectListBox
@RadioButtonGroup
@Select
@BigDecimalField
@EmailField
@IntegerField
@NumberField
@PasswordField
@TextArea
@TextField
@TimePicker
private static java.util.List> annotationDefaultsMethod() {
return java.util.Arrays.asList(
Checkbox.class,
CheckboxGroup.class,
ComboBox.class,
MultiSelectComboBox.class,
CustomField.class,
DatePicker.class,
DateTimePicker.class,
Input.class,
RangeInput.class,
ListBox.class,
MultiSelectListBox.class,
RadioButtonGroup.class,
Select.class,
BigDecimalField.class,
EmailField.class,
IntegerField.class,
NumberField.class,
PasswordField.class,
TextArea.class,
TextField.class,
TimePicker.class
);
}
/**
* Specifies how a Java bean property should be edited using a {@link com.vaadin.flow.component.checkbox.Checkbox}.
*
* @see FieldBuilder
* @see com.vaadin.flow.component.checkbox.Checkbox
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface Checkbox {
/**
* Get the sub-type of {@link com.vaadin.flow.component.checkbox.Checkbox} that will edit the property.
*
*
* This property allows custom widget subclasses to be used.
*
*
* The specified type must have a public constructor that takes either no arguments,
* or one {@code FieldBuilderContext}.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.checkbox.Checkbox> implementation() default com.vaadin.flow.component.checkbox.Checkbox.class;
/**
* Specify CSS properties to be set via {@link com.vaadin.flow.dom.Style#set Style.set()}.
*
*
* The array value consists of name, value pairs. If the array has odd length, the last element is ignored.
*
* @return zero or more style property name, value pairs
* @see com.vaadin.flow.dom.Style
* @see com.vaadin.flow.component.HasStyle
*/
String[] styleProperties() default {};
/**
* Get the value desired for the {@code ariaLabel} property.
*
* @return desired {@code ariaLabel} property value
* @see com.vaadin.flow.component.checkbox.Checkbox#setAriaLabel(String)
*/
String ariaLabel() default "";
/**
* Get the value desired for the {@code ariaLabelledBy} property.
*
* @return desired {@code ariaLabelledBy} property value
* @see com.vaadin.flow.component.checkbox.Checkbox#setAriaLabelledBy(String)
*/
String ariaLabelledBy() default "";
/**
* Get the value desired for the {@code autofocus} property.
*
* @return desired {@code autofocus} property value
* @see com.vaadin.flow.component.checkbox.Checkbox#setAutofocus(boolean)
*/
boolean autofocus() default false;
/**
* Add the specified class names.
*
* @return zero or more class names to add
* @see com.vaadin.flow.component.HasStyle#addClassNames(String[])
*/
String[] addClassNames() default {};
/**
* Get the value desired for the {@code enabled} property.
*
* @return desired {@code enabled} property value
* @see com.vaadin.flow.component.HasEnabled#setEnabled(boolean)
*/
boolean enabled() default true;
/**
* Get the value desired for the {@code errorMessage} property.
*
* @return desired {@code errorMessage} property value
* @see com.vaadin.flow.component.shared.HasValidationProperties#setErrorMessage(String)
*/
String errorMessage() default "";
/**
* Get the value desired for the {@code height} property.
*
* @return desired {@code height} property value
* @see com.vaadin.flow.component.HasSize#setHeight(String)
*/
String height() default "";
/**
* Get the class to instantiate for the {@code helperComponent} property.
*
* @return desired {@code helperComponent} property value type
* @see com.vaadin.flow.component.HasHelper#setHelperComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> helperComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code helperText} property.
*
* @return desired {@code helperText} property value
* @see com.vaadin.flow.component.HasHelper#setHelperText(String)
*/
String helperText() default "";
/**
* Get the value desired for the {@code id} property.
*
* @return desired {@code id} property value
* @see com.vaadin.flow.component.Component#setId(String)
*/
String id() default "";
/**
* Get the value desired for the {@code indeterminate} property.
*
* @return desired {@code indeterminate} property value
* @see com.vaadin.flow.component.checkbox.Checkbox#setIndeterminate(boolean)
*/
boolean indeterminate() default false;
/**
* Get the value desired for the {@code label} property.
*
* @return desired {@code label} property value
* @see com.vaadin.flow.component.checkbox.Checkbox#setLabel(String)
*/
String label() default "";
/**
* Get the class to instantiate for the {@code labelComponent} property.
*
* @return desired {@code labelComponent} property value type
* @see com.vaadin.flow.component.checkbox.Checkbox#setLabelComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> labelComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code manualValidation} property.
*
* @return desired {@code manualValidation} property value
* @see com.vaadin.flow.component.checkbox.Checkbox#setManualValidation(boolean)
*/
boolean manualValidation() default false;
/**
* Get the value desired for the {@code maxHeight} property.
*
* @return desired {@code maxHeight} property value
* @see com.vaadin.flow.component.HasSize#setMaxHeight(String)
*/
String maxHeight() default "";
/**
* Get the value desired for the {@code maxWidth} property.
*
* @return desired {@code maxWidth} property value
* @see com.vaadin.flow.component.HasSize#setMaxWidth(String)
*/
String maxWidth() default "";
/**
* Get the value desired for the {@code minHeight} property.
*
* @return desired {@code minHeight} property value
* @see com.vaadin.flow.component.HasSize#setMinHeight(String)
*/
String minHeight() default "";
/**
* Get the value desired for the {@code minWidth} property.
*
* @return desired {@code minWidth} property value
* @see com.vaadin.flow.component.HasSize#setMinWidth(String)
*/
String minWidth() default "";
/**
* Get the value desired for the {@code readOnly} property.
*
* @return desired {@code readOnly} property value
* @see com.vaadin.flow.component.HasValueAndElement#setReadOnly(boolean)
*/
boolean readOnly() default false;
/**
* Get the value desired for the {@code requiredIndicatorVisible} property.
*
* @return desired {@code requiredIndicatorVisible} property value
* @see com.vaadin.flow.component.HasValueAndElement#setRequiredIndicatorVisible(boolean)
*/
boolean requiredIndicatorVisible() default false;
/**
* Get the value desired for the {@code tabIndex} property.
*
* @return desired {@code tabIndex} property value
* @see com.vaadin.flow.component.Focusable#setTabIndex(int)
*/
int tabIndex() default 0;
/**
* Get the value desired for the {@code tooltipText} property.
*
* @return desired {@code tooltipText} property value
* @see com.vaadin.flow.component.shared.HasTooltip#setTooltipText(String)
*/
String tooltipText() default "";
/**
* Get the value desired for the {@code visible} property.
*
* @return desired {@code visible} property value
* @see com.vaadin.flow.component.Component#setVisible(boolean)
*/
boolean visible() default true;
/**
* Get the value desired for the {@code width} property.
*
* @return desired {@code width} property value
* @see com.vaadin.flow.component.HasSize#setWidth(String)
*/
String width() default "";
}
/**
* Specifies how a Java bean property should be edited using a {@link com.vaadin.flow.component.checkbox.CheckboxGroup}.
*
* @see FieldBuilder
* @see com.vaadin.flow.component.checkbox.CheckboxGroup
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface CheckboxGroup {
/**
* Get the sub-type of {@link com.vaadin.flow.component.checkbox.CheckboxGroup} that will edit the property.
*
*
* This property allows custom widget subclasses to be used.
*
*
* The specified type must have a public constructor that takes either no arguments,
* or one {@code FieldBuilderContext}.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.checkbox.CheckboxGroup> implementation() default com.vaadin.flow.component.checkbox.CheckboxGroup.class;
/**
* Specify CSS properties to be set via {@link com.vaadin.flow.dom.Style#set Style.set()}.
*
*
* The array value consists of name, value pairs. If the array has odd length, the last element is ignored.
*
* @return zero or more style property name, value pairs
* @see com.vaadin.flow.dom.Style
* @see com.vaadin.flow.component.HasStyle
*/
String[] styleProperties() default {};
/**
* Get the value desired for the {@code ariaLabel} property.
*
* @return desired {@code ariaLabel} property value
* @see com.vaadin.flow.component.checkbox.CheckboxGroup#setAriaLabel(String)
*/
String ariaLabel() default "";
/**
* Get the value desired for the {@code ariaLabelledBy} property.
*
* @return desired {@code ariaLabelledBy} property value
* @see com.vaadin.flow.component.checkbox.CheckboxGroup#setAriaLabelledBy(String)
*/
String ariaLabelledBy() default "";
/**
* Add the specified class names.
*
* @return zero or more class names to add
* @see com.vaadin.flow.component.HasStyle#addClassNames(String[])
*/
String[] addClassNames() default {};
/**
* Get the class to instantiate for the {@code dataProvider} property.
*
* @return desired {@code dataProvider} property value type
* @see com.vaadin.flow.component.checkbox.CheckboxGroup#setDataProvider(com.vaadin.flow.data.provider.DataProvider)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.data.provider.DataProvider> dataProvider() default com.vaadin.flow.data.provider.DataProvider.class;
/**
* Get the value desired for the {@code enabled} property.
*
* @return desired {@code enabled} property value
* @see com.vaadin.flow.component.HasEnabled#setEnabled(boolean)
*/
boolean enabled() default true;
/**
* Get the value desired for the {@code errorMessage} property.
*
* @return desired {@code errorMessage} property value
* @see com.vaadin.flow.component.shared.HasValidationProperties#setErrorMessage(String)
*/
String errorMessage() default "";
/**
* Get the value desired for the {@code height} property.
*
* @return desired {@code height} property value
* @see com.vaadin.flow.component.HasSize#setHeight(String)
*/
String height() default "";
/**
* Get the class to instantiate for the {@code helperComponent} property.
*
* @return desired {@code helperComponent} property value type
* @see com.vaadin.flow.component.HasHelper#setHelperComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> helperComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code helperText} property.
*
* @return desired {@code helperText} property value
* @see com.vaadin.flow.component.HasHelper#setHelperText(String)
*/
String helperText() default "";
/**
* Get the value desired for the {@code id} property.
*
* @return desired {@code id} property value
* @see com.vaadin.flow.component.Component#setId(String)
*/
String id() default "";
/**
* Get the class to instantiate for the {@code itemEnabledProvider} property.
*
* @return desired {@code itemEnabledProvider} property value type
* @see com.vaadin.flow.component.checkbox.CheckboxGroup#setItemEnabledProvider(com.vaadin.flow.function.SerializablePredicate)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.function.SerializablePredicate> itemEnabledProvider() default com.vaadin.flow.function.SerializablePredicate.class;
/**
* Get the class to instantiate for the {@code itemHelperGenerator} property.
*
* @return desired {@code itemHelperGenerator} property value type
* @see com.vaadin.flow.component.checkbox.CheckboxGroup#setItemHelperGenerator(com.vaadin.flow.component.checkbox.CheckboxGroup.ItemHelperGenerator)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.checkbox.CheckboxGroup.ItemHelperGenerator> itemHelperGenerator() default com.vaadin.flow.component.checkbox.CheckboxGroup.ItemHelperGenerator.class;
/**
* Get the class to instantiate for the {@code itemLabelGenerator} property.
*
* @return desired {@code itemLabelGenerator} property value type
* @see com.vaadin.flow.component.checkbox.CheckboxGroup#setItemLabelGenerator(com.vaadin.flow.component.ItemLabelGenerator)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.ItemLabelGenerator> itemLabelGenerator() default com.vaadin.flow.component.ItemLabelGenerator.class;
/**
* Get the class to instantiate for the {@code items} property.
*
* @return desired {@code items} property value type
* @see com.vaadin.flow.component.checkbox.CheckboxGroup#setItems(com.vaadin.flow.data.provider.DataProvider)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.data.provider.DataProvider> items() default com.vaadin.flow.data.provider.DataProvider.class;
/**
* Get the value desired for the {@code label} property.
*
* @return desired {@code label} property value
* @see com.vaadin.flow.component.checkbox.CheckboxGroup#setLabel(String)
*/
String label() default "";
/**
* Get the value desired for the {@code manualValidation} property.
*
* @return desired {@code manualValidation} property value
* @see com.vaadin.flow.component.checkbox.CheckboxGroup#setManualValidation(boolean)
*/
boolean manualValidation() default false;
/**
* Get the value desired for the {@code maxHeight} property.
*
* @return desired {@code maxHeight} property value
* @see com.vaadin.flow.component.HasSize#setMaxHeight(String)
*/
String maxHeight() default "";
/**
* Get the value desired for the {@code maxWidth} property.
*
* @return desired {@code maxWidth} property value
* @see com.vaadin.flow.component.HasSize#setMaxWidth(String)
*/
String maxWidth() default "";
/**
* Get the value desired for the {@code minHeight} property.
*
* @return desired {@code minHeight} property value
* @see com.vaadin.flow.component.HasSize#setMinHeight(String)
*/
String minHeight() default "";
/**
* Get the value desired for the {@code minWidth} property.
*
* @return desired {@code minWidth} property value
* @see com.vaadin.flow.component.HasSize#setMinWidth(String)
*/
String minWidth() default "";
/**
* Get the value desired for the {@code readOnly} property.
*
* @return desired {@code readOnly} property value
* @see com.vaadin.flow.component.HasValueAndElement#setReadOnly(boolean)
*/
boolean readOnly() default false;
/**
* Get the class to instantiate for the {@code renderer} property.
*
* @return desired {@code renderer} property value type
* @see com.vaadin.flow.component.checkbox.CheckboxGroup#setRenderer(com.vaadin.flow.data.renderer.ComponentRenderer)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.data.renderer.ComponentRenderer> renderer() default com.vaadin.flow.data.renderer.ComponentRenderer.class;
/**
* Get the value desired for the {@code required} property.
*
* @return desired {@code required} property value
* @see com.vaadin.flow.component.checkbox.CheckboxGroup#setRequired(boolean)
*/
boolean required() default false;
/**
* Get the value desired for the {@code requiredIndicatorVisible} property.
*
* @return desired {@code requiredIndicatorVisible} property value
* @see com.vaadin.flow.component.HasValueAndElement#setRequiredIndicatorVisible(boolean)
*/
boolean requiredIndicatorVisible() default false;
/**
* Get the value desired for the {@code selectionPreservationMode} property.
*
* @return desired {@code selectionPreservationMode} property value
* @see com.vaadin.flow.component.checkbox.CheckboxGroup#setSelectionPreservationMode(com.vaadin.flow.component.shared.SelectionPreservationMode)
*/
com.vaadin.flow.component.shared.SelectionPreservationMode selectionPreservationMode() default com.vaadin.flow.component.shared.SelectionPreservationMode.DISCARD;
/**
* Add the specified theme names.
*
* @return zero or more theme names to add
* @see com.vaadin.flow.component.HasTheme#addThemeNames(String[])
*/
String[] addThemeNames() default {};
/**
* Add the specified theme variants.
*
* @return zero or more theme variants to add
* @see com.vaadin.flow.component.shared.HasThemeVariant#addThemeVariants(com.vaadin.flow.component.shared.ThemeVariant[])
*/
com.vaadin.flow.component.checkbox.CheckboxGroupVariant[] addThemeVariants() default {};
/**
* Get the value desired for the {@code tooltipText} property.
*
* @return desired {@code tooltipText} property value
* @see com.vaadin.flow.component.shared.HasTooltip#setTooltipText(String)
*/
String tooltipText() default "";
/**
* Get the value desired for the {@code visible} property.
*
* @return desired {@code visible} property value
* @see com.vaadin.flow.component.Component#setVisible(boolean)
*/
boolean visible() default true;
/**
* Get the value desired for the {@code width} property.
*
* @return desired {@code width} property value
* @see com.vaadin.flow.component.HasSize#setWidth(String)
*/
String width() default "";
}
/**
* Specifies how a Java bean property should be edited using a {@link com.vaadin.flow.component.combobox.ComboBox}.
*
* @see FieldBuilder
* @see com.vaadin.flow.component.combobox.ComboBox
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface ComboBox {
/**
* Get the sub-type of {@link com.vaadin.flow.component.combobox.ComboBox} that will edit the property.
*
*
* This property allows custom widget subclasses to be used.
*
*
* The specified type must have a public constructor that takes either no arguments,
* or one {@code FieldBuilderContext}.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.combobox.ComboBox> implementation() default com.vaadin.flow.component.combobox.ComboBox.class;
/**
* Specify CSS properties to be set via {@link com.vaadin.flow.dom.Style#set Style.set()}.
*
*
* The array value consists of name, value pairs. If the array has odd length, the last element is ignored.
*
* @return zero or more style property name, value pairs
* @see com.vaadin.flow.dom.Style
* @see com.vaadin.flow.component.HasStyle
*/
String[] styleProperties() default {};
/**
* Get the value desired for the {@code allowCustomValue} property.
*
* @return desired {@code allowCustomValue} property value
* @see com.vaadin.flow.component.combobox.ComboBoxBase#setAllowCustomValue(boolean)
*/
boolean allowCustomValue() default false;
/**
* Get the value desired for the {@code allowedCharPattern} property.
*
* @return desired {@code allowedCharPattern} property value
* @see com.vaadin.flow.component.shared.HasAllowedCharPattern#setAllowedCharPattern(String)
*/
String allowedCharPattern() default "";
/**
* Get the value desired for the {@code ariaLabel} property.
*
* @return desired {@code ariaLabel} property value
* @see com.vaadin.flow.component.combobox.ComboBoxBase#setAriaLabel(String)
*/
String ariaLabel() default "";
/**
* Get the value desired for the {@code ariaLabelledBy} property.
*
* @return desired {@code ariaLabelledBy} property value
* @see com.vaadin.flow.component.combobox.ComboBoxBase#setAriaLabelledBy(String)
*/
String ariaLabelledBy() default "";
/**
* Get the value desired for the {@code autoOpen} property.
*
* @return desired {@code autoOpen} property value
* @see com.vaadin.flow.component.shared.HasAutoOpen#setAutoOpen(boolean)
*/
boolean autoOpen() default true;
/**
* Get the value desired for the {@code autofocus} property.
*
* @return desired {@code autofocus} property value
* @see com.vaadin.flow.component.combobox.ComboBoxBase#setAutofocus(boolean)
*/
boolean autofocus() default false;
/**
* Add the specified class names.
*
* @return zero or more class names to add
* @see com.vaadin.flow.component.HasStyle#addClassNames(String[])
*/
String[] addClassNames() default {};
/**
* Get the value desired for the {@code clearButtonVisible} property.
*
* @return desired {@code clearButtonVisible} property value
* @see com.vaadin.flow.component.shared.HasClearButton#setClearButtonVisible(boolean)
*/
boolean clearButtonVisible() default false;
/**
* Get the value desired for the {@code enabled} property.
*
* @return desired {@code enabled} property value
* @see com.vaadin.flow.component.HasEnabled#setEnabled(boolean)
*/
boolean enabled() default true;
/**
* Get the value desired for the {@code errorMessage} property.
*
* @return desired {@code errorMessage} property value
* @see com.vaadin.flow.component.shared.HasValidationProperties#setErrorMessage(String)
*/
String errorMessage() default "";
/**
* Get the value desired for the {@code height} property.
*
* @return desired {@code height} property value
* @see com.vaadin.flow.component.HasSize#setHeight(String)
*/
String height() default "";
/**
* Get the class to instantiate for the {@code helperComponent} property.
*
* @return desired {@code helperComponent} property value type
* @see com.vaadin.flow.component.HasHelper#setHelperComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> helperComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code helperText} property.
*
* @return desired {@code helperText} property value
* @see com.vaadin.flow.component.HasHelper#setHelperText(String)
*/
String helperText() default "";
/**
* Get the value desired for the {@code id} property.
*
* @return desired {@code id} property value
* @see com.vaadin.flow.component.Component#setId(String)
*/
String id() default "";
/**
* Get the class to instantiate for the {@code itemLabelGenerator} property.
*
* @return desired {@code itemLabelGenerator} property value type
* @see com.vaadin.flow.component.combobox.ComboBoxBase#setItemLabelGenerator(com.vaadin.flow.component.ItemLabelGenerator)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.ItemLabelGenerator> itemLabelGenerator() default com.vaadin.flow.component.ItemLabelGenerator.class;
/**
* Get the class to instantiate for the {@code items} property.
*
* @return desired {@code items} property value type
* @see com.vaadin.flow.component.combobox.ComboBoxBase#setItems(com.vaadin.flow.data.provider.DataProvider)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.data.provider.DataProvider> items() default com.vaadin.flow.data.provider.DataProvider.class;
/**
* Get the value desired for the {@code label} property.
*
* @return desired {@code label} property value
* @see com.vaadin.flow.component.HasLabel#setLabel(String)
*/
String label() default "";
/**
* Get the value desired for the {@code manualValidation} property.
*
* @return desired {@code manualValidation} property value
* @see com.vaadin.flow.component.combobox.ComboBoxBase#setManualValidation(boolean)
*/
boolean manualValidation() default false;
/**
* Get the value desired for the {@code maxHeight} property.
*
* @return desired {@code maxHeight} property value
* @see com.vaadin.flow.component.HasSize#setMaxHeight(String)
*/
String maxHeight() default "";
/**
* Get the value desired for the {@code maxWidth} property.
*
* @return desired {@code maxWidth} property value
* @see com.vaadin.flow.component.HasSize#setMaxWidth(String)
*/
String maxWidth() default "";
/**
* Get the value desired for the {@code minHeight} property.
*
* @return desired {@code minHeight} property value
* @see com.vaadin.flow.component.HasSize#setMinHeight(String)
*/
String minHeight() default "";
/**
* Get the value desired for the {@code minWidth} property.
*
* @return desired {@code minWidth} property value
* @see com.vaadin.flow.component.HasSize#setMinWidth(String)
*/
String minWidth() default "";
/**
* Get the value desired for the {@code opened} property.
*
* @return desired {@code opened} property value
* @see com.vaadin.flow.component.combobox.ComboBoxBase#setOpened(boolean)
*/
boolean opened() default false;
/**
* Get the value desired for the {@code overlayClassName} property.
*
* @return desired {@code overlayClassName} property value
* @see com.vaadin.flow.component.shared.HasOverlayClassName#setOverlayClassName(String)
*/
String overlayClassName() default "";
/**
* Get the value desired for the {@code overlayWidth} property.
*
* @return desired {@code overlayWidth} property value
* @see com.vaadin.flow.component.combobox.ComboBox#setOverlayWidth(String)
*/
String overlayWidth() default "";
/**
* Get the value desired for the {@code pageSize} property.
*
* @return desired {@code pageSize} property value
* @see com.vaadin.flow.component.combobox.ComboBoxBase#setPageSize(int)
*/
int pageSize() default 50;
/**
* Get the value desired for the {@code pattern} property.
*
* @return desired {@code pattern} property value
* @see com.vaadin.flow.component.combobox.ComboBox#setPattern(String)
*/
String pattern() default "";
/**
* Get the value desired for the {@code placeholder} property.
*
* @return desired {@code placeholder} property value
* @see com.vaadin.flow.component.HasPlaceholder#setPlaceholder(String)
*/
String placeholder() default "";
/**
* Get the class to instantiate for the {@code prefixComponent} property.
*
* @return desired {@code prefixComponent} property value type
* @see com.vaadin.flow.component.shared.HasPrefix#setPrefixComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> prefixComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code readOnly} property.
*
* @return desired {@code readOnly} property value
* @see com.vaadin.flow.component.HasValueAndElement#setReadOnly(boolean)
*/
boolean readOnly() default false;
/**
* Get the class to instantiate for the {@code renderer} property.
*
* @return desired {@code renderer} property value type
* @see com.vaadin.flow.component.combobox.ComboBoxBase#setRenderer(com.vaadin.flow.data.renderer.Renderer)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.data.renderer.Renderer> renderer() default com.vaadin.flow.data.renderer.Renderer.class;
/**
* Get the value desired for the {@code required} property.
*
* @return desired {@code required} property value
* @see com.vaadin.flow.component.combobox.ComboBoxBase#setRequired(boolean)
*/
boolean required() default false;
/**
* Get the value desired for the {@code requiredIndicatorVisible} property.
*
* @return desired {@code requiredIndicatorVisible} property value
* @see com.vaadin.flow.component.HasValueAndElement#setRequiredIndicatorVisible(boolean)
*/
boolean requiredIndicatorVisible() default false;
/**
* Get the value desired for the {@code tabIndex} property.
*
* @return desired {@code tabIndex} property value
* @see com.vaadin.flow.component.Focusable#setTabIndex(int)
*/
int tabIndex() default 0;
/**
* Add the specified theme names.
*
* @return zero or more theme names to add
* @see com.vaadin.flow.component.HasTheme#addThemeNames(String[])
*/
String[] addThemeNames() default {};
/**
* Add the specified theme variants.
*
* @return zero or more theme variants to add
* @see com.vaadin.flow.component.shared.HasThemeVariant#addThemeVariants(com.vaadin.flow.component.shared.ThemeVariant[])
*/
com.vaadin.flow.component.combobox.ComboBoxVariant[] addThemeVariants() default {};
/**
* Get the value desired for the {@code tooltipText} property.
*
* @return desired {@code tooltipText} property value
* @see com.vaadin.flow.component.shared.HasTooltip#setTooltipText(String)
*/
String tooltipText() default "";
/**
* Get the value desired for the {@code visible} property.
*
* @return desired {@code visible} property value
* @see com.vaadin.flow.component.Component#setVisible(boolean)
*/
boolean visible() default true;
/**
* Get the value desired for the {@code width} property.
*
* @return desired {@code width} property value
* @see com.vaadin.flow.component.HasSize#setWidth(String)
*/
String width() default "";
}
/**
* Specifies how a Java bean property should be edited using a {@link com.vaadin.flow.component.combobox.MultiSelectComboBox}.
*
* @see FieldBuilder
* @see com.vaadin.flow.component.combobox.MultiSelectComboBox
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface MultiSelectComboBox {
/**
* Get the sub-type of {@link com.vaadin.flow.component.combobox.MultiSelectComboBox} that will edit the property.
*
*
* This property allows custom widget subclasses to be used.
*
*
* The specified type must have a public constructor that takes either no arguments,
* or one {@code FieldBuilderContext}.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.combobox.MultiSelectComboBox> implementation() default com.vaadin.flow.component.combobox.MultiSelectComboBox.class;
/**
* Specify CSS properties to be set via {@link com.vaadin.flow.dom.Style#set Style.set()}.
*
*
* The array value consists of name, value pairs. If the array has odd length, the last element is ignored.
*
* @return zero or more style property name, value pairs
* @see com.vaadin.flow.dom.Style
* @see com.vaadin.flow.component.HasStyle
*/
String[] styleProperties() default {};
/**
* Get the value desired for the {@code allowCustomValue} property.
*
* @return desired {@code allowCustomValue} property value
* @see com.vaadin.flow.component.combobox.ComboBoxBase#setAllowCustomValue(boolean)
*/
boolean allowCustomValue() default false;
/**
* Get the value desired for the {@code allowedCharPattern} property.
*
* @return desired {@code allowedCharPattern} property value
* @see com.vaadin.flow.component.shared.HasAllowedCharPattern#setAllowedCharPattern(String)
*/
String allowedCharPattern() default "";
/**
* Get the value desired for the {@code ariaLabel} property.
*
* @return desired {@code ariaLabel} property value
* @see com.vaadin.flow.component.combobox.ComboBoxBase#setAriaLabel(String)
*/
String ariaLabel() default "";
/**
* Get the value desired for the {@code ariaLabelledBy} property.
*
* @return desired {@code ariaLabelledBy} property value
* @see com.vaadin.flow.component.combobox.ComboBoxBase#setAriaLabelledBy(String)
*/
String ariaLabelledBy() default "";
/**
* Get the value desired for the {@code autoExpand} property.
*
* @return desired {@code autoExpand} property value
* @see com.vaadin.flow.component.combobox.MultiSelectComboBox#setAutoExpand(com.vaadin.flow.component.combobox.MultiSelectComboBox.AutoExpandMode)
*/
com.vaadin.flow.component.combobox.MultiSelectComboBox.AutoExpandMode autoExpand() default com.vaadin.flow.component.combobox.MultiSelectComboBox.AutoExpandMode.NONE;
/**
* Get the value desired for the {@code autoOpen} property.
*
* @return desired {@code autoOpen} property value
* @see com.vaadin.flow.component.shared.HasAutoOpen#setAutoOpen(boolean)
*/
boolean autoOpen() default true;
/**
* Get the value desired for the {@code autofocus} property.
*
* @return desired {@code autofocus} property value
* @see com.vaadin.flow.component.combobox.ComboBoxBase#setAutofocus(boolean)
*/
boolean autofocus() default false;
/**
* Add the specified class names.
*
* @return zero or more class names to add
* @see com.vaadin.flow.component.HasStyle#addClassNames(String[])
*/
String[] addClassNames() default {};
/**
* Get the value desired for the {@code clearButtonVisible} property.
*
* @return desired {@code clearButtonVisible} property value
* @see com.vaadin.flow.component.shared.HasClearButton#setClearButtonVisible(boolean)
*/
boolean clearButtonVisible() default false;
/**
* Get the value desired for the {@code enabled} property.
*
* @return desired {@code enabled} property value
* @see com.vaadin.flow.component.HasEnabled#setEnabled(boolean)
*/
boolean enabled() default true;
/**
* Get the value desired for the {@code errorMessage} property.
*
* @return desired {@code errorMessage} property value
* @see com.vaadin.flow.component.shared.HasValidationProperties#setErrorMessage(String)
*/
String errorMessage() default "";
/**
* Get the value desired for the {@code height} property.
*
* @return desired {@code height} property value
* @see com.vaadin.flow.component.HasSize#setHeight(String)
*/
String height() default "";
/**
* Get the class to instantiate for the {@code helperComponent} property.
*
* @return desired {@code helperComponent} property value type
* @see com.vaadin.flow.component.HasHelper#setHelperComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> helperComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code helperText} property.
*
* @return desired {@code helperText} property value
* @see com.vaadin.flow.component.HasHelper#setHelperText(String)
*/
String helperText() default "";
/**
* Get the class to instantiate for the {@code i18n} property.
*
* @return desired {@code i18n} property value type
* @see com.vaadin.flow.component.combobox.MultiSelectComboBox#setI18n(com.vaadin.flow.component.combobox.MultiSelectComboBoxI18n)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.combobox.MultiSelectComboBoxI18n> i18n() default com.vaadin.flow.component.combobox.MultiSelectComboBoxI18n.class;
/**
* Get the value desired for the {@code id} property.
*
* @return desired {@code id} property value
* @see com.vaadin.flow.component.Component#setId(String)
*/
String id() default "";
/**
* Get the class to instantiate for the {@code itemLabelGenerator} property.
*
* @return desired {@code itemLabelGenerator} property value type
* @see com.vaadin.flow.component.combobox.ComboBoxBase#setItemLabelGenerator(com.vaadin.flow.component.ItemLabelGenerator)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.ItemLabelGenerator> itemLabelGenerator() default com.vaadin.flow.component.ItemLabelGenerator.class;
/**
* Get the class to instantiate for the {@code items} property.
*
* @return desired {@code items} property value type
* @see com.vaadin.flow.component.combobox.ComboBoxBase#setItems(com.vaadin.flow.data.provider.DataProvider)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.data.provider.DataProvider> items() default com.vaadin.flow.data.provider.DataProvider.class;
/**
* Get the value desired for the {@code keepFilter} property.
*
* @return desired {@code keepFilter} property value
* @see com.vaadin.flow.component.combobox.MultiSelectComboBox#setKeepFilter(boolean)
*/
boolean keepFilter() default false;
/**
* Get the value desired for the {@code label} property.
*
* @return desired {@code label} property value
* @see com.vaadin.flow.component.HasLabel#setLabel(String)
*/
String label() default "";
/**
* Get the value desired for the {@code manualValidation} property.
*
* @return desired {@code manualValidation} property value
* @see com.vaadin.flow.component.combobox.ComboBoxBase#setManualValidation(boolean)
*/
boolean manualValidation() default false;
/**
* Get the value desired for the {@code maxHeight} property.
*
* @return desired {@code maxHeight} property value
* @see com.vaadin.flow.component.HasSize#setMaxHeight(String)
*/
String maxHeight() default "";
/**
* Get the value desired for the {@code maxWidth} property.
*
* @return desired {@code maxWidth} property value
* @see com.vaadin.flow.component.HasSize#setMaxWidth(String)
*/
String maxWidth() default "";
/**
* Get the value desired for the {@code minHeight} property.
*
* @return desired {@code minHeight} property value
* @see com.vaadin.flow.component.HasSize#setMinHeight(String)
*/
String minHeight() default "";
/**
* Get the value desired for the {@code minWidth} property.
*
* @return desired {@code minWidth} property value
* @see com.vaadin.flow.component.HasSize#setMinWidth(String)
*/
String minWidth() default "";
/**
* Get the value desired for the {@code opened} property.
*
* @return desired {@code opened} property value
* @see com.vaadin.flow.component.combobox.ComboBoxBase#setOpened(boolean)
*/
boolean opened() default false;
/**
* Get the value desired for the {@code overlayClassName} property.
*
* @return desired {@code overlayClassName} property value
* @see com.vaadin.flow.component.shared.HasOverlayClassName#setOverlayClassName(String)
*/
String overlayClassName() default "";
/**
* Get the value desired for the {@code overlayWidth} property.
*
* @return desired {@code overlayWidth} property value
* @see com.vaadin.flow.component.combobox.MultiSelectComboBox#setOverlayWidth(String)
*/
String overlayWidth() default "";
/**
* Get the value desired for the {@code pageSize} property.
*
* @return desired {@code pageSize} property value
* @see com.vaadin.flow.component.combobox.ComboBoxBase#setPageSize(int)
*/
int pageSize() default 50;
/**
* Get the value desired for the {@code placeholder} property.
*
* @return desired {@code placeholder} property value
* @see com.vaadin.flow.component.HasPlaceholder#setPlaceholder(String)
*/
String placeholder() default "";
/**
* Get the value desired for the {@code readOnly} property.
*
* @return desired {@code readOnly} property value
* @see com.vaadin.flow.component.HasValueAndElement#setReadOnly(boolean)
*/
boolean readOnly() default false;
/**
* Get the class to instantiate for the {@code renderer} property.
*
* @return desired {@code renderer} property value type
* @see com.vaadin.flow.component.combobox.ComboBoxBase#setRenderer(com.vaadin.flow.data.renderer.Renderer)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.data.renderer.Renderer> renderer() default com.vaadin.flow.data.renderer.Renderer.class;
/**
* Get the value desired for the {@code required} property.
*
* @return desired {@code required} property value
* @see com.vaadin.flow.component.combobox.ComboBoxBase#setRequired(boolean)
*/
boolean required() default false;
/**
* Get the value desired for the {@code requiredIndicatorVisible} property.
*
* @return desired {@code requiredIndicatorVisible} property value
* @see com.vaadin.flow.component.HasValueAndElement#setRequiredIndicatorVisible(boolean)
*/
boolean requiredIndicatorVisible() default false;
/**
* Get the value desired for the {@code selectedItemsOnTop} property.
*
* @return desired {@code selectedItemsOnTop} property value
* @see com.vaadin.flow.component.combobox.MultiSelectComboBox#setSelectedItemsOnTop(boolean)
*/
boolean selectedItemsOnTop() default false;
/**
* Get the value desired for the {@code tabIndex} property.
*
* @return desired {@code tabIndex} property value
* @see com.vaadin.flow.component.Focusable#setTabIndex(int)
*/
int tabIndex() default 0;
/**
* Add the specified theme names.
*
* @return zero or more theme names to add
* @see com.vaadin.flow.component.HasTheme#addThemeNames(String[])
*/
String[] addThemeNames() default {};
/**
* Add the specified theme variants.
*
* @return zero or more theme variants to add
* @see com.vaadin.flow.component.shared.HasThemeVariant#addThemeVariants(com.vaadin.flow.component.shared.ThemeVariant[])
*/
com.vaadin.flow.component.combobox.MultiSelectComboBoxVariant[] addThemeVariants() default {};
/**
* Get the value desired for the {@code tooltipText} property.
*
* @return desired {@code tooltipText} property value
* @see com.vaadin.flow.component.shared.HasTooltip#setTooltipText(String)
*/
String tooltipText() default "";
/**
* Get the value desired for the {@code visible} property.
*
* @return desired {@code visible} property value
* @see com.vaadin.flow.component.Component#setVisible(boolean)
*/
boolean visible() default true;
/**
* Get the value desired for the {@code width} property.
*
* @return desired {@code width} property value
* @see com.vaadin.flow.component.HasSize#setWidth(String)
*/
String width() default "";
}
/**
* Specifies how a Java bean property should be edited using a {@link com.vaadin.flow.component.customfield.CustomField}.
*
* @see FieldBuilder
* @see com.vaadin.flow.component.customfield.CustomField
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface CustomField {
/**
* Get the sub-type of {@link com.vaadin.flow.component.customfield.CustomField} that will edit the property.
*
*
* This property is required because {@link com.vaadin.flow.component.customfield.CustomField} is an abstract class.
*
*
* The specified type must have a public constructor that takes either no arguments,
* or one {@code FieldBuilderContext}.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.customfield.CustomField> implementation();
/**
* Specify CSS properties to be set via {@link com.vaadin.flow.dom.Style#set Style.set()}.
*
*
* The array value consists of name, value pairs. If the array has odd length, the last element is ignored.
*
* @return zero or more style property name, value pairs
* @see com.vaadin.flow.dom.Style
* @see com.vaadin.flow.component.HasStyle
*/
String[] styleProperties() default {};
/**
* Add the specified class names.
*
* @return zero or more class names to add
* @see com.vaadin.flow.component.HasStyle#addClassNames(String[])
*/
String[] addClassNames() default {};
/**
* Get the value desired for the {@code enabled} property.
*
* @return desired {@code enabled} property value
* @see com.vaadin.flow.component.HasEnabled#setEnabled(boolean)
*/
boolean enabled() default true;
/**
* Get the value desired for the {@code errorMessage} property.
*
* @return desired {@code errorMessage} property value
* @see com.vaadin.flow.component.shared.HasValidationProperties#setErrorMessage(String)
*/
String errorMessage() default "";
/**
* Get the value desired for the {@code height} property.
*
* @return desired {@code height} property value
* @see com.vaadin.flow.component.HasSize#setHeight(String)
*/
String height() default "";
/**
* Get the class to instantiate for the {@code helperComponent} property.
*
* @return desired {@code helperComponent} property value type
* @see com.vaadin.flow.component.HasHelper#setHelperComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> helperComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code helperText} property.
*
* @return desired {@code helperText} property value
* @see com.vaadin.flow.component.HasHelper#setHelperText(String)
*/
String helperText() default "";
/**
* Get the value desired for the {@code id} property.
*
* @return desired {@code id} property value
* @see com.vaadin.flow.component.Component#setId(String)
*/
String id() default "";
/**
* Get the value desired for the {@code label} property.
*
* @return desired {@code label} property value
* @see com.vaadin.flow.component.customfield.CustomField#setLabel(String)
*/
String label() default "";
/**
* Get the value desired for the {@code manualValidation} property.
*
* @return desired {@code manualValidation} property value
* @see com.vaadin.flow.component.HasValidation#setManualValidation(boolean)
*/
boolean manualValidation() default false;
/**
* Get the value desired for the {@code maxHeight} property.
*
* @return desired {@code maxHeight} property value
* @see com.vaadin.flow.component.HasSize#setMaxHeight(String)
*/
String maxHeight() default "";
/**
* Get the value desired for the {@code maxWidth} property.
*
* @return desired {@code maxWidth} property value
* @see com.vaadin.flow.component.HasSize#setMaxWidth(String)
*/
String maxWidth() default "";
/**
* Get the value desired for the {@code minHeight} property.
*
* @return desired {@code minHeight} property value
* @see com.vaadin.flow.component.HasSize#setMinHeight(String)
*/
String minHeight() default "";
/**
* Get the value desired for the {@code minWidth} property.
*
* @return desired {@code minWidth} property value
* @see com.vaadin.flow.component.HasSize#setMinWidth(String)
*/
String minWidth() default "";
/**
* Get the value desired for the {@code readOnly} property.
*
* @return desired {@code readOnly} property value
* @see com.vaadin.flow.component.HasValueAndElement#setReadOnly(boolean)
*/
boolean readOnly() default false;
/**
* Get the value desired for the {@code requiredIndicatorVisible} property.
*
* @return desired {@code requiredIndicatorVisible} property value
* @see com.vaadin.flow.component.HasValueAndElement#setRequiredIndicatorVisible(boolean)
*/
boolean requiredIndicatorVisible() default false;
/**
* Get the value desired for the {@code tabIndex} property.
*
* @return desired {@code tabIndex} property value
* @see com.vaadin.flow.component.Focusable#setTabIndex(int)
*/
int tabIndex() default 0;
/**
* Add the specified theme names.
*
* @return zero or more theme names to add
* @see com.vaadin.flow.component.HasTheme#addThemeNames(String[])
*/
String[] addThemeNames() default {};
/**
* Add the specified theme variants.
*
* @return zero or more theme variants to add
* @see com.vaadin.flow.component.customfield.CustomField#addThemeVariants(com.vaadin.flow.component.customfield.CustomFieldVariant[])
*/
com.vaadin.flow.component.customfield.CustomFieldVariant[] addThemeVariants() default {};
/**
* Get the value desired for the {@code tooltipText} property.
*
* @return desired {@code tooltipText} property value
* @see com.vaadin.flow.component.shared.HasTooltip#setTooltipText(String)
*/
String tooltipText() default "";
/**
* Get the value desired for the {@code visible} property.
*
* @return desired {@code visible} property value
* @see com.vaadin.flow.component.Component#setVisible(boolean)
*/
boolean visible() default true;
/**
* Get the value desired for the {@code width} property.
*
* @return desired {@code width} property value
* @see com.vaadin.flow.component.HasSize#setWidth(String)
*/
String width() default "";
}
/**
* Specifies how a Java bean property should be edited using a {@link com.vaadin.flow.component.datepicker.DatePicker}.
*
* @see FieldBuilder
* @see com.vaadin.flow.component.datepicker.DatePicker
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface DatePicker {
/**
* Get the sub-type of {@link com.vaadin.flow.component.datepicker.DatePicker} that will edit the property.
*
*
* This property allows custom widget subclasses to be used.
*
*
* The specified type must have a public constructor that takes either no arguments,
* or one {@code FieldBuilderContext}.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.datepicker.DatePicker> implementation() default com.vaadin.flow.component.datepicker.DatePicker.class;
/**
* Specify CSS properties to be set via {@link com.vaadin.flow.dom.Style#set Style.set()}.
*
*
* The array value consists of name, value pairs. If the array has odd length, the last element is ignored.
*
* @return zero or more style property name, value pairs
* @see com.vaadin.flow.dom.Style
* @see com.vaadin.flow.component.HasStyle
*/
String[] styleProperties() default {};
/**
* Get the value desired for the {@code allowedCharPattern} property.
*
* @return desired {@code allowedCharPattern} property value
* @see com.vaadin.flow.component.shared.HasAllowedCharPattern#setAllowedCharPattern(String)
*/
String allowedCharPattern() default "";
/**
* Get the value desired for the {@code ariaLabel} property.
*
* @return desired {@code ariaLabel} property value
* @see com.vaadin.flow.component.datepicker.DatePicker#setAriaLabel(String)
*/
String ariaLabel() default "";
/**
* Get the value desired for the {@code ariaLabelledBy} property.
*
* @return desired {@code ariaLabelledBy} property value
* @see com.vaadin.flow.component.datepicker.DatePicker#setAriaLabelledBy(String)
*/
String ariaLabelledBy() default "";
/**
* Get the value desired for the {@code autoOpen} property.
*
* @return desired {@code autoOpen} property value
* @see com.vaadin.flow.component.shared.HasAutoOpen#setAutoOpen(boolean)
*/
boolean autoOpen() default true;
/**
* Add the specified class names.
*
* @return zero or more class names to add
* @see com.vaadin.flow.component.HasStyle#addClassNames(String[])
*/
String[] addClassNames() default {};
/**
* Get the value desired for the {@code clearButtonVisible} property.
*
* @return desired {@code clearButtonVisible} property value
* @see com.vaadin.flow.component.shared.HasClearButton#setClearButtonVisible(boolean)
*/
boolean clearButtonVisible() default false;
/**
* Get the value desired for the {@code enabled} property.
*
* @return desired {@code enabled} property value
* @see com.vaadin.flow.component.HasEnabled#setEnabled(boolean)
*/
boolean enabled() default true;
/**
* Get the value desired for the {@code errorMessage} property.
*
* @return desired {@code errorMessage} property value
* @see com.vaadin.flow.component.shared.HasValidationProperties#setErrorMessage(String)
*/
String errorMessage() default "";
/**
* Get the value desired for the {@code height} property.
*
* @return desired {@code height} property value
* @see com.vaadin.flow.component.HasSize#setHeight(String)
*/
String height() default "";
/**
* Get the class to instantiate for the {@code helperComponent} property.
*
* @return desired {@code helperComponent} property value type
* @see com.vaadin.flow.component.HasHelper#setHelperComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> helperComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code helperText} property.
*
* @return desired {@code helperText} property value
* @see com.vaadin.flow.component.HasHelper#setHelperText(String)
*/
String helperText() default "";
/**
* Get the class to instantiate for the {@code i18n} property.
*
* @return desired {@code i18n} property value type
* @see com.vaadin.flow.component.datepicker.DatePicker#setI18n(com.vaadin.flow.component.datepicker.DatePicker.DatePickerI18n)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.datepicker.DatePicker.DatePickerI18n> i18n() default com.vaadin.flow.component.datepicker.DatePicker.DatePickerI18n.class;
/**
* Get the value desired for the {@code id} property.
*
* @return desired {@code id} property value
* @see com.vaadin.flow.component.Component#setId(String)
*/
String id() default "";
/**
* Get the class to instantiate for the {@code initialPosition} property.
*
* @return desired {@code initialPosition} property value type
* @see com.vaadin.flow.component.datepicker.DatePicker#setInitialPosition(java.time.LocalDate)
*/
@SuppressWarnings("rawtypes")
Class extends java.time.LocalDate> initialPosition() default java.time.LocalDate.class;
/**
* Get the value desired for the {@code label} property.
*
* @return desired {@code label} property value
* @see com.vaadin.flow.component.datepicker.DatePicker#setLabel(String)
*/
String label() default "";
/**
* Get the class to instantiate for the {@code locale} property.
*
* @return desired {@code locale} property value type
* @see com.vaadin.flow.component.datepicker.DatePicker#setLocale(java.util.Locale)
*/
@SuppressWarnings("rawtypes")
Class extends java.util.Locale> locale() default java.util.Locale.class;
/**
* Get the value desired for the {@code manualValidation} property.
*
* @return desired {@code manualValidation} property value
* @see com.vaadin.flow.component.datepicker.DatePicker#setManualValidation(boolean)
*/
boolean manualValidation() default false;
/**
* Get the class to instantiate for the {@code max} property.
*
* @return desired {@code max} property value type
* @see com.vaadin.flow.component.datepicker.DatePicker#setMax(java.time.LocalDate)
*/
@SuppressWarnings("rawtypes")
Class extends java.time.LocalDate> max() default java.time.LocalDate.class;
/**
* Get the value desired for the {@code maxHeight} property.
*
* @return desired {@code maxHeight} property value
* @see com.vaadin.flow.component.HasSize#setMaxHeight(String)
*/
String maxHeight() default "";
/**
* Get the value desired for the {@code maxWidth} property.
*
* @return desired {@code maxWidth} property value
* @see com.vaadin.flow.component.HasSize#setMaxWidth(String)
*/
String maxWidth() default "";
/**
* Get the class to instantiate for the {@code min} property.
*
* @return desired {@code min} property value type
* @see com.vaadin.flow.component.datepicker.DatePicker#setMin(java.time.LocalDate)
*/
@SuppressWarnings("rawtypes")
Class extends java.time.LocalDate> min() default java.time.LocalDate.class;
/**
* Get the value desired for the {@code minHeight} property.
*
* @return desired {@code minHeight} property value
* @see com.vaadin.flow.component.HasSize#setMinHeight(String)
*/
String minHeight() default "";
/**
* Get the value desired for the {@code minWidth} property.
*
* @return desired {@code minWidth} property value
* @see com.vaadin.flow.component.HasSize#setMinWidth(String)
*/
String minWidth() default "";
/**
* Get the value desired for the {@code name} property.
*
* @return desired {@code name} property value
* @see com.vaadin.flow.component.datepicker.DatePicker#setName(String)
*/
String name() default "";
/**
* Get the value desired for the {@code opened} property.
*
* @return desired {@code opened} property value
* @see com.vaadin.flow.component.datepicker.DatePicker#setOpened(boolean)
*/
boolean opened() default false;
/**
* Get the value desired for the {@code overlayClassName} property.
*
* @return desired {@code overlayClassName} property value
* @see com.vaadin.flow.component.shared.HasOverlayClassName#setOverlayClassName(String)
*/
String overlayClassName() default "";
/**
* Get the value desired for the {@code placeholder} property.
*
* @return desired {@code placeholder} property value
* @see com.vaadin.flow.component.HasPlaceholder#setPlaceholder(String)
*/
String placeholder() default "";
/**
* Get the class to instantiate for the {@code prefixComponent} property.
*
* @return desired {@code prefixComponent} property value type
* @see com.vaadin.flow.component.shared.HasPrefix#setPrefixComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> prefixComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code readOnly} property.
*
* @return desired {@code readOnly} property value
* @see com.vaadin.flow.component.HasValueAndElement#setReadOnly(boolean)
*/
boolean readOnly() default false;
/**
* Get the value desired for the {@code required} property.
*
* @return desired {@code required} property value
* @see com.vaadin.flow.component.datepicker.DatePicker#setRequired(boolean)
*/
boolean required() default false;
/**
* Get the value desired for the {@code requiredIndicatorVisible} property.
*
* @return desired {@code requiredIndicatorVisible} property value
* @see com.vaadin.flow.component.datepicker.DatePicker#setRequiredIndicatorVisible(boolean)
*/
boolean requiredIndicatorVisible() default false;
/**
* Get the value desired for the {@code tabIndex} property.
*
* @return desired {@code tabIndex} property value
* @see com.vaadin.flow.component.Focusable#setTabIndex(int)
*/
int tabIndex() default 0;
/**
* Add the specified theme names.
*
* @return zero or more theme names to add
* @see com.vaadin.flow.component.HasTheme#addThemeNames(String[])
*/
String[] addThemeNames() default {};
/**
* Add the specified theme variants.
*
* @return zero or more theme variants to add
* @see com.vaadin.flow.component.shared.HasThemeVariant#addThemeVariants(com.vaadin.flow.component.shared.ThemeVariant[])
*/
com.vaadin.flow.component.datepicker.DatePickerVariant[] addThemeVariants() default {};
/**
* Get the value desired for the {@code tooltipText} property.
*
* @return desired {@code tooltipText} property value
* @see com.vaadin.flow.component.shared.HasTooltip#setTooltipText(String)
*/
String tooltipText() default "";
/**
* Get the value desired for the {@code visible} property.
*
* @return desired {@code visible} property value
* @see com.vaadin.flow.component.Component#setVisible(boolean)
*/
boolean visible() default true;
/**
* Get the value desired for the {@code weekNumbersVisible} property.
*
* @return desired {@code weekNumbersVisible} property value
* @see com.vaadin.flow.component.datepicker.DatePicker#setWeekNumbersVisible(boolean)
*/
boolean weekNumbersVisible() default false;
/**
* Get the value desired for the {@code width} property.
*
* @return desired {@code width} property value
* @see com.vaadin.flow.component.HasSize#setWidth(String)
*/
String width() default "";
}
/**
* Specifies how a Java bean property should be edited using a {@link com.vaadin.flow.component.datetimepicker.DateTimePicker}.
*
* @see FieldBuilder
* @see com.vaadin.flow.component.datetimepicker.DateTimePicker
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface DateTimePicker {
/**
* Get the sub-type of {@link com.vaadin.flow.component.datetimepicker.DateTimePicker} that will edit the property.
*
*
* This property allows custom widget subclasses to be used.
*
*
* The specified type must have a public constructor that takes either no arguments,
* or one {@code FieldBuilderContext}.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.datetimepicker.DateTimePicker> implementation() default com.vaadin.flow.component.datetimepicker.DateTimePicker.class;
/**
* Specify CSS properties to be set via {@link com.vaadin.flow.dom.Style#set Style.set()}.
*
*
* The array value consists of name, value pairs. If the array has odd length, the last element is ignored.
*
* @return zero or more style property name, value pairs
* @see com.vaadin.flow.dom.Style
* @see com.vaadin.flow.component.HasStyle
*/
String[] styleProperties() default {};
/**
* Get the value desired for the {@code ariaLabel} property.
*
* @return desired {@code ariaLabel} property value
* @see com.vaadin.flow.component.datetimepicker.DateTimePicker#setAriaLabel(String)
*/
String ariaLabel() default "";
/**
* Get the value desired for the {@code autoOpen} property.
*
* @return desired {@code autoOpen} property value
* @see com.vaadin.flow.component.datetimepicker.DateTimePicker#setAutoOpen(boolean)
*/
boolean autoOpen() default true;
/**
* Add the specified class names.
*
* @return zero or more class names to add
* @see com.vaadin.flow.component.HasStyle#addClassNames(String[])
*/
String[] addClassNames() default {};
/**
* Get the value desired for the {@code dateAriaLabel} property.
*
* @return desired {@code dateAriaLabel} property value
* @see com.vaadin.flow.component.datetimepicker.DateTimePicker#setDateAriaLabel(String)
*/
String dateAriaLabel() default "";
/**
* Get the class to instantiate for the {@code datePickerI18n} property.
*
* @return desired {@code datePickerI18n} property value type
* @see com.vaadin.flow.component.datetimepicker.DateTimePicker#setDatePickerI18n(com.vaadin.flow.component.datepicker.DatePicker.DatePickerI18n)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.datepicker.DatePicker.DatePickerI18n> datePickerI18n() default com.vaadin.flow.component.datepicker.DatePicker.DatePickerI18n.class;
/**
* Get the value desired for the {@code datePlaceholder} property.
*
* @return desired {@code datePlaceholder} property value
* @see com.vaadin.flow.component.datetimepicker.DateTimePicker#setDatePlaceholder(String)
*/
String datePlaceholder() default "";
/**
* Get the value desired for the {@code enabled} property.
*
* @return desired {@code enabled} property value
* @see com.vaadin.flow.component.HasEnabled#setEnabled(boolean)
*/
boolean enabled() default true;
/**
* Get the value desired for the {@code errorMessage} property.
*
* @return desired {@code errorMessage} property value
* @see com.vaadin.flow.component.shared.HasValidationProperties#setErrorMessage(String)
*/
String errorMessage() default "";
/**
* Get the value desired for the {@code height} property.
*
* @return desired {@code height} property value
* @see com.vaadin.flow.component.HasSize#setHeight(String)
*/
String height() default "";
/**
* Get the class to instantiate for the {@code helperComponent} property.
*
* @return desired {@code helperComponent} property value type
* @see com.vaadin.flow.component.HasHelper#setHelperComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> helperComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code helperText} property.
*
* @return desired {@code helperText} property value
* @see com.vaadin.flow.component.HasHelper#setHelperText(String)
*/
String helperText() default "";
/**
* Get the value desired for the {@code id} property.
*
* @return desired {@code id} property value
* @see com.vaadin.flow.component.Component#setId(String)
*/
String id() default "";
/**
* Get the value desired for the {@code label} property.
*
* @return desired {@code label} property value
* @see com.vaadin.flow.component.datetimepicker.DateTimePicker#setLabel(String)
*/
String label() default "";
/**
* Get the class to instantiate for the {@code locale} property.
*
* @return desired {@code locale} property value type
* @see com.vaadin.flow.component.datetimepicker.DateTimePicker#setLocale(java.util.Locale)
*/
@SuppressWarnings("rawtypes")
Class extends java.util.Locale> locale() default java.util.Locale.class;
/**
* Get the value desired for the {@code manualValidation} property.
*
* @return desired {@code manualValidation} property value
* @see com.vaadin.flow.component.datetimepicker.DateTimePicker#setManualValidation(boolean)
*/
boolean manualValidation() default false;
/**
* Get the class to instantiate for the {@code max} property.
*
* @return desired {@code max} property value type
* @see com.vaadin.flow.component.datetimepicker.DateTimePicker#setMax(java.time.LocalDateTime)
*/
@SuppressWarnings("rawtypes")
Class extends java.time.LocalDateTime> max() default java.time.LocalDateTime.class;
/**
* Get the value desired for the {@code maxHeight} property.
*
* @return desired {@code maxHeight} property value
* @see com.vaadin.flow.component.HasSize#setMaxHeight(String)
*/
String maxHeight() default "";
/**
* Get the value desired for the {@code maxWidth} property.
*
* @return desired {@code maxWidth} property value
* @see com.vaadin.flow.component.HasSize#setMaxWidth(String)
*/
String maxWidth() default "";
/**
* Get the class to instantiate for the {@code min} property.
*
* @return desired {@code min} property value type
* @see com.vaadin.flow.component.datetimepicker.DateTimePicker#setMin(java.time.LocalDateTime)
*/
@SuppressWarnings("rawtypes")
Class extends java.time.LocalDateTime> min() default java.time.LocalDateTime.class;
/**
* Get the value desired for the {@code minHeight} property.
*
* @return desired {@code minHeight} property value
* @see com.vaadin.flow.component.HasSize#setMinHeight(String)
*/
String minHeight() default "";
/**
* Get the value desired for the {@code minWidth} property.
*
* @return desired {@code minWidth} property value
* @see com.vaadin.flow.component.HasSize#setMinWidth(String)
*/
String minWidth() default "";
/**
* Get the value desired for the {@code overlayClassName} property.
*
* @return desired {@code overlayClassName} property value
* @see com.vaadin.flow.component.shared.HasOverlayClassName#setOverlayClassName(String)
*/
String overlayClassName() default "";
/**
* Get the value desired for the {@code readOnly} property.
*
* @return desired {@code readOnly} property value
* @see com.vaadin.flow.component.datetimepicker.DateTimePicker#setReadOnly(boolean)
*/
boolean readOnly() default false;
/**
* Get the value desired for the {@code requiredIndicatorVisible} property.
*
* @return desired {@code requiredIndicatorVisible} property value
* @see com.vaadin.flow.component.datetimepicker.DateTimePicker#setRequiredIndicatorVisible(boolean)
*/
boolean requiredIndicatorVisible() default false;
/**
* Get the class to instantiate for the {@code step} property.
*
* @return desired {@code step} property value type
* @see com.vaadin.flow.component.datetimepicker.DateTimePicker#setStep(java.time.Duration)
*/
@SuppressWarnings("rawtypes")
Class extends java.time.Duration> step() default java.time.Duration.class;
/**
* Get the value desired for the {@code tabIndex} property.
*
* @return desired {@code tabIndex} property value
* @see com.vaadin.flow.component.Focusable#setTabIndex(int)
*/
int tabIndex() default 0;
/**
* Add the specified theme names.
*
* @return zero or more theme names to add
* @see com.vaadin.flow.component.datetimepicker.DateTimePicker#addThemeNames(String[])
*/
String[] addThemeNames() default {};
/**
* Add the specified theme variants.
*
* @return zero or more theme variants to add
* @see com.vaadin.flow.component.shared.HasThemeVariant#addThemeVariants(com.vaadin.flow.component.shared.ThemeVariant[])
*/
com.vaadin.flow.component.datetimepicker.DateTimePickerVariant[] addThemeVariants() default {};
/**
* Get the value desired for the {@code timeAriaLabel} property.
*
* @return desired {@code timeAriaLabel} property value
* @see com.vaadin.flow.component.datetimepicker.DateTimePicker#setTimeAriaLabel(String)
*/
String timeAriaLabel() default "";
/**
* Get the value desired for the {@code timePlaceholder} property.
*
* @return desired {@code timePlaceholder} property value
* @see com.vaadin.flow.component.datetimepicker.DateTimePicker#setTimePlaceholder(String)
*/
String timePlaceholder() default "";
/**
* Get the value desired for the {@code tooltipText} property.
*
* @return desired {@code tooltipText} property value
* @see com.vaadin.flow.component.shared.HasTooltip#setTooltipText(String)
*/
String tooltipText() default "";
/**
* Get the value desired for the {@code visible} property.
*
* @return desired {@code visible} property value
* @see com.vaadin.flow.component.Component#setVisible(boolean)
*/
boolean visible() default true;
/**
* Get the value desired for the {@code weekNumbersVisible} property.
*
* @return desired {@code weekNumbersVisible} property value
* @see com.vaadin.flow.component.datetimepicker.DateTimePicker#setWeekNumbersVisible(boolean)
*/
boolean weekNumbersVisible() default false;
/**
* Get the value desired for the {@code width} property.
*
* @return desired {@code width} property value
* @see com.vaadin.flow.component.HasSize#setWidth(String)
*/
String width() default "";
}
/**
* Specifies how a Java bean property should be edited using an {@link com.vaadin.flow.component.html.Input}.
*
* @see FieldBuilder
* @see com.vaadin.flow.component.html.Input
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface Input {
/**
* Get the sub-type of {@link com.vaadin.flow.component.html.Input} that will edit the property.
*
*
* This property allows custom widget subclasses to be used.
*
*
* The specified type must have a public constructor that takes either no arguments,
* or one {@code FieldBuilderContext}.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.html.Input> implementation() default com.vaadin.flow.component.html.Input.class;
/**
* Specify CSS properties to be set via {@link com.vaadin.flow.dom.Style#set Style.set()}.
*
*
* The array value consists of name, value pairs. If the array has odd length, the last element is ignored.
*
* @return zero or more style property name, value pairs
* @see com.vaadin.flow.dom.Style
* @see com.vaadin.flow.component.HasStyle
*/
String[] styleProperties() default {};
/**
* Get the value desired for the {@code ariaLabel} property.
*
* @return desired {@code ariaLabel} property value
* @see com.vaadin.flow.component.HasAriaLabel#setAriaLabel(String)
*/
String ariaLabel() default "";
/**
* Get the value desired for the {@code ariaLabelledBy} property.
*
* @return desired {@code ariaLabelledBy} property value
* @see com.vaadin.flow.component.HasAriaLabel#setAriaLabelledBy(String)
*/
String ariaLabelledBy() default "";
/**
* Add the specified class names.
*
* @return zero or more class names to add
* @see com.vaadin.flow.component.HasStyle#addClassNames(String[])
*/
String[] addClassNames() default {};
/**
* Get the value desired for the {@code enabled} property.
*
* @return desired {@code enabled} property value
* @see com.vaadin.flow.component.HasEnabled#setEnabled(boolean)
*/
boolean enabled() default true;
/**
* Get the value desired for the {@code height} property.
*
* @return desired {@code height} property value
* @see com.vaadin.flow.component.HasSize#setHeight(String)
*/
String height() default "";
/**
* Get the value desired for the {@code id} property.
*
* @return desired {@code id} property value
* @see com.vaadin.flow.component.Component#setId(String)
*/
String id() default "";
/**
* Get the value desired for the {@code maxHeight} property.
*
* @return desired {@code maxHeight} property value
* @see com.vaadin.flow.component.HasSize#setMaxHeight(String)
*/
String maxHeight() default "";
/**
* Get the value desired for the {@code maxWidth} property.
*
* @return desired {@code maxWidth} property value
* @see com.vaadin.flow.component.HasSize#setMaxWidth(String)
*/
String maxWidth() default "";
/**
* Get the value desired for the {@code minHeight} property.
*
* @return desired {@code minHeight} property value
* @see com.vaadin.flow.component.HasSize#setMinHeight(String)
*/
String minHeight() default "";
/**
* Get the value desired for the {@code minWidth} property.
*
* @return desired {@code minWidth} property value
* @see com.vaadin.flow.component.HasSize#setMinWidth(String)
*/
String minWidth() default "";
/**
* Get the value desired for the {@code placeholder} property.
*
* @return desired {@code placeholder} property value
* @see com.vaadin.flow.component.html.Input#setPlaceholder(String)
*/
String placeholder() default "";
/**
* Get the value desired for the {@code readOnly} property.
*
* @return desired {@code readOnly} property value
* @see com.vaadin.flow.component.HasValueAndElement#setReadOnly(boolean)
*/
boolean readOnly() default false;
/**
* Get the value desired for the {@code requiredIndicatorVisible} property.
*
* @return desired {@code requiredIndicatorVisible} property value
* @see com.vaadin.flow.component.HasValueAndElement#setRequiredIndicatorVisible(boolean)
*/
boolean requiredIndicatorVisible() default false;
/**
* Get the value desired for the {@code tabIndex} property.
*
* @return desired {@code tabIndex} property value
* @see com.vaadin.flow.component.Focusable#setTabIndex(int)
*/
int tabIndex() default 0;
/**
* Get the value desired for the {@code type} property.
*
* @return desired {@code type} property value
* @see com.vaadin.flow.component.html.Input#setType(String)
*/
String type() default "text";
/**
* Get the value desired for the {@code valueChangeMode} property.
*
* @return desired {@code valueChangeMode} property value
* @see com.vaadin.flow.component.html.Input#setValueChangeMode(com.vaadin.flow.data.value.ValueChangeMode)
*/
com.vaadin.flow.data.value.ValueChangeMode valueChangeMode() default com.vaadin.flow.data.value.ValueChangeMode.ON_CHANGE;
/**
* Get the value desired for the {@code valueChangeTimeout} property.
*
* @return desired {@code valueChangeTimeout} property value
* @see com.vaadin.flow.component.html.Input#setValueChangeTimeout(int)
*/
int valueChangeTimeout() default 400;
/**
* Get the value desired for the {@code visible} property.
*
* @return desired {@code visible} property value
* @see com.vaadin.flow.component.Component#setVisible(boolean)
*/
boolean visible() default true;
/**
* Get the value desired for the {@code width} property.
*
* @return desired {@code width} property value
* @see com.vaadin.flow.component.HasSize#setWidth(String)
*/
String width() default "";
}
/**
* Specifies how a Java bean property should be edited using a {@link com.vaadin.flow.component.html.RangeInput}.
*
* @see FieldBuilder
* @see com.vaadin.flow.component.html.RangeInput
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface RangeInput {
/**
* Get the sub-type of {@link com.vaadin.flow.component.html.RangeInput} that will edit the property.
*
*
* This property allows custom widget subclasses to be used.
*
*
* The specified type must have a public constructor that takes either no arguments,
* or one {@code FieldBuilderContext}.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.html.RangeInput> implementation() default com.vaadin.flow.component.html.RangeInput.class;
/**
* Specify CSS properties to be set via {@link com.vaadin.flow.dom.Style#set Style.set()}.
*
*
* The array value consists of name, value pairs. If the array has odd length, the last element is ignored.
*
* @return zero or more style property name, value pairs
* @see com.vaadin.flow.dom.Style
* @see com.vaadin.flow.component.HasStyle
*/
String[] styleProperties() default {};
/**
* Get the value desired for the {@code ariaLabel} property.
*
* @return desired {@code ariaLabel} property value
* @see com.vaadin.flow.component.HasAriaLabel#setAriaLabel(String)
*/
String ariaLabel() default "";
/**
* Get the value desired for the {@code ariaLabelledBy} property.
*
* @return desired {@code ariaLabelledBy} property value
* @see com.vaadin.flow.component.HasAriaLabel#setAriaLabelledBy(String)
*/
String ariaLabelledBy() default "";
/**
* Add the specified class names.
*
* @return zero or more class names to add
* @see com.vaadin.flow.component.HasStyle#addClassNames(String[])
*/
String[] addClassNames() default {};
/**
* Get the value desired for the {@code enabled} property.
*
* @return desired {@code enabled} property value
* @see com.vaadin.flow.component.html.RangeInput#setEnabled(boolean)
*/
boolean enabled() default true;
/**
* Get the value desired for the {@code height} property.
*
* @return desired {@code height} property value
* @see com.vaadin.flow.component.HasSize#setHeight(String)
*/
String height() default "";
/**
* Get the value desired for the {@code id} property.
*
* @return desired {@code id} property value
* @see com.vaadin.flow.component.Component#setId(String)
*/
String id() default "";
/**
* Get the value desired for the {@code max} property.
*
* @return desired {@code max} property value
* @see com.vaadin.flow.component.html.RangeInput#setMax(double)
*/
double max() default 100.0;
/**
* Get the value desired for the {@code maxHeight} property.
*
* @return desired {@code maxHeight} property value
* @see com.vaadin.flow.component.HasSize#setMaxHeight(String)
*/
String maxHeight() default "";
/**
* Get the value desired for the {@code maxWidth} property.
*
* @return desired {@code maxWidth} property value
* @see com.vaadin.flow.component.HasSize#setMaxWidth(String)
*/
String maxWidth() default "";
/**
* Get the value desired for the {@code min} property.
*
* @return desired {@code min} property value
* @see com.vaadin.flow.component.html.RangeInput#setMin(double)
*/
double min() default 0.0;
/**
* Get the value desired for the {@code minHeight} property.
*
* @return desired {@code minHeight} property value
* @see com.vaadin.flow.component.HasSize#setMinHeight(String)
*/
String minHeight() default "";
/**
* Get the value desired for the {@code minWidth} property.
*
* @return desired {@code minWidth} property value
* @see com.vaadin.flow.component.HasSize#setMinWidth(String)
*/
String minWidth() default "";
/**
* Get the value desired for the {@code orientation} property.
*
* @return desired {@code orientation} property value
* @see com.vaadin.flow.component.html.RangeInput#setOrientation(com.vaadin.flow.component.html.RangeInput.Orientation)
*/
com.vaadin.flow.component.html.RangeInput.Orientation orientation() default com.vaadin.flow.component.html.RangeInput.Orientation.HORIZONTAL;
/**
* Get the value desired for the {@code readOnly} property.
*
* @return desired {@code readOnly} property value
* @see com.vaadin.flow.component.html.RangeInput#setReadOnly(boolean)
*/
boolean readOnly() default false;
/**
* Get the value desired for the {@code requiredIndicatorVisible} property.
*
* @return desired {@code requiredIndicatorVisible} property value
* @see com.vaadin.flow.component.HasValueAndElement#setRequiredIndicatorVisible(boolean)
*/
boolean requiredIndicatorVisible() default false;
/**
* Get the class to instantiate for the {@code step} property.
*
* @return desired {@code step} property value type
* @see com.vaadin.flow.component.html.RangeInput#setStep(Double)
*/
@SuppressWarnings("rawtypes")
Class extends Double> step() default Double.class;
/**
* Get the value desired for the {@code tabIndex} property.
*
* @return desired {@code tabIndex} property value
* @see com.vaadin.flow.component.Focusable#setTabIndex(int)
*/
int tabIndex() default 0;
/**
* Get the value desired for the {@code valueChangeMode} property.
*
* @return desired {@code valueChangeMode} property value
* @see com.vaadin.flow.component.html.RangeInput#setValueChangeMode(com.vaadin.flow.data.value.ValueChangeMode)
*/
com.vaadin.flow.data.value.ValueChangeMode valueChangeMode() default com.vaadin.flow.data.value.ValueChangeMode.ON_CHANGE;
/**
* Get the value desired for the {@code valueChangeTimeout} property.
*
* @return desired {@code valueChangeTimeout} property value
* @see com.vaadin.flow.component.html.RangeInput#setValueChangeTimeout(int)
*/
int valueChangeTimeout() default 400;
/**
* Get the value desired for the {@code visible} property.
*
* @return desired {@code visible} property value
* @see com.vaadin.flow.component.Component#setVisible(boolean)
*/
boolean visible() default true;
/**
* Get the value desired for the {@code width} property.
*
* @return desired {@code width} property value
* @see com.vaadin.flow.component.HasSize#setWidth(String)
*/
String width() default "";
}
/**
* Specifies how a Java bean property should be edited using a {@link com.vaadin.flow.component.listbox.ListBox}.
*
* @see FieldBuilder
* @see com.vaadin.flow.component.listbox.ListBox
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface ListBox {
/**
* Get the sub-type of {@link com.vaadin.flow.component.listbox.ListBox} that will edit the property.
*
*
* This property allows custom widget subclasses to be used.
*
*
* The specified type must have a public constructor that takes either no arguments,
* or one {@code FieldBuilderContext}.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.listbox.ListBox> implementation() default com.vaadin.flow.component.listbox.ListBox.class;
/**
* Specify CSS properties to be set via {@link com.vaadin.flow.dom.Style#set Style.set()}.
*
*
* The array value consists of name, value pairs. If the array has odd length, the last element is ignored.
*
* @return zero or more style property name, value pairs
* @see com.vaadin.flow.dom.Style
* @see com.vaadin.flow.component.HasStyle
*/
String[] styleProperties() default {};
/**
* Get the value desired for the {@code ariaLabel} property.
*
* @return desired {@code ariaLabel} property value
* @see com.vaadin.flow.component.HasAriaLabel#setAriaLabel(String)
*/
String ariaLabel() default "";
/**
* Get the value desired for the {@code ariaLabelledBy} property.
*
* @return desired {@code ariaLabelledBy} property value
* @see com.vaadin.flow.component.HasAriaLabel#setAriaLabelledBy(String)
*/
String ariaLabelledBy() default "";
/**
* Add the specified class names.
*
* @return zero or more class names to add
* @see com.vaadin.flow.component.HasStyle#addClassNames(String[])
*/
String[] addClassNames() default {};
/**
* Get the class to instantiate for the {@code dataProvider} property.
*
* @return desired {@code dataProvider} property value type
* @see com.vaadin.flow.component.listbox.ListBoxBase#setDataProvider(com.vaadin.flow.data.provider.DataProvider)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.data.provider.DataProvider> dataProvider() default com.vaadin.flow.data.provider.DataProvider.class;
/**
* Get the value desired for the {@code enabled} property.
*
* @return desired {@code enabled} property value
* @see com.vaadin.flow.component.HasEnabled#setEnabled(boolean)
*/
boolean enabled() default true;
/**
* Get the value desired for the {@code height} property.
*
* @return desired {@code height} property value
* @see com.vaadin.flow.component.HasSize#setHeight(String)
*/
String height() default "";
/**
* Get the value desired for the {@code id} property.
*
* @return desired {@code id} property value
* @see com.vaadin.flow.component.Component#setId(String)
*/
String id() default "";
/**
* Get the class to instantiate for the {@code itemEnabledProvider} property.
*
* @return desired {@code itemEnabledProvider} property value type
* @see com.vaadin.flow.component.listbox.ListBoxBase#setItemEnabledProvider(com.vaadin.flow.function.SerializablePredicate)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.function.SerializablePredicate> itemEnabledProvider() default com.vaadin.flow.function.SerializablePredicate.class;
/**
* Get the class to instantiate for the {@code itemLabelGenerator} property.
*
* @return desired {@code itemLabelGenerator} property value type
* @see com.vaadin.flow.component.listbox.ListBoxBase#setItemLabelGenerator(com.vaadin.flow.component.ItemLabelGenerator)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.ItemLabelGenerator> itemLabelGenerator() default com.vaadin.flow.component.ItemLabelGenerator.class;
/**
* Get the class to instantiate for the {@code items} property.
*
* @return desired {@code items} property value type
* @see com.vaadin.flow.component.listbox.ListBoxBase#setItems(com.vaadin.flow.data.provider.DataProvider)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.data.provider.DataProvider> items() default com.vaadin.flow.data.provider.DataProvider.class;
/**
* Get the value desired for the {@code maxHeight} property.
*
* @return desired {@code maxHeight} property value
* @see com.vaadin.flow.component.HasSize#setMaxHeight(String)
*/
String maxHeight() default "";
/**
* Get the value desired for the {@code maxWidth} property.
*
* @return desired {@code maxWidth} property value
* @see com.vaadin.flow.component.HasSize#setMaxWidth(String)
*/
String maxWidth() default "";
/**
* Get the value desired for the {@code minHeight} property.
*
* @return desired {@code minHeight} property value
* @see com.vaadin.flow.component.HasSize#setMinHeight(String)
*/
String minHeight() default "";
/**
* Get the value desired for the {@code minWidth} property.
*
* @return desired {@code minWidth} property value
* @see com.vaadin.flow.component.HasSize#setMinWidth(String)
*/
String minWidth() default "";
/**
* Get the value desired for the {@code readOnly} property.
*
* @return desired {@code readOnly} property value
* @see com.vaadin.flow.component.HasValueAndElement#setReadOnly(boolean)
*/
boolean readOnly() default false;
/**
* Get the class to instantiate for the {@code renderer} property.
*
* @return desired {@code renderer} property value type
* @see com.vaadin.flow.component.listbox.ListBoxBase#setRenderer(com.vaadin.flow.data.renderer.ComponentRenderer)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.data.renderer.ComponentRenderer> renderer() default com.vaadin.flow.data.renderer.ComponentRenderer.class;
/**
* Get the value desired for the {@code requiredIndicatorVisible} property.
*
* @return desired {@code requiredIndicatorVisible} property value
* @see com.vaadin.flow.component.listbox.ListBoxBase#setRequiredIndicatorVisible(boolean)
*/
boolean requiredIndicatorVisible() default false;
/**
* Get the value desired for the {@code tooltipText} property.
*
* @return desired {@code tooltipText} property value
* @see com.vaadin.flow.component.shared.HasTooltip#setTooltipText(String)
*/
String tooltipText() default "";
/**
* Get the value desired for the {@code visible} property.
*
* @return desired {@code visible} property value
* @see com.vaadin.flow.component.Component#setVisible(boolean)
*/
boolean visible() default true;
/**
* Get the value desired for the {@code width} property.
*
* @return desired {@code width} property value
* @see com.vaadin.flow.component.HasSize#setWidth(String)
*/
String width() default "";
}
/**
* Specifies how a Java bean property should be edited using a {@link com.vaadin.flow.component.listbox.MultiSelectListBox}.
*
* @see FieldBuilder
* @see com.vaadin.flow.component.listbox.MultiSelectListBox
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface MultiSelectListBox {
/**
* Get the sub-type of {@link com.vaadin.flow.component.listbox.MultiSelectListBox} that will edit the property.
*
*
* This property allows custom widget subclasses to be used.
*
*
* The specified type must have a public constructor that takes either no arguments,
* or one {@code FieldBuilderContext}.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.listbox.MultiSelectListBox> implementation() default com.vaadin.flow.component.listbox.MultiSelectListBox.class;
/**
* Specify CSS properties to be set via {@link com.vaadin.flow.dom.Style#set Style.set()}.
*
*
* The array value consists of name, value pairs. If the array has odd length, the last element is ignored.
*
* @return zero or more style property name, value pairs
* @see com.vaadin.flow.dom.Style
* @see com.vaadin.flow.component.HasStyle
*/
String[] styleProperties() default {};
/**
* Get the value desired for the {@code ariaLabel} property.
*
* @return desired {@code ariaLabel} property value
* @see com.vaadin.flow.component.HasAriaLabel#setAriaLabel(String)
*/
String ariaLabel() default "";
/**
* Get the value desired for the {@code ariaLabelledBy} property.
*
* @return desired {@code ariaLabelledBy} property value
* @see com.vaadin.flow.component.HasAriaLabel#setAriaLabelledBy(String)
*/
String ariaLabelledBy() default "";
/**
* Add the specified class names.
*
* @return zero or more class names to add
* @see com.vaadin.flow.component.HasStyle#addClassNames(String[])
*/
String[] addClassNames() default {};
/**
* Get the class to instantiate for the {@code dataProvider} property.
*
* @return desired {@code dataProvider} property value type
* @see com.vaadin.flow.component.listbox.ListBoxBase#setDataProvider(com.vaadin.flow.data.provider.DataProvider)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.data.provider.DataProvider> dataProvider() default com.vaadin.flow.data.provider.DataProvider.class;
/**
* Get the value desired for the {@code enabled} property.
*
* @return desired {@code enabled} property value
* @see com.vaadin.flow.component.HasEnabled#setEnabled(boolean)
*/
boolean enabled() default true;
/**
* Get the value desired for the {@code height} property.
*
* @return desired {@code height} property value
* @see com.vaadin.flow.component.HasSize#setHeight(String)
*/
String height() default "";
/**
* Get the value desired for the {@code id} property.
*
* @return desired {@code id} property value
* @see com.vaadin.flow.component.Component#setId(String)
*/
String id() default "";
/**
* Get the class to instantiate for the {@code itemEnabledProvider} property.
*
* @return desired {@code itemEnabledProvider} property value type
* @see com.vaadin.flow.component.listbox.ListBoxBase#setItemEnabledProvider(com.vaadin.flow.function.SerializablePredicate)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.function.SerializablePredicate> itemEnabledProvider() default com.vaadin.flow.function.SerializablePredicate.class;
/**
* Get the class to instantiate for the {@code itemLabelGenerator} property.
*
* @return desired {@code itemLabelGenerator} property value type
* @see com.vaadin.flow.component.listbox.ListBoxBase#setItemLabelGenerator(com.vaadin.flow.component.ItemLabelGenerator)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.ItemLabelGenerator> itemLabelGenerator() default com.vaadin.flow.component.ItemLabelGenerator.class;
/**
* Get the class to instantiate for the {@code items} property.
*
* @return desired {@code items} property value type
* @see com.vaadin.flow.component.listbox.ListBoxBase#setItems(com.vaadin.flow.data.provider.DataProvider)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.data.provider.DataProvider> items() default com.vaadin.flow.data.provider.DataProvider.class;
/**
* Get the value desired for the {@code maxHeight} property.
*
* @return desired {@code maxHeight} property value
* @see com.vaadin.flow.component.HasSize#setMaxHeight(String)
*/
String maxHeight() default "";
/**
* Get the value desired for the {@code maxWidth} property.
*
* @return desired {@code maxWidth} property value
* @see com.vaadin.flow.component.HasSize#setMaxWidth(String)
*/
String maxWidth() default "";
/**
* Get the value desired for the {@code minHeight} property.
*
* @return desired {@code minHeight} property value
* @see com.vaadin.flow.component.HasSize#setMinHeight(String)
*/
String minHeight() default "";
/**
* Get the value desired for the {@code minWidth} property.
*
* @return desired {@code minWidth} property value
* @see com.vaadin.flow.component.HasSize#setMinWidth(String)
*/
String minWidth() default "";
/**
* Get the value desired for the {@code readOnly} property.
*
* @return desired {@code readOnly} property value
* @see com.vaadin.flow.component.HasValueAndElement#setReadOnly(boolean)
*/
boolean readOnly() default false;
/**
* Get the class to instantiate for the {@code renderer} property.
*
* @return desired {@code renderer} property value type
* @see com.vaadin.flow.component.listbox.ListBoxBase#setRenderer(com.vaadin.flow.data.renderer.ComponentRenderer)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.data.renderer.ComponentRenderer> renderer() default com.vaadin.flow.data.renderer.ComponentRenderer.class;
/**
* Get the value desired for the {@code requiredIndicatorVisible} property.
*
* @return desired {@code requiredIndicatorVisible} property value
* @see com.vaadin.flow.component.listbox.ListBoxBase#setRequiredIndicatorVisible(boolean)
*/
boolean requiredIndicatorVisible() default false;
/**
* Get the value desired for the {@code selectionPreservationMode} property.
*
* @return desired {@code selectionPreservationMode} property value
* @see com.vaadin.flow.component.listbox.MultiSelectListBox#setSelectionPreservationMode(com.vaadin.flow.component.shared.SelectionPreservationMode)
*/
com.vaadin.flow.component.shared.SelectionPreservationMode selectionPreservationMode() default com.vaadin.flow.component.shared.SelectionPreservationMode.DISCARD;
/**
* Get the value desired for the {@code tooltipText} property.
*
* @return desired {@code tooltipText} property value
* @see com.vaadin.flow.component.shared.HasTooltip#setTooltipText(String)
*/
String tooltipText() default "";
/**
* Get the value desired for the {@code visible} property.
*
* @return desired {@code visible} property value
* @see com.vaadin.flow.component.Component#setVisible(boolean)
*/
boolean visible() default true;
/**
* Get the value desired for the {@code width} property.
*
* @return desired {@code width} property value
* @see com.vaadin.flow.component.HasSize#setWidth(String)
*/
String width() default "";
}
/**
* Specifies how a Java bean property should be edited using a {@link com.vaadin.flow.component.radiobutton.RadioButtonGroup}.
*
* @see FieldBuilder
* @see com.vaadin.flow.component.radiobutton.RadioButtonGroup
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface RadioButtonGroup {
/**
* Get the sub-type of {@link com.vaadin.flow.component.radiobutton.RadioButtonGroup} that will edit the property.
*
*
* This property allows custom widget subclasses to be used.
*
*
* The specified type must have a public constructor that takes either no arguments,
* or one {@code FieldBuilderContext}.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.radiobutton.RadioButtonGroup> implementation() default com.vaadin.flow.component.radiobutton.RadioButtonGroup.class;
/**
* Specify CSS properties to be set via {@link com.vaadin.flow.dom.Style#set Style.set()}.
*
*
* The array value consists of name, value pairs. If the array has odd length, the last element is ignored.
*
* @return zero or more style property name, value pairs
* @see com.vaadin.flow.dom.Style
* @see com.vaadin.flow.component.HasStyle
*/
String[] styleProperties() default {};
/**
* Get the value desired for the {@code ariaLabel} property.
*
* @return desired {@code ariaLabel} property value
* @see com.vaadin.flow.component.radiobutton.RadioButtonGroup#setAriaLabel(String)
*/
String ariaLabel() default "";
/**
* Get the value desired for the {@code ariaLabelledBy} property.
*
* @return desired {@code ariaLabelledBy} property value
* @see com.vaadin.flow.component.radiobutton.RadioButtonGroup#setAriaLabelledBy(String)
*/
String ariaLabelledBy() default "";
/**
* Add the specified class names.
*
* @return zero or more class names to add
* @see com.vaadin.flow.component.HasStyle#addClassNames(String[])
*/
String[] addClassNames() default {};
/**
* Get the class to instantiate for the {@code dataProvider} property.
*
* @return desired {@code dataProvider} property value type
* @see com.vaadin.flow.component.radiobutton.RadioButtonGroup#setDataProvider(com.vaadin.flow.data.provider.DataProvider)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.data.provider.DataProvider> dataProvider() default com.vaadin.flow.data.provider.DataProvider.class;
/**
* Get the value desired for the {@code enabled} property.
*
* @return desired {@code enabled} property value
* @see com.vaadin.flow.component.HasEnabled#setEnabled(boolean)
*/
boolean enabled() default true;
/**
* Get the value desired for the {@code errorMessage} property.
*
* @return desired {@code errorMessage} property value
* @see com.vaadin.flow.component.shared.HasValidationProperties#setErrorMessage(String)
*/
String errorMessage() default "";
/**
* Get the value desired for the {@code height} property.
*
* @return desired {@code height} property value
* @see com.vaadin.flow.component.HasSize#setHeight(String)
*/
String height() default "";
/**
* Get the class to instantiate for the {@code helperComponent} property.
*
* @return desired {@code helperComponent} property value type
* @see com.vaadin.flow.component.HasHelper#setHelperComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> helperComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code helperText} property.
*
* @return desired {@code helperText} property value
* @see com.vaadin.flow.component.HasHelper#setHelperText(String)
*/
String helperText() default "";
/**
* Get the value desired for the {@code id} property.
*
* @return desired {@code id} property value
* @see com.vaadin.flow.component.Component#setId(String)
*/
String id() default "";
/**
* Get the class to instantiate for the {@code itemEnabledProvider} property.
*
* @return desired {@code itemEnabledProvider} property value type
* @see com.vaadin.flow.component.radiobutton.RadioButtonGroup#setItemEnabledProvider(com.vaadin.flow.function.SerializablePredicate)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.function.SerializablePredicate> itemEnabledProvider() default com.vaadin.flow.function.SerializablePredicate.class;
/**
* Get the class to instantiate for the {@code itemLabelGenerator} property.
*
* @return desired {@code itemLabelGenerator} property value type
* @see com.vaadin.flow.component.radiobutton.RadioButtonGroup#setItemLabelGenerator(com.vaadin.flow.component.ItemLabelGenerator)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.ItemLabelGenerator> itemLabelGenerator() default com.vaadin.flow.component.ItemLabelGenerator.class;
/**
* Get the class to instantiate for the {@code items} property.
*
* @return desired {@code items} property value type
* @see com.vaadin.flow.component.radiobutton.RadioButtonGroup#setItems(com.vaadin.flow.data.provider.DataProvider)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.data.provider.DataProvider> items() default com.vaadin.flow.data.provider.DataProvider.class;
/**
* Get the value desired for the {@code label} property.
*
* @return desired {@code label} property value
* @see com.vaadin.flow.component.radiobutton.RadioButtonGroup#setLabel(String)
*/
String label() default "";
/**
* Get the value desired for the {@code manualValidation} property.
*
* @return desired {@code manualValidation} property value
* @see com.vaadin.flow.component.radiobutton.RadioButtonGroup#setManualValidation(boolean)
*/
boolean manualValidation() default false;
/**
* Get the value desired for the {@code maxHeight} property.
*
* @return desired {@code maxHeight} property value
* @see com.vaadin.flow.component.HasSize#setMaxHeight(String)
*/
String maxHeight() default "";
/**
* Get the value desired for the {@code maxWidth} property.
*
* @return desired {@code maxWidth} property value
* @see com.vaadin.flow.component.HasSize#setMaxWidth(String)
*/
String maxWidth() default "";
/**
* Get the value desired for the {@code minHeight} property.
*
* @return desired {@code minHeight} property value
* @see com.vaadin.flow.component.HasSize#setMinHeight(String)
*/
String minHeight() default "";
/**
* Get the value desired for the {@code minWidth} property.
*
* @return desired {@code minWidth} property value
* @see com.vaadin.flow.component.HasSize#setMinWidth(String)
*/
String minWidth() default "";
/**
* Get the value desired for the {@code readOnly} property.
*
* @return desired {@code readOnly} property value
* @see com.vaadin.flow.component.radiobutton.RadioButtonGroup#setReadOnly(boolean)
*/
boolean readOnly() default false;
/**
* Get the class to instantiate for the {@code renderer} property.
*
* @return desired {@code renderer} property value type
* @see com.vaadin.flow.component.radiobutton.RadioButtonGroup#setRenderer(com.vaadin.flow.data.renderer.ComponentRenderer)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.data.renderer.ComponentRenderer> renderer() default com.vaadin.flow.data.renderer.ComponentRenderer.class;
/**
* Get the value desired for the {@code required} property.
*
* @return desired {@code required} property value
* @see com.vaadin.flow.component.radiobutton.RadioButtonGroup#setRequired(boolean)
*/
boolean required() default false;
/**
* Get the value desired for the {@code requiredIndicatorVisible} property.
*
* @return desired {@code requiredIndicatorVisible} property value
* @see com.vaadin.flow.component.HasValueAndElement#setRequiredIndicatorVisible(boolean)
*/
boolean requiredIndicatorVisible() default false;
/**
* Get the value desired for the {@code selectionPreservationMode} property.
*
* @return desired {@code selectionPreservationMode} property value
* @see com.vaadin.flow.component.radiobutton.RadioButtonGroup#setSelectionPreservationMode(com.vaadin.flow.component.shared.SelectionPreservationMode)
*/
com.vaadin.flow.component.shared.SelectionPreservationMode selectionPreservationMode() default com.vaadin.flow.component.shared.SelectionPreservationMode.DISCARD;
/**
* Add the specified theme names.
*
* @return zero or more theme names to add
* @see com.vaadin.flow.component.HasTheme#addThemeNames(String[])
*/
String[] addThemeNames() default {};
/**
* Add the specified theme variants.
*
* @return zero or more theme variants to add
* @see com.vaadin.flow.component.shared.HasThemeVariant#addThemeVariants(com.vaadin.flow.component.shared.ThemeVariant[])
*/
com.vaadin.flow.component.radiobutton.RadioGroupVariant[] addThemeVariants() default {};
/**
* Get the value desired for the {@code tooltipText} property.
*
* @return desired {@code tooltipText} property value
* @see com.vaadin.flow.component.shared.HasTooltip#setTooltipText(String)
*/
String tooltipText() default "";
/**
* Get the value desired for the {@code visible} property.
*
* @return desired {@code visible} property value
* @see com.vaadin.flow.component.Component#setVisible(boolean)
*/
boolean visible() default true;
/**
* Get the value desired for the {@code width} property.
*
* @return desired {@code width} property value
* @see com.vaadin.flow.component.HasSize#setWidth(String)
*/
String width() default "";
}
/**
* Specifies how a Java bean property should be edited using a {@link com.vaadin.flow.component.select.Select}.
*
* @see FieldBuilder
* @see com.vaadin.flow.component.select.Select
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface Select {
/**
* Get the sub-type of {@link com.vaadin.flow.component.select.Select} that will edit the property.
*
*
* This property allows custom widget subclasses to be used.
*
*
* The specified type must have a public constructor that takes either no arguments,
* or one {@code FieldBuilderContext}.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.select.Select> implementation() default com.vaadin.flow.component.select.Select.class;
/**
* Specify CSS properties to be set via {@link com.vaadin.flow.dom.Style#set Style.set()}.
*
*
* The array value consists of name, value pairs. If the array has odd length, the last element is ignored.
*
* @return zero or more style property name, value pairs
* @see com.vaadin.flow.dom.Style
* @see com.vaadin.flow.component.HasStyle
*/
String[] styleProperties() default {};
/**
* Get the value desired for the {@code ariaLabel} property.
*
* @return desired {@code ariaLabel} property value
* @see com.vaadin.flow.component.select.Select#setAriaLabel(String)
*/
String ariaLabel() default "";
/**
* Get the value desired for the {@code ariaLabelledBy} property.
*
* @return desired {@code ariaLabelledBy} property value
* @see com.vaadin.flow.component.select.Select#setAriaLabelledBy(String)
*/
String ariaLabelledBy() default "";
/**
* Get the value desired for the {@code autofocus} property.
*
* @return desired {@code autofocus} property value
* @see com.vaadin.flow.component.select.Select#setAutofocus(boolean)
*/
boolean autofocus() default false;
/**
* Add the specified class names.
*
* @return zero or more class names to add
* @see com.vaadin.flow.component.HasStyle#addClassNames(String[])
*/
String[] addClassNames() default {};
/**
* Get the class to instantiate for the {@code dataProvider} property.
*
* @return desired {@code dataProvider} property value type
* @see com.vaadin.flow.component.select.Select#setDataProvider(com.vaadin.flow.data.provider.DataProvider)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.data.provider.DataProvider> dataProvider() default com.vaadin.flow.data.provider.DataProvider.class;
/**
* Get the value desired for the {@code emptySelectionAllowed} property.
*
* @return desired {@code emptySelectionAllowed} property value
* @see com.vaadin.flow.component.select.Select#setEmptySelectionAllowed(boolean)
*/
boolean emptySelectionAllowed() default false;
/**
* Get the value desired for the {@code emptySelectionCaption} property.
*
* @return desired {@code emptySelectionCaption} property value
* @see com.vaadin.flow.component.select.Select#setEmptySelectionCaption(String)
*/
String emptySelectionCaption() default "";
/**
* Get the value desired for the {@code enabled} property.
*
* @return desired {@code enabled} property value
* @see com.vaadin.flow.component.HasEnabled#setEnabled(boolean)
*/
boolean enabled() default true;
/**
* Get the value desired for the {@code errorMessage} property.
*
* @return desired {@code errorMessage} property value
* @see com.vaadin.flow.component.shared.HasValidationProperties#setErrorMessage(String)
*/
String errorMessage() default "";
/**
* Get the value desired for the {@code height} property.
*
* @return desired {@code height} property value
* @see com.vaadin.flow.component.HasSize#setHeight(String)
*/
String height() default "";
/**
* Get the class to instantiate for the {@code helperComponent} property.
*
* @return desired {@code helperComponent} property value type
* @see com.vaadin.flow.component.HasHelper#setHelperComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> helperComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code helperText} property.
*
* @return desired {@code helperText} property value
* @see com.vaadin.flow.component.HasHelper#setHelperText(String)
*/
String helperText() default "";
/**
* Get the value desired for the {@code id} property.
*
* @return desired {@code id} property value
* @see com.vaadin.flow.component.Component#setId(String)
*/
String id() default "";
/**
* Get the class to instantiate for the {@code itemEnabledProvider} property.
*
* @return desired {@code itemEnabledProvider} property value type
* @see com.vaadin.flow.component.select.Select#setItemEnabledProvider(com.vaadin.flow.function.SerializablePredicate)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.function.SerializablePredicate> itemEnabledProvider() default com.vaadin.flow.function.SerializablePredicate.class;
/**
* Get the class to instantiate for the {@code itemLabelGenerator} property.
*
* @return desired {@code itemLabelGenerator} property value type
* @see com.vaadin.flow.component.select.Select#setItemLabelGenerator(com.vaadin.flow.component.ItemLabelGenerator)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.ItemLabelGenerator> itemLabelGenerator() default com.vaadin.flow.component.ItemLabelGenerator.class;
/**
* Get the class to instantiate for the {@code items} property.
*
* @return desired {@code items} property value type
* @see com.vaadin.flow.component.select.Select#setItems(com.vaadin.flow.data.provider.DataProvider)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.data.provider.DataProvider> items() default com.vaadin.flow.data.provider.DataProvider.class;
/**
* Get the value desired for the {@code label} property.
*
* @return desired {@code label} property value
* @see com.vaadin.flow.component.select.Select#setLabel(String)
*/
String label() default "";
/**
* Get the value desired for the {@code manualValidation} property.
*
* @return desired {@code manualValidation} property value
* @see com.vaadin.flow.component.select.Select#setManualValidation(boolean)
*/
boolean manualValidation() default false;
/**
* Get the value desired for the {@code maxHeight} property.
*
* @return desired {@code maxHeight} property value
* @see com.vaadin.flow.component.HasSize#setMaxHeight(String)
*/
String maxHeight() default "";
/**
* Get the value desired for the {@code maxWidth} property.
*
* @return desired {@code maxWidth} property value
* @see com.vaadin.flow.component.HasSize#setMaxWidth(String)
*/
String maxWidth() default "";
/**
* Get the value desired for the {@code minHeight} property.
*
* @return desired {@code minHeight} property value
* @see com.vaadin.flow.component.HasSize#setMinHeight(String)
*/
String minHeight() default "";
/**
* Get the value desired for the {@code minWidth} property.
*
* @return desired {@code minWidth} property value
* @see com.vaadin.flow.component.HasSize#setMinWidth(String)
*/
String minWidth() default "";
/**
* Get the value desired for the {@code overlayClassName} property.
*
* @return desired {@code overlayClassName} property value
* @see com.vaadin.flow.component.shared.HasOverlayClassName#setOverlayClassName(String)
*/
String overlayClassName() default "";
/**
* Get the value desired for the {@code placeholder} property.
*
* @return desired {@code placeholder} property value
* @see com.vaadin.flow.component.select.Select#setPlaceholder(String)
*/
String placeholder() default "";
/**
* Get the class to instantiate for the {@code prefixComponent} property.
*
* @return desired {@code prefixComponent} property value type
* @see com.vaadin.flow.component.shared.HasPrefix#setPrefixComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> prefixComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code readOnly} property.
*
* @return desired {@code readOnly} property value
* @see com.vaadin.flow.component.HasValueAndElement#setReadOnly(boolean)
*/
boolean readOnly() default false;
/**
* Get the class to instantiate for the {@code renderer} property.
*
* @return desired {@code renderer} property value type
* @see com.vaadin.flow.component.select.Select#setRenderer(com.vaadin.flow.data.renderer.ComponentRenderer)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.data.renderer.ComponentRenderer> renderer() default com.vaadin.flow.data.renderer.ComponentRenderer.class;
/**
* Get the value desired for the {@code requiredIndicatorVisible} property.
*
* @return desired {@code requiredIndicatorVisible} property value
* @see com.vaadin.flow.component.select.Select#setRequiredIndicatorVisible(boolean)
*/
boolean requiredIndicatorVisible() default false;
/**
* Get the value desired for the {@code tabIndex} property.
*
* @return desired {@code tabIndex} property value
* @see com.vaadin.flow.component.Focusable#setTabIndex(int)
*/
int tabIndex() default 0;
/**
* Get the class to instantiate for the {@code textRenderer} property.
*
* @return desired {@code textRenderer} property value type
* @see com.vaadin.flow.component.select.Select#setTextRenderer(com.vaadin.flow.component.ItemLabelGenerator)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.ItemLabelGenerator> textRenderer() default com.vaadin.flow.component.ItemLabelGenerator.class;
/**
* Add the specified theme names.
*
* @return zero or more theme names to add
* @see com.vaadin.flow.component.HasTheme#addThemeNames(String[])
*/
String[] addThemeNames() default {};
/**
* Add the specified theme variants.
*
* @return zero or more theme variants to add
* @see com.vaadin.flow.component.shared.HasThemeVariant#addThemeVariants(com.vaadin.flow.component.shared.ThemeVariant[])
*/
com.vaadin.flow.component.select.SelectVariant[] addThemeVariants() default {};
/**
* Get the value desired for the {@code tooltipText} property.
*
* @return desired {@code tooltipText} property value
* @see com.vaadin.flow.component.shared.HasTooltip#setTooltipText(String)
*/
String tooltipText() default "";
/**
* Get the value desired for the {@code visible} property.
*
* @return desired {@code visible} property value
* @see com.vaadin.flow.component.Component#setVisible(boolean)
*/
boolean visible() default true;
/**
* Get the value desired for the {@code width} property.
*
* @return desired {@code width} property value
* @see com.vaadin.flow.component.HasSize#setWidth(String)
*/
String width() default "";
}
/**
* Specifies how a Java bean property should be edited using a {@link com.vaadin.flow.component.textfield.BigDecimalField}.
*
* @see FieldBuilder
* @see com.vaadin.flow.component.textfield.BigDecimalField
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface BigDecimalField {
/**
* Get the sub-type of {@link com.vaadin.flow.component.textfield.BigDecimalField} that will edit the property.
*
*
* This property allows custom widget subclasses to be used.
*
*
* The specified type must have a public constructor that takes either no arguments,
* or one {@code FieldBuilderContext}.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.textfield.BigDecimalField> implementation() default com.vaadin.flow.component.textfield.BigDecimalField.class;
/**
* Specify CSS properties to be set via {@link com.vaadin.flow.dom.Style#set Style.set()}.
*
*
* The array value consists of name, value pairs. If the array has odd length, the last element is ignored.
*
* @return zero or more style property name, value pairs
* @see com.vaadin.flow.dom.Style
* @see com.vaadin.flow.component.HasStyle
*/
String[] styleProperties() default {};
/**
* Get the value desired for the {@code ariaLabel} property.
*
* @return desired {@code ariaLabel} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setAriaLabel(String)
*/
String ariaLabel() default "";
/**
* Get the value desired for the {@code ariaLabelledBy} property.
*
* @return desired {@code ariaLabelledBy} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setAriaLabelledBy(String)
*/
String ariaLabelledBy() default "";
/**
* Get the value desired for the {@code autocapitalize} property.
*
* @return desired {@code autocapitalize} property value
* @see com.vaadin.flow.component.textfield.HasAutocapitalize#setAutocapitalize(com.vaadin.flow.component.textfield.Autocapitalize)
*/
com.vaadin.flow.component.textfield.Autocapitalize autocapitalize() default com.vaadin.flow.component.textfield.Autocapitalize.NONE;
/**
* Get the value desired for the {@code autocomplete} property.
*
* @return desired {@code autocomplete} property value
* @see com.vaadin.flow.component.textfield.HasAutocomplete#setAutocomplete(com.vaadin.flow.component.textfield.Autocomplete)
*/
com.vaadin.flow.component.textfield.Autocomplete autocomplete() default com.vaadin.flow.component.textfield.Autocomplete.ON;
/**
* Get the value desired for the {@code autocorrect} property.
*
* @return desired {@code autocorrect} property value
* @see com.vaadin.flow.component.textfield.HasAutocorrect#setAutocorrect(boolean)
*/
boolean autocorrect() default false;
/**
* Get the value desired for the {@code autofocus} property.
*
* @return desired {@code autofocus} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setAutofocus(boolean)
*/
boolean autofocus() default false;
/**
* Get the value desired for the {@code autoselect} property.
*
* @return desired {@code autoselect} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setAutoselect(boolean)
*/
boolean autoselect() default false;
/**
* Add the specified class names.
*
* @return zero or more class names to add
* @see com.vaadin.flow.component.HasStyle#addClassNames(String[])
*/
String[] addClassNames() default {};
/**
* Get the value desired for the {@code clearButtonVisible} property.
*
* @return desired {@code clearButtonVisible} property value
* @see com.vaadin.flow.component.shared.HasClearButton#setClearButtonVisible(boolean)
*/
boolean clearButtonVisible() default false;
/**
* Get the value desired for the {@code enabled} property.
*
* @return desired {@code enabled} property value
* @see com.vaadin.flow.component.HasEnabled#setEnabled(boolean)
*/
boolean enabled() default true;
/**
* Get the value desired for the {@code errorMessage} property.
*
* @return desired {@code errorMessage} property value
* @see com.vaadin.flow.component.shared.HasValidationProperties#setErrorMessage(String)
*/
String errorMessage() default "";
/**
* Get the value desired for the {@code height} property.
*
* @return desired {@code height} property value
* @see com.vaadin.flow.component.HasSize#setHeight(String)
*/
String height() default "";
/**
* Get the class to instantiate for the {@code helperComponent} property.
*
* @return desired {@code helperComponent} property value type
* @see com.vaadin.flow.component.HasHelper#setHelperComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> helperComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code helperText} property.
*
* @return desired {@code helperText} property value
* @see com.vaadin.flow.component.HasHelper#setHelperText(String)
*/
String helperText() default "";
/**
* Get the value desired for the {@code id} property.
*
* @return desired {@code id} property value
* @see com.vaadin.flow.component.Component#setId(String)
*/
String id() default "";
/**
* Get the value desired for the {@code label} property.
*
* @return desired {@code label} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setLabel(String)
*/
String label() default "";
/**
* Get the class to instantiate for the {@code locale} property.
*
* @return desired {@code locale} property value type
* @see com.vaadin.flow.component.textfield.BigDecimalField#setLocale(java.util.Locale)
*/
@SuppressWarnings("rawtypes")
Class extends java.util.Locale> locale() default java.util.Locale.class;
/**
* Get the value desired for the {@code manualValidation} property.
*
* @return desired {@code manualValidation} property value
* @see com.vaadin.flow.component.textfield.BigDecimalField#setManualValidation(boolean)
*/
boolean manualValidation() default false;
/**
* Get the value desired for the {@code maxHeight} property.
*
* @return desired {@code maxHeight} property value
* @see com.vaadin.flow.component.HasSize#setMaxHeight(String)
*/
String maxHeight() default "";
/**
* Get the value desired for the {@code maxWidth} property.
*
* @return desired {@code maxWidth} property value
* @see com.vaadin.flow.component.HasSize#setMaxWidth(String)
*/
String maxWidth() default "";
/**
* Get the value desired for the {@code minHeight} property.
*
* @return desired {@code minHeight} property value
* @see com.vaadin.flow.component.HasSize#setMinHeight(String)
*/
String minHeight() default "";
/**
* Get the value desired for the {@code minWidth} property.
*
* @return desired {@code minWidth} property value
* @see com.vaadin.flow.component.HasSize#setMinWidth(String)
*/
String minWidth() default "";
/**
* Get the value desired for the {@code placeholder} property.
*
* @return desired {@code placeholder} property value
* @see com.vaadin.flow.component.HasPlaceholder#setPlaceholder(String)
*/
String placeholder() default "";
/**
* Get the class to instantiate for the {@code prefixComponent} property.
*
* @return desired {@code prefixComponent} property value type
* @see com.vaadin.flow.component.shared.HasPrefix#setPrefixComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> prefixComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code readOnly} property.
*
* @return desired {@code readOnly} property value
* @see com.vaadin.flow.component.HasValueAndElement#setReadOnly(boolean)
*/
boolean readOnly() default false;
/**
* Get the value desired for the {@code required} property.
*
* @return desired {@code required} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setRequired(boolean)
*/
boolean required() default false;
/**
* Get the value desired for the {@code requiredIndicatorVisible} property.
*
* @return desired {@code requiredIndicatorVisible} property value
* @see com.vaadin.flow.component.HasValueAndElement#setRequiredIndicatorVisible(boolean)
*/
boolean requiredIndicatorVisible() default false;
/**
* Get the class to instantiate for the {@code suffixComponent} property.
*
* @return desired {@code suffixComponent} property value type
* @see com.vaadin.flow.component.shared.HasSuffix#setSuffixComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> suffixComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code tabIndex} property.
*
* @return desired {@code tabIndex} property value
* @see com.vaadin.flow.component.Focusable#setTabIndex(int)
*/
int tabIndex() default 0;
/**
* Add the specified theme names.
*
* @return zero or more theme names to add
* @see com.vaadin.flow.component.HasTheme#addThemeNames(String[])
*/
String[] addThemeNames() default {};
/**
* Add the specified theme variants.
*
* @return zero or more theme variants to add
* @see com.vaadin.flow.component.shared.HasThemeVariant#addThemeVariants(com.vaadin.flow.component.shared.ThemeVariant[])
*/
com.vaadin.flow.component.textfield.TextFieldVariant[] addThemeVariants() default {};
/**
* Get the value desired for the {@code title} property.
*
* @return desired {@code title} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setTitle(String)
*/
String title() default "";
/**
* Get the value desired for the {@code tooltipText} property.
*
* @return desired {@code tooltipText} property value
* @see com.vaadin.flow.component.shared.HasTooltip#setTooltipText(String)
*/
String tooltipText() default "";
/**
* Get the value desired for the {@code valueChangeMode} property.
*
* @return desired {@code valueChangeMode} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setValueChangeMode(com.vaadin.flow.data.value.ValueChangeMode)
*/
com.vaadin.flow.data.value.ValueChangeMode valueChangeMode() default com.vaadin.flow.data.value.ValueChangeMode.ON_CHANGE;
/**
* Get the value desired for the {@code valueChangeTimeout} property.
*
* @return desired {@code valueChangeTimeout} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setValueChangeTimeout(int)
*/
int valueChangeTimeout() default 400;
/**
* Get the value desired for the {@code visible} property.
*
* @return desired {@code visible} property value
* @see com.vaadin.flow.component.Component#setVisible(boolean)
*/
boolean visible() default true;
/**
* Get the value desired for the {@code width} property.
*
* @return desired {@code width} property value
* @see com.vaadin.flow.component.HasSize#setWidth(String)
*/
String width() default "";
}
/**
* Specifies how a Java bean property should be edited using an {@link com.vaadin.flow.component.textfield.EmailField}.
*
* @see FieldBuilder
* @see com.vaadin.flow.component.textfield.EmailField
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface EmailField {
/**
* Get the sub-type of {@link com.vaadin.flow.component.textfield.EmailField} that will edit the property.
*
*
* This property allows custom widget subclasses to be used.
*
*
* The specified type must have a public constructor that takes either no arguments,
* or one {@code FieldBuilderContext}.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.textfield.EmailField> implementation() default com.vaadin.flow.component.textfield.EmailField.class;
/**
* Specify CSS properties to be set via {@link com.vaadin.flow.dom.Style#set Style.set()}.
*
*
* The array value consists of name, value pairs. If the array has odd length, the last element is ignored.
*
* @return zero or more style property name, value pairs
* @see com.vaadin.flow.dom.Style
* @see com.vaadin.flow.component.HasStyle
*/
String[] styleProperties() default {};
/**
* Get the value desired for the {@code allowedCharPattern} property.
*
* @return desired {@code allowedCharPattern} property value
* @see com.vaadin.flow.component.shared.HasAllowedCharPattern#setAllowedCharPattern(String)
*/
String allowedCharPattern() default "";
/**
* Get the value desired for the {@code ariaLabel} property.
*
* @return desired {@code ariaLabel} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setAriaLabel(String)
*/
String ariaLabel() default "";
/**
* Get the value desired for the {@code ariaLabelledBy} property.
*
* @return desired {@code ariaLabelledBy} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setAriaLabelledBy(String)
*/
String ariaLabelledBy() default "";
/**
* Get the value desired for the {@code autocapitalize} property.
*
* @return desired {@code autocapitalize} property value
* @see com.vaadin.flow.component.textfield.HasAutocapitalize#setAutocapitalize(com.vaadin.flow.component.textfield.Autocapitalize)
*/
com.vaadin.flow.component.textfield.Autocapitalize autocapitalize() default com.vaadin.flow.component.textfield.Autocapitalize.NONE;
/**
* Get the value desired for the {@code autocomplete} property.
*
* @return desired {@code autocomplete} property value
* @see com.vaadin.flow.component.textfield.HasAutocomplete#setAutocomplete(com.vaadin.flow.component.textfield.Autocomplete)
*/
com.vaadin.flow.component.textfield.Autocomplete autocomplete() default com.vaadin.flow.component.textfield.Autocomplete.ON;
/**
* Get the value desired for the {@code autocorrect} property.
*
* @return desired {@code autocorrect} property value
* @see com.vaadin.flow.component.textfield.HasAutocorrect#setAutocorrect(boolean)
*/
boolean autocorrect() default false;
/**
* Get the value desired for the {@code autofocus} property.
*
* @return desired {@code autofocus} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setAutofocus(boolean)
*/
boolean autofocus() default false;
/**
* Get the value desired for the {@code autoselect} property.
*
* @return desired {@code autoselect} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setAutoselect(boolean)
*/
boolean autoselect() default false;
/**
* Add the specified class names.
*
* @return zero or more class names to add
* @see com.vaadin.flow.component.HasStyle#addClassNames(String[])
*/
String[] addClassNames() default {};
/**
* Get the value desired for the {@code clearButtonVisible} property.
*
* @return desired {@code clearButtonVisible} property value
* @see com.vaadin.flow.component.shared.HasClearButton#setClearButtonVisible(boolean)
*/
boolean clearButtonVisible() default false;
/**
* Get the value desired for the {@code enabled} property.
*
* @return desired {@code enabled} property value
* @see com.vaadin.flow.component.HasEnabled#setEnabled(boolean)
*/
boolean enabled() default true;
/**
* Get the value desired for the {@code errorMessage} property.
*
* @return desired {@code errorMessage} property value
* @see com.vaadin.flow.component.shared.HasValidationProperties#setErrorMessage(String)
*/
String errorMessage() default "";
/**
* Get the value desired for the {@code height} property.
*
* @return desired {@code height} property value
* @see com.vaadin.flow.component.HasSize#setHeight(String)
*/
String height() default "";
/**
* Get the class to instantiate for the {@code helperComponent} property.
*
* @return desired {@code helperComponent} property value type
* @see com.vaadin.flow.component.HasHelper#setHelperComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> helperComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code helperText} property.
*
* @return desired {@code helperText} property value
* @see com.vaadin.flow.component.HasHelper#setHelperText(String)
*/
String helperText() default "";
/**
* Get the value desired for the {@code id} property.
*
* @return desired {@code id} property value
* @see com.vaadin.flow.component.Component#setId(String)
*/
String id() default "";
/**
* Get the value desired for the {@code label} property.
*
* @return desired {@code label} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setLabel(String)
*/
String label() default "";
/**
* Get the value desired for the {@code manualValidation} property.
*
* @return desired {@code manualValidation} property value
* @see com.vaadin.flow.component.textfield.EmailField#setManualValidation(boolean)
*/
boolean manualValidation() default false;
/**
* Get the value desired for the {@code maxHeight} property.
*
* @return desired {@code maxHeight} property value
* @see com.vaadin.flow.component.HasSize#setMaxHeight(String)
*/
String maxHeight() default "";
/**
* Get the value desired for the {@code maxLength} property.
*
* @return desired {@code maxLength} property value
* @see com.vaadin.flow.component.textfield.EmailField#setMaxLength(int)
*/
int maxLength() default 0;
/**
* Get the value desired for the {@code maxWidth} property.
*
* @return desired {@code maxWidth} property value
* @see com.vaadin.flow.component.HasSize#setMaxWidth(String)
*/
String maxWidth() default "";
/**
* Get the value desired for the {@code minHeight} property.
*
* @return desired {@code minHeight} property value
* @see com.vaadin.flow.component.HasSize#setMinHeight(String)
*/
String minHeight() default "";
/**
* Get the value desired for the {@code minLength} property.
*
* @return desired {@code minLength} property value
* @see com.vaadin.flow.component.textfield.EmailField#setMinLength(int)
*/
int minLength() default 0;
/**
* Get the value desired for the {@code minWidth} property.
*
* @return desired {@code minWidth} property value
* @see com.vaadin.flow.component.HasSize#setMinWidth(String)
*/
String minWidth() default "";
/**
* Get the value desired for the {@code pattern} property.
*
* @return desired {@code pattern} property value
* @see com.vaadin.flow.component.textfield.EmailField#setPattern(String)
*/
String pattern() default "";
/**
* Get the value desired for the {@code placeholder} property.
*
* @return desired {@code placeholder} property value
* @see com.vaadin.flow.component.HasPlaceholder#setPlaceholder(String)
*/
String placeholder() default "";
/**
* Get the class to instantiate for the {@code prefixComponent} property.
*
* @return desired {@code prefixComponent} property value type
* @see com.vaadin.flow.component.shared.HasPrefix#setPrefixComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> prefixComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code readOnly} property.
*
* @return desired {@code readOnly} property value
* @see com.vaadin.flow.component.HasValueAndElement#setReadOnly(boolean)
*/
boolean readOnly() default false;
/**
* Get the value desired for the {@code required} property.
*
* @return desired {@code required} property value
* @see com.vaadin.flow.component.textfield.EmailField#setRequired(boolean)
*/
boolean required() default false;
/**
* Get the value desired for the {@code requiredIndicatorVisible} property.
*
* @return desired {@code requiredIndicatorVisible} property value
* @see com.vaadin.flow.component.textfield.EmailField#setRequiredIndicatorVisible(boolean)
*/
boolean requiredIndicatorVisible() default false;
/**
* Get the class to instantiate for the {@code suffixComponent} property.
*
* @return desired {@code suffixComponent} property value type
* @see com.vaadin.flow.component.shared.HasSuffix#setSuffixComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> suffixComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code tabIndex} property.
*
* @return desired {@code tabIndex} property value
* @see com.vaadin.flow.component.Focusable#setTabIndex(int)
*/
int tabIndex() default 0;
/**
* Add the specified theme names.
*
* @return zero or more theme names to add
* @see com.vaadin.flow.component.HasTheme#addThemeNames(String[])
*/
String[] addThemeNames() default {};
/**
* Add the specified theme variants.
*
* @return zero or more theme variants to add
* @see com.vaadin.flow.component.shared.HasThemeVariant#addThemeVariants(com.vaadin.flow.component.shared.ThemeVariant[])
*/
com.vaadin.flow.component.textfield.TextFieldVariant[] addThemeVariants() default {};
/**
* Get the value desired for the {@code title} property.
*
* @return desired {@code title} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setTitle(String)
*/
String title() default "";
/**
* Get the value desired for the {@code tooltipText} property.
*
* @return desired {@code tooltipText} property value
* @see com.vaadin.flow.component.shared.HasTooltip#setTooltipText(String)
*/
String tooltipText() default "";
/**
* Get the value desired for the {@code valueChangeMode} property.
*
* @return desired {@code valueChangeMode} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setValueChangeMode(com.vaadin.flow.data.value.ValueChangeMode)
*/
com.vaadin.flow.data.value.ValueChangeMode valueChangeMode() default com.vaadin.flow.data.value.ValueChangeMode.ON_CHANGE;
/**
* Get the value desired for the {@code valueChangeTimeout} property.
*
* @return desired {@code valueChangeTimeout} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setValueChangeTimeout(int)
*/
int valueChangeTimeout() default 400;
/**
* Get the value desired for the {@code visible} property.
*
* @return desired {@code visible} property value
* @see com.vaadin.flow.component.Component#setVisible(boolean)
*/
boolean visible() default true;
/**
* Get the value desired for the {@code width} property.
*
* @return desired {@code width} property value
* @see com.vaadin.flow.component.HasSize#setWidth(String)
*/
String width() default "";
}
/**
* Specifies how a Java bean property should be edited using an {@link com.vaadin.flow.component.textfield.IntegerField}.
*
* @see FieldBuilder
* @see com.vaadin.flow.component.textfield.IntegerField
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface IntegerField {
/**
* Get the sub-type of {@link com.vaadin.flow.component.textfield.IntegerField} that will edit the property.
*
*
* This property allows custom widget subclasses to be used.
*
*
* The specified type must have a public constructor that takes either no arguments,
* or one {@code FieldBuilderContext}.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.textfield.IntegerField> implementation() default com.vaadin.flow.component.textfield.IntegerField.class;
/**
* Specify CSS properties to be set via {@link com.vaadin.flow.dom.Style#set Style.set()}.
*
*
* The array value consists of name, value pairs. If the array has odd length, the last element is ignored.
*
* @return zero or more style property name, value pairs
* @see com.vaadin.flow.dom.Style
* @see com.vaadin.flow.component.HasStyle
*/
String[] styleProperties() default {};
/**
* Get the value desired for the {@code ariaLabel} property.
*
* @return desired {@code ariaLabel} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setAriaLabel(String)
*/
String ariaLabel() default "";
/**
* Get the value desired for the {@code ariaLabelledBy} property.
*
* @return desired {@code ariaLabelledBy} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setAriaLabelledBy(String)
*/
String ariaLabelledBy() default "";
/**
* Get the value desired for the {@code autocapitalize} property.
*
* @return desired {@code autocapitalize} property value
* @see com.vaadin.flow.component.textfield.HasAutocapitalize#setAutocapitalize(com.vaadin.flow.component.textfield.Autocapitalize)
*/
com.vaadin.flow.component.textfield.Autocapitalize autocapitalize() default com.vaadin.flow.component.textfield.Autocapitalize.NONE;
/**
* Get the value desired for the {@code autocomplete} property.
*
* @return desired {@code autocomplete} property value
* @see com.vaadin.flow.component.textfield.HasAutocomplete#setAutocomplete(com.vaadin.flow.component.textfield.Autocomplete)
*/
com.vaadin.flow.component.textfield.Autocomplete autocomplete() default com.vaadin.flow.component.textfield.Autocomplete.ON;
/**
* Get the value desired for the {@code autocorrect} property.
*
* @return desired {@code autocorrect} property value
* @see com.vaadin.flow.component.textfield.HasAutocorrect#setAutocorrect(boolean)
*/
boolean autocorrect() default false;
/**
* Get the value desired for the {@code autofocus} property.
*
* @return desired {@code autofocus} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setAutofocus(boolean)
*/
boolean autofocus() default false;
/**
* Get the value desired for the {@code autoselect} property.
*
* @return desired {@code autoselect} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setAutoselect(boolean)
*/
boolean autoselect() default false;
/**
* Add the specified class names.
*
* @return zero or more class names to add
* @see com.vaadin.flow.component.HasStyle#addClassNames(String[])
*/
String[] addClassNames() default {};
/**
* Get the value desired for the {@code clearButtonVisible} property.
*
* @return desired {@code clearButtonVisible} property value
* @see com.vaadin.flow.component.shared.HasClearButton#setClearButtonVisible(boolean)
*/
boolean clearButtonVisible() default false;
/**
* Get the value desired for the {@code enabled} property.
*
* @return desired {@code enabled} property value
* @see com.vaadin.flow.component.HasEnabled#setEnabled(boolean)
*/
boolean enabled() default true;
/**
* Get the value desired for the {@code errorMessage} property.
*
* @return desired {@code errorMessage} property value
* @see com.vaadin.flow.component.shared.HasValidationProperties#setErrorMessage(String)
*/
String errorMessage() default "";
/**
* Get the value desired for the {@code height} property.
*
* @return desired {@code height} property value
* @see com.vaadin.flow.component.HasSize#setHeight(String)
*/
String height() default "";
/**
* Get the class to instantiate for the {@code helperComponent} property.
*
* @return desired {@code helperComponent} property value type
* @see com.vaadin.flow.component.HasHelper#setHelperComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> helperComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code helperText} property.
*
* @return desired {@code helperText} property value
* @see com.vaadin.flow.component.HasHelper#setHelperText(String)
*/
String helperText() default "";
/**
* Get the value desired for the {@code id} property.
*
* @return desired {@code id} property value
* @see com.vaadin.flow.component.Component#setId(String)
*/
String id() default "";
/**
* Get the value desired for the {@code label} property.
*
* @return desired {@code label} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setLabel(String)
*/
String label() default "";
/**
* Get the value desired for the {@code manualValidation} property.
*
* @return desired {@code manualValidation} property value
* @see com.vaadin.flow.component.textfield.AbstractNumberField#setManualValidation(boolean)
*/
boolean manualValidation() default false;
/**
* Get the value desired for the {@code max} property.
*
* @return desired {@code max} property value
* @see com.vaadin.flow.component.textfield.IntegerField#setMax(int)
*/
int max() default 2147483647;
/**
* Get the value desired for the {@code maxHeight} property.
*
* @return desired {@code maxHeight} property value
* @see com.vaadin.flow.component.HasSize#setMaxHeight(String)
*/
String maxHeight() default "";
/**
* Get the value desired for the {@code maxWidth} property.
*
* @return desired {@code maxWidth} property value
* @see com.vaadin.flow.component.HasSize#setMaxWidth(String)
*/
String maxWidth() default "";
/**
* Get the value desired for the {@code min} property.
*
* @return desired {@code min} property value
* @see com.vaadin.flow.component.textfield.IntegerField#setMin(int)
*/
int min() default -2147483648;
/**
* Get the value desired for the {@code minHeight} property.
*
* @return desired {@code minHeight} property value
* @see com.vaadin.flow.component.HasSize#setMinHeight(String)
*/
String minHeight() default "";
/**
* Get the value desired for the {@code minWidth} property.
*
* @return desired {@code minWidth} property value
* @see com.vaadin.flow.component.HasSize#setMinWidth(String)
*/
String minWidth() default "";
/**
* Get the value desired for the {@code placeholder} property.
*
* @return desired {@code placeholder} property value
* @see com.vaadin.flow.component.HasPlaceholder#setPlaceholder(String)
*/
String placeholder() default "";
/**
* Get the class to instantiate for the {@code prefixComponent} property.
*
* @return desired {@code prefixComponent} property value type
* @see com.vaadin.flow.component.shared.HasPrefix#setPrefixComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> prefixComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code readOnly} property.
*
* @return desired {@code readOnly} property value
* @see com.vaadin.flow.component.HasValueAndElement#setReadOnly(boolean)
*/
boolean readOnly() default false;
/**
* Get the value desired for the {@code required} property.
*
* @return desired {@code required} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setRequired(boolean)
*/
boolean required() default false;
/**
* Get the value desired for the {@code requiredIndicatorVisible} property.
*
* @return desired {@code requiredIndicatorVisible} property value
* @see com.vaadin.flow.component.textfield.AbstractNumberField#setRequiredIndicatorVisible(boolean)
*/
boolean requiredIndicatorVisible() default false;
/**
* Get the value desired for the {@code step} property.
*
* @return desired {@code step} property value
* @see com.vaadin.flow.component.textfield.IntegerField#setStep(int)
*/
int step() default 1;
/**
* Get the value desired for the {@code stepButtonsVisible} property.
*
* @return desired {@code stepButtonsVisible} property value
* @see com.vaadin.flow.component.textfield.AbstractNumberField#setStepButtonsVisible(boolean)
*/
boolean stepButtonsVisible() default false;
/**
* Get the class to instantiate for the {@code suffixComponent} property.
*
* @return desired {@code suffixComponent} property value type
* @see com.vaadin.flow.component.shared.HasSuffix#setSuffixComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> suffixComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code tabIndex} property.
*
* @return desired {@code tabIndex} property value
* @see com.vaadin.flow.component.Focusable#setTabIndex(int)
*/
int tabIndex() default 0;
/**
* Add the specified theme names.
*
* @return zero or more theme names to add
* @see com.vaadin.flow.component.HasTheme#addThemeNames(String[])
*/
String[] addThemeNames() default {};
/**
* Add the specified theme variants.
*
* @return zero or more theme variants to add
* @see com.vaadin.flow.component.shared.HasThemeVariant#addThemeVariants(com.vaadin.flow.component.shared.ThemeVariant[])
*/
com.vaadin.flow.component.textfield.TextFieldVariant[] addThemeVariants() default {};
/**
* Get the value desired for the {@code title} property.
*
* @return desired {@code title} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setTitle(String)
*/
String title() default "";
/**
* Get the value desired for the {@code tooltipText} property.
*
* @return desired {@code tooltipText} property value
* @see com.vaadin.flow.component.shared.HasTooltip#setTooltipText(String)
*/
String tooltipText() default "";
/**
* Get the value desired for the {@code valueChangeMode} property.
*
* @return desired {@code valueChangeMode} property value
* @see com.vaadin.flow.component.textfield.AbstractNumberField#setValueChangeMode(com.vaadin.flow.data.value.ValueChangeMode)
*/
com.vaadin.flow.data.value.ValueChangeMode valueChangeMode() default com.vaadin.flow.data.value.ValueChangeMode.ON_CHANGE;
/**
* Get the value desired for the {@code valueChangeTimeout} property.
*
* @return desired {@code valueChangeTimeout} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setValueChangeTimeout(int)
*/
int valueChangeTimeout() default 400;
/**
* Get the value desired for the {@code visible} property.
*
* @return desired {@code visible} property value
* @see com.vaadin.flow.component.Component#setVisible(boolean)
*/
boolean visible() default true;
/**
* Get the value desired for the {@code width} property.
*
* @return desired {@code width} property value
* @see com.vaadin.flow.component.HasSize#setWidth(String)
*/
String width() default "";
}
/**
* Specifies how a Java bean property should be edited using a {@link com.vaadin.flow.component.textfield.NumberField}.
*
* @see FieldBuilder
* @see com.vaadin.flow.component.textfield.NumberField
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface NumberField {
/**
* Get the sub-type of {@link com.vaadin.flow.component.textfield.NumberField} that will edit the property.
*
*
* This property allows custom widget subclasses to be used.
*
*
* The specified type must have a public constructor that takes either no arguments,
* or one {@code FieldBuilderContext}.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.textfield.NumberField> implementation() default com.vaadin.flow.component.textfield.NumberField.class;
/**
* Specify CSS properties to be set via {@link com.vaadin.flow.dom.Style#set Style.set()}.
*
*
* The array value consists of name, value pairs. If the array has odd length, the last element is ignored.
*
* @return zero or more style property name, value pairs
* @see com.vaadin.flow.dom.Style
* @see com.vaadin.flow.component.HasStyle
*/
String[] styleProperties() default {};
/**
* Get the value desired for the {@code allowedCharPattern} property.
*
* @return desired {@code allowedCharPattern} property value
* @see com.vaadin.flow.component.shared.HasAllowedCharPattern#setAllowedCharPattern(String)
*/
String allowedCharPattern() default "";
/**
* Get the value desired for the {@code ariaLabel} property.
*
* @return desired {@code ariaLabel} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setAriaLabel(String)
*/
String ariaLabel() default "";
/**
* Get the value desired for the {@code ariaLabelledBy} property.
*
* @return desired {@code ariaLabelledBy} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setAriaLabelledBy(String)
*/
String ariaLabelledBy() default "";
/**
* Get the value desired for the {@code autocapitalize} property.
*
* @return desired {@code autocapitalize} property value
* @see com.vaadin.flow.component.textfield.HasAutocapitalize#setAutocapitalize(com.vaadin.flow.component.textfield.Autocapitalize)
*/
com.vaadin.flow.component.textfield.Autocapitalize autocapitalize() default com.vaadin.flow.component.textfield.Autocapitalize.NONE;
/**
* Get the value desired for the {@code autocomplete} property.
*
* @return desired {@code autocomplete} property value
* @see com.vaadin.flow.component.textfield.HasAutocomplete#setAutocomplete(com.vaadin.flow.component.textfield.Autocomplete)
*/
com.vaadin.flow.component.textfield.Autocomplete autocomplete() default com.vaadin.flow.component.textfield.Autocomplete.ON;
/**
* Get the value desired for the {@code autocorrect} property.
*
* @return desired {@code autocorrect} property value
* @see com.vaadin.flow.component.textfield.HasAutocorrect#setAutocorrect(boolean)
*/
boolean autocorrect() default false;
/**
* Get the value desired for the {@code autofocus} property.
*
* @return desired {@code autofocus} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setAutofocus(boolean)
*/
boolean autofocus() default false;
/**
* Get the value desired for the {@code autoselect} property.
*
* @return desired {@code autoselect} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setAutoselect(boolean)
*/
boolean autoselect() default false;
/**
* Add the specified class names.
*
* @return zero or more class names to add
* @see com.vaadin.flow.component.HasStyle#addClassNames(String[])
*/
String[] addClassNames() default {};
/**
* Get the value desired for the {@code clearButtonVisible} property.
*
* @return desired {@code clearButtonVisible} property value
* @see com.vaadin.flow.component.shared.HasClearButton#setClearButtonVisible(boolean)
*/
boolean clearButtonVisible() default false;
/**
* Get the value desired for the {@code enabled} property.
*
* @return desired {@code enabled} property value
* @see com.vaadin.flow.component.HasEnabled#setEnabled(boolean)
*/
boolean enabled() default true;
/**
* Get the value desired for the {@code errorMessage} property.
*
* @return desired {@code errorMessage} property value
* @see com.vaadin.flow.component.shared.HasValidationProperties#setErrorMessage(String)
*/
String errorMessage() default "";
/**
* Get the value desired for the {@code height} property.
*
* @return desired {@code height} property value
* @see com.vaadin.flow.component.HasSize#setHeight(String)
*/
String height() default "";
/**
* Get the class to instantiate for the {@code helperComponent} property.
*
* @return desired {@code helperComponent} property value type
* @see com.vaadin.flow.component.HasHelper#setHelperComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> helperComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code helperText} property.
*
* @return desired {@code helperText} property value
* @see com.vaadin.flow.component.HasHelper#setHelperText(String)
*/
String helperText() default "";
/**
* Get the value desired for the {@code id} property.
*
* @return desired {@code id} property value
* @see com.vaadin.flow.component.Component#setId(String)
*/
String id() default "";
/**
* Get the value desired for the {@code label} property.
*
* @return desired {@code label} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setLabel(String)
*/
String label() default "";
/**
* Get the value desired for the {@code manualValidation} property.
*
* @return desired {@code manualValidation} property value
* @see com.vaadin.flow.component.textfield.AbstractNumberField#setManualValidation(boolean)
*/
boolean manualValidation() default false;
/**
* Get the value desired for the {@code max} property.
*
* @return desired {@code max} property value
* @see com.vaadin.flow.component.textfield.NumberField#setMax(double)
*/
double max() default Double.POSITIVE_INFINITY;
/**
* Get the value desired for the {@code maxHeight} property.
*
* @return desired {@code maxHeight} property value
* @see com.vaadin.flow.component.HasSize#setMaxHeight(String)
*/
String maxHeight() default "";
/**
* Get the value desired for the {@code maxWidth} property.
*
* @return desired {@code maxWidth} property value
* @see com.vaadin.flow.component.HasSize#setMaxWidth(String)
*/
String maxWidth() default "";
/**
* Get the value desired for the {@code min} property.
*
* @return desired {@code min} property value
* @see com.vaadin.flow.component.textfield.NumberField#setMin(double)
*/
double min() default Double.NEGATIVE_INFINITY;
/**
* Get the value desired for the {@code minHeight} property.
*
* @return desired {@code minHeight} property value
* @see com.vaadin.flow.component.HasSize#setMinHeight(String)
*/
String minHeight() default "";
/**
* Get the value desired for the {@code minWidth} property.
*
* @return desired {@code minWidth} property value
* @see com.vaadin.flow.component.HasSize#setMinWidth(String)
*/
String minWidth() default "";
/**
* Get the value desired for the {@code placeholder} property.
*
* @return desired {@code placeholder} property value
* @see com.vaadin.flow.component.HasPlaceholder#setPlaceholder(String)
*/
String placeholder() default "";
/**
* Get the class to instantiate for the {@code prefixComponent} property.
*
* @return desired {@code prefixComponent} property value type
* @see com.vaadin.flow.component.shared.HasPrefix#setPrefixComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> prefixComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code readOnly} property.
*
* @return desired {@code readOnly} property value
* @see com.vaadin.flow.component.HasValueAndElement#setReadOnly(boolean)
*/
boolean readOnly() default false;
/**
* Get the value desired for the {@code required} property.
*
* @return desired {@code required} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setRequired(boolean)
*/
boolean required() default false;
/**
* Get the value desired for the {@code requiredIndicatorVisible} property.
*
* @return desired {@code requiredIndicatorVisible} property value
* @see com.vaadin.flow.component.textfield.AbstractNumberField#setRequiredIndicatorVisible(boolean)
*/
boolean requiredIndicatorVisible() default false;
/**
* Get the value desired for the {@code step} property.
*
* @return desired {@code step} property value
* @see com.vaadin.flow.component.textfield.NumberField#setStep(double)
*/
double step() default 1.0;
/**
* Get the value desired for the {@code stepButtonsVisible} property.
*
* @return desired {@code stepButtonsVisible} property value
* @see com.vaadin.flow.component.textfield.AbstractNumberField#setStepButtonsVisible(boolean)
*/
boolean stepButtonsVisible() default false;
/**
* Get the class to instantiate for the {@code suffixComponent} property.
*
* @return desired {@code suffixComponent} property value type
* @see com.vaadin.flow.component.shared.HasSuffix#setSuffixComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> suffixComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code tabIndex} property.
*
* @return desired {@code tabIndex} property value
* @see com.vaadin.flow.component.Focusable#setTabIndex(int)
*/
int tabIndex() default 0;
/**
* Add the specified theme names.
*
* @return zero or more theme names to add
* @see com.vaadin.flow.component.HasTheme#addThemeNames(String[])
*/
String[] addThemeNames() default {};
/**
* Add the specified theme variants.
*
* @return zero or more theme variants to add
* @see com.vaadin.flow.component.shared.HasThemeVariant#addThemeVariants(com.vaadin.flow.component.shared.ThemeVariant[])
*/
com.vaadin.flow.component.textfield.TextFieldVariant[] addThemeVariants() default {};
/**
* Get the value desired for the {@code title} property.
*
* @return desired {@code title} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setTitle(String)
*/
String title() default "";
/**
* Get the value desired for the {@code tooltipText} property.
*
* @return desired {@code tooltipText} property value
* @see com.vaadin.flow.component.shared.HasTooltip#setTooltipText(String)
*/
String tooltipText() default "";
/**
* Get the value desired for the {@code valueChangeMode} property.
*
* @return desired {@code valueChangeMode} property value
* @see com.vaadin.flow.component.textfield.AbstractNumberField#setValueChangeMode(com.vaadin.flow.data.value.ValueChangeMode)
*/
com.vaadin.flow.data.value.ValueChangeMode valueChangeMode() default com.vaadin.flow.data.value.ValueChangeMode.ON_CHANGE;
/**
* Get the value desired for the {@code valueChangeTimeout} property.
*
* @return desired {@code valueChangeTimeout} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setValueChangeTimeout(int)
*/
int valueChangeTimeout() default 400;
/**
* Get the value desired for the {@code visible} property.
*
* @return desired {@code visible} property value
* @see com.vaadin.flow.component.Component#setVisible(boolean)
*/
boolean visible() default true;
/**
* Get the value desired for the {@code width} property.
*
* @return desired {@code width} property value
* @see com.vaadin.flow.component.HasSize#setWidth(String)
*/
String width() default "";
}
/**
* Specifies how a Java bean property should be edited using a {@link com.vaadin.flow.component.textfield.PasswordField}.
*
* @see FieldBuilder
* @see com.vaadin.flow.component.textfield.PasswordField
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface PasswordField {
/**
* Get the sub-type of {@link com.vaadin.flow.component.textfield.PasswordField} that will edit the property.
*
*
* This property allows custom widget subclasses to be used.
*
*
* The specified type must have a public constructor that takes either no arguments,
* or one {@code FieldBuilderContext}.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.textfield.PasswordField> implementation() default com.vaadin.flow.component.textfield.PasswordField.class;
/**
* Specify CSS properties to be set via {@link com.vaadin.flow.dom.Style#set Style.set()}.
*
*
* The array value consists of name, value pairs. If the array has odd length, the last element is ignored.
*
* @return zero or more style property name, value pairs
* @see com.vaadin.flow.dom.Style
* @see com.vaadin.flow.component.HasStyle
*/
String[] styleProperties() default {};
/**
* Get the value desired for the {@code allowedCharPattern} property.
*
* @return desired {@code allowedCharPattern} property value
* @see com.vaadin.flow.component.shared.HasAllowedCharPattern#setAllowedCharPattern(String)
*/
String allowedCharPattern() default "";
/**
* Get the value desired for the {@code ariaLabel} property.
*
* @return desired {@code ariaLabel} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setAriaLabel(String)
*/
String ariaLabel() default "";
/**
* Get the value desired for the {@code ariaLabelledBy} property.
*
* @return desired {@code ariaLabelledBy} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setAriaLabelledBy(String)
*/
String ariaLabelledBy() default "";
/**
* Get the value desired for the {@code autocapitalize} property.
*
* @return desired {@code autocapitalize} property value
* @see com.vaadin.flow.component.textfield.HasAutocapitalize#setAutocapitalize(com.vaadin.flow.component.textfield.Autocapitalize)
*/
com.vaadin.flow.component.textfield.Autocapitalize autocapitalize() default com.vaadin.flow.component.textfield.Autocapitalize.NONE;
/**
* Get the value desired for the {@code autocomplete} property.
*
* @return desired {@code autocomplete} property value
* @see com.vaadin.flow.component.textfield.HasAutocomplete#setAutocomplete(com.vaadin.flow.component.textfield.Autocomplete)
*/
com.vaadin.flow.component.textfield.Autocomplete autocomplete() default com.vaadin.flow.component.textfield.Autocomplete.ON;
/**
* Get the value desired for the {@code autocorrect} property.
*
* @return desired {@code autocorrect} property value
* @see com.vaadin.flow.component.textfield.HasAutocorrect#setAutocorrect(boolean)
*/
boolean autocorrect() default false;
/**
* Get the value desired for the {@code autofocus} property.
*
* @return desired {@code autofocus} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setAutofocus(boolean)
*/
boolean autofocus() default false;
/**
* Get the value desired for the {@code autoselect} property.
*
* @return desired {@code autoselect} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setAutoselect(boolean)
*/
boolean autoselect() default false;
/**
* Add the specified class names.
*
* @return zero or more class names to add
* @see com.vaadin.flow.component.HasStyle#addClassNames(String[])
*/
String[] addClassNames() default {};
/**
* Get the value desired for the {@code clearButtonVisible} property.
*
* @return desired {@code clearButtonVisible} property value
* @see com.vaadin.flow.component.shared.HasClearButton#setClearButtonVisible(boolean)
*/
boolean clearButtonVisible() default false;
/**
* Get the value desired for the {@code enabled} property.
*
* @return desired {@code enabled} property value
* @see com.vaadin.flow.component.HasEnabled#setEnabled(boolean)
*/
boolean enabled() default true;
/**
* Get the value desired for the {@code errorMessage} property.
*
* @return desired {@code errorMessage} property value
* @see com.vaadin.flow.component.shared.HasValidationProperties#setErrorMessage(String)
*/
String errorMessage() default "";
/**
* Get the value desired for the {@code height} property.
*
* @return desired {@code height} property value
* @see com.vaadin.flow.component.HasSize#setHeight(String)
*/
String height() default "";
/**
* Get the class to instantiate for the {@code helperComponent} property.
*
* @return desired {@code helperComponent} property value type
* @see com.vaadin.flow.component.HasHelper#setHelperComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> helperComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code helperText} property.
*
* @return desired {@code helperText} property value
* @see com.vaadin.flow.component.HasHelper#setHelperText(String)
*/
String helperText() default "";
/**
* Get the value desired for the {@code id} property.
*
* @return desired {@code id} property value
* @see com.vaadin.flow.component.Component#setId(String)
*/
String id() default "";
/**
* Get the value desired for the {@code label} property.
*
* @return desired {@code label} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setLabel(String)
*/
String label() default "";
/**
* Get the value desired for the {@code manualValidation} property.
*
* @return desired {@code manualValidation} property value
* @see com.vaadin.flow.component.textfield.PasswordField#setManualValidation(boolean)
*/
boolean manualValidation() default false;
/**
* Get the value desired for the {@code maxHeight} property.
*
* @return desired {@code maxHeight} property value
* @see com.vaadin.flow.component.HasSize#setMaxHeight(String)
*/
String maxHeight() default "";
/**
* Get the value desired for the {@code maxLength} property.
*
* @return desired {@code maxLength} property value
* @see com.vaadin.flow.component.textfield.PasswordField#setMaxLength(int)
*/
int maxLength() default 0;
/**
* Get the value desired for the {@code maxWidth} property.
*
* @return desired {@code maxWidth} property value
* @see com.vaadin.flow.component.HasSize#setMaxWidth(String)
*/
String maxWidth() default "";
/**
* Get the value desired for the {@code minHeight} property.
*
* @return desired {@code minHeight} property value
* @see com.vaadin.flow.component.HasSize#setMinHeight(String)
*/
String minHeight() default "";
/**
* Get the value desired for the {@code minLength} property.
*
* @return desired {@code minLength} property value
* @see com.vaadin.flow.component.textfield.PasswordField#setMinLength(int)
*/
int minLength() default 0;
/**
* Get the value desired for the {@code minWidth} property.
*
* @return desired {@code minWidth} property value
* @see com.vaadin.flow.component.HasSize#setMinWidth(String)
*/
String minWidth() default "";
/**
* Get the value desired for the {@code pattern} property.
*
* @return desired {@code pattern} property value
* @see com.vaadin.flow.component.textfield.PasswordField#setPattern(String)
*/
String pattern() default "";
/**
* Get the value desired for the {@code placeholder} property.
*
* @return desired {@code placeholder} property value
* @see com.vaadin.flow.component.HasPlaceholder#setPlaceholder(String)
*/
String placeholder() default "";
/**
* Get the class to instantiate for the {@code prefixComponent} property.
*
* @return desired {@code prefixComponent} property value type
* @see com.vaadin.flow.component.shared.HasPrefix#setPrefixComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> prefixComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code readOnly} property.
*
* @return desired {@code readOnly} property value
* @see com.vaadin.flow.component.HasValueAndElement#setReadOnly(boolean)
*/
boolean readOnly() default false;
/**
* Get the value desired for the {@code required} property.
*
* @return desired {@code required} property value
* @see com.vaadin.flow.component.textfield.PasswordField#setRequired(boolean)
*/
boolean required() default false;
/**
* Get the value desired for the {@code requiredIndicatorVisible} property.
*
* @return desired {@code requiredIndicatorVisible} property value
* @see com.vaadin.flow.component.textfield.PasswordField#setRequiredIndicatorVisible(boolean)
*/
boolean requiredIndicatorVisible() default false;
/**
* Get the value desired for the {@code revealButtonVisible} property.
*
* @return desired {@code revealButtonVisible} property value
* @see com.vaadin.flow.component.textfield.PasswordField#setRevealButtonVisible(boolean)
*/
boolean revealButtonVisible() default true;
/**
* Get the class to instantiate for the {@code suffixComponent} property.
*
* @return desired {@code suffixComponent} property value type
* @see com.vaadin.flow.component.shared.HasSuffix#setSuffixComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> suffixComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code tabIndex} property.
*
* @return desired {@code tabIndex} property value
* @see com.vaadin.flow.component.Focusable#setTabIndex(int)
*/
int tabIndex() default 0;
/**
* Add the specified theme names.
*
* @return zero or more theme names to add
* @see com.vaadin.flow.component.HasTheme#addThemeNames(String[])
*/
String[] addThemeNames() default {};
/**
* Add the specified theme variants.
*
* @return zero or more theme variants to add
* @see com.vaadin.flow.component.shared.HasThemeVariant#addThemeVariants(com.vaadin.flow.component.shared.ThemeVariant[])
*/
com.vaadin.flow.component.textfield.TextFieldVariant[] addThemeVariants() default {};
/**
* Get the value desired for the {@code title} property.
*
* @return desired {@code title} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setTitle(String)
*/
String title() default "";
/**
* Get the value desired for the {@code tooltipText} property.
*
* @return desired {@code tooltipText} property value
* @see com.vaadin.flow.component.shared.HasTooltip#setTooltipText(String)
*/
String tooltipText() default "";
/**
* Get the value desired for the {@code valueChangeMode} property.
*
* @return desired {@code valueChangeMode} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setValueChangeMode(com.vaadin.flow.data.value.ValueChangeMode)
*/
com.vaadin.flow.data.value.ValueChangeMode valueChangeMode() default com.vaadin.flow.data.value.ValueChangeMode.ON_CHANGE;
/**
* Get the value desired for the {@code valueChangeTimeout} property.
*
* @return desired {@code valueChangeTimeout} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setValueChangeTimeout(int)
*/
int valueChangeTimeout() default 400;
/**
* Get the value desired for the {@code visible} property.
*
* @return desired {@code visible} property value
* @see com.vaadin.flow.component.Component#setVisible(boolean)
*/
boolean visible() default true;
/**
* Get the value desired for the {@code width} property.
*
* @return desired {@code width} property value
* @see com.vaadin.flow.component.HasSize#setWidth(String)
*/
String width() default "";
}
/**
* Specifies how a Java bean property should be edited using a {@link com.vaadin.flow.component.textfield.TextArea}.
*
* @see FieldBuilder
* @see com.vaadin.flow.component.textfield.TextArea
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface TextArea {
/**
* Get the sub-type of {@link com.vaadin.flow.component.textfield.TextArea} that will edit the property.
*
*
* This property allows custom widget subclasses to be used.
*
*
* The specified type must have a public constructor that takes either no arguments,
* or one {@code FieldBuilderContext}.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.textfield.TextArea> implementation() default com.vaadin.flow.component.textfield.TextArea.class;
/**
* Specify CSS properties to be set via {@link com.vaadin.flow.dom.Style#set Style.set()}.
*
*
* The array value consists of name, value pairs. If the array has odd length, the last element is ignored.
*
* @return zero or more style property name, value pairs
* @see com.vaadin.flow.dom.Style
* @see com.vaadin.flow.component.HasStyle
*/
String[] styleProperties() default {};
/**
* Get the value desired for the {@code allowedCharPattern} property.
*
* @return desired {@code allowedCharPattern} property value
* @see com.vaadin.flow.component.shared.HasAllowedCharPattern#setAllowedCharPattern(String)
*/
String allowedCharPattern() default "";
/**
* Get the value desired for the {@code ariaLabel} property.
*
* @return desired {@code ariaLabel} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setAriaLabel(String)
*/
String ariaLabel() default "";
/**
* Get the value desired for the {@code ariaLabelledBy} property.
*
* @return desired {@code ariaLabelledBy} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setAriaLabelledBy(String)
*/
String ariaLabelledBy() default "";
/**
* Get the value desired for the {@code autocapitalize} property.
*
* @return desired {@code autocapitalize} property value
* @see com.vaadin.flow.component.textfield.HasAutocapitalize#setAutocapitalize(com.vaadin.flow.component.textfield.Autocapitalize)
*/
com.vaadin.flow.component.textfield.Autocapitalize autocapitalize() default com.vaadin.flow.component.textfield.Autocapitalize.NONE;
/**
* Get the value desired for the {@code autocomplete} property.
*
* @return desired {@code autocomplete} property value
* @see com.vaadin.flow.component.textfield.HasAutocomplete#setAutocomplete(com.vaadin.flow.component.textfield.Autocomplete)
*/
com.vaadin.flow.component.textfield.Autocomplete autocomplete() default com.vaadin.flow.component.textfield.Autocomplete.ON;
/**
* Get the value desired for the {@code autocorrect} property.
*
* @return desired {@code autocorrect} property value
* @see com.vaadin.flow.component.textfield.HasAutocorrect#setAutocorrect(boolean)
*/
boolean autocorrect() default false;
/**
* Get the value desired for the {@code autofocus} property.
*
* @return desired {@code autofocus} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setAutofocus(boolean)
*/
boolean autofocus() default false;
/**
* Get the value desired for the {@code autoselect} property.
*
* @return desired {@code autoselect} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setAutoselect(boolean)
*/
boolean autoselect() default false;
/**
* Add the specified class names.
*
* @return zero or more class names to add
* @see com.vaadin.flow.component.HasStyle#addClassNames(String[])
*/
String[] addClassNames() default {};
/**
* Get the value desired for the {@code clearButtonVisible} property.
*
* @return desired {@code clearButtonVisible} property value
* @see com.vaadin.flow.component.shared.HasClearButton#setClearButtonVisible(boolean)
*/
boolean clearButtonVisible() default false;
/**
* Get the value desired for the {@code enabled} property.
*
* @return desired {@code enabled} property value
* @see com.vaadin.flow.component.HasEnabled#setEnabled(boolean)
*/
boolean enabled() default true;
/**
* Get the value desired for the {@code errorMessage} property.
*
* @return desired {@code errorMessage} property value
* @see com.vaadin.flow.component.shared.HasValidationProperties#setErrorMessage(String)
*/
String errorMessage() default "";
/**
* Get the value desired for the {@code height} property.
*
* @return desired {@code height} property value
* @see com.vaadin.flow.component.HasSize#setHeight(String)
*/
String height() default "";
/**
* Get the class to instantiate for the {@code helperComponent} property.
*
* @return desired {@code helperComponent} property value type
* @see com.vaadin.flow.component.HasHelper#setHelperComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> helperComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code helperText} property.
*
* @return desired {@code helperText} property value
* @see com.vaadin.flow.component.HasHelper#setHelperText(String)
*/
String helperText() default "";
/**
* Get the value desired for the {@code id} property.
*
* @return desired {@code id} property value
* @see com.vaadin.flow.component.Component#setId(String)
*/
String id() default "";
/**
* Get the value desired for the {@code label} property.
*
* @return desired {@code label} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setLabel(String)
*/
String label() default "";
/**
* Get the value desired for the {@code manualValidation} property.
*
* @return desired {@code manualValidation} property value
* @see com.vaadin.flow.component.textfield.TextArea#setManualValidation(boolean)
*/
boolean manualValidation() default false;
/**
* Get the value desired for the {@code maxHeight} property.
*
* @return desired {@code maxHeight} property value
* @see com.vaadin.flow.component.HasSize#setMaxHeight(String)
*/
String maxHeight() default "";
/**
* Get the value desired for the {@code maxLength} property.
*
* @return desired {@code maxLength} property value
* @see com.vaadin.flow.component.textfield.TextArea#setMaxLength(int)
*/
int maxLength() default 0;
/**
* Get the value desired for the {@code maxWidth} property.
*
* @return desired {@code maxWidth} property value
* @see com.vaadin.flow.component.HasSize#setMaxWidth(String)
*/
String maxWidth() default "";
/**
* Get the value desired for the {@code minHeight} property.
*
* @return desired {@code minHeight} property value
* @see com.vaadin.flow.component.HasSize#setMinHeight(String)
*/
String minHeight() default "";
/**
* Get the value desired for the {@code minLength} property.
*
* @return desired {@code minLength} property value
* @see com.vaadin.flow.component.textfield.TextArea#setMinLength(int)
*/
int minLength() default 0;
/**
* Get the value desired for the {@code minWidth} property.
*
* @return desired {@code minWidth} property value
* @see com.vaadin.flow.component.HasSize#setMinWidth(String)
*/
String minWidth() default "";
/**
* Get the value desired for the {@code pattern} property.
*
* @return desired {@code pattern} property value
* @see com.vaadin.flow.component.textfield.TextArea#setPattern(String)
*/
String pattern() default "";
/**
* Get the value desired for the {@code placeholder} property.
*
* @return desired {@code placeholder} property value
* @see com.vaadin.flow.component.HasPlaceholder#setPlaceholder(String)
*/
String placeholder() default "";
/**
* Get the class to instantiate for the {@code prefixComponent} property.
*
* @return desired {@code prefixComponent} property value type
* @see com.vaadin.flow.component.shared.HasPrefix#setPrefixComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> prefixComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code readOnly} property.
*
* @return desired {@code readOnly} property value
* @see com.vaadin.flow.component.HasValueAndElement#setReadOnly(boolean)
*/
boolean readOnly() default false;
/**
* Get the value desired for the {@code required} property.
*
* @return desired {@code required} property value
* @see com.vaadin.flow.component.textfield.TextArea#setRequired(boolean)
*/
boolean required() default false;
/**
* Get the value desired for the {@code requiredIndicatorVisible} property.
*
* @return desired {@code requiredIndicatorVisible} property value
* @see com.vaadin.flow.component.textfield.TextArea#setRequiredIndicatorVisible(boolean)
*/
boolean requiredIndicatorVisible() default false;
/**
* Get the class to instantiate for the {@code suffixComponent} property.
*
* @return desired {@code suffixComponent} property value type
* @see com.vaadin.flow.component.shared.HasSuffix#setSuffixComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> suffixComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code tabIndex} property.
*
* @return desired {@code tabIndex} property value
* @see com.vaadin.flow.component.Focusable#setTabIndex(int)
*/
int tabIndex() default 0;
/**
* Add the specified theme names.
*
* @return zero or more theme names to add
* @see com.vaadin.flow.component.HasTheme#addThemeNames(String[])
*/
String[] addThemeNames() default {};
/**
* Add the specified theme variants.
*
* @return zero or more theme variants to add
* @see com.vaadin.flow.component.shared.HasThemeVariant#addThemeVariants(com.vaadin.flow.component.shared.ThemeVariant[])
*/
com.vaadin.flow.component.textfield.TextAreaVariant[] addThemeVariants() default {};
/**
* Get the value desired for the {@code title} property.
*
* @return desired {@code title} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setTitle(String)
*/
String title() default "";
/**
* Get the value desired for the {@code tooltipText} property.
*
* @return desired {@code tooltipText} property value
* @see com.vaadin.flow.component.shared.HasTooltip#setTooltipText(String)
*/
String tooltipText() default "";
/**
* Get the value desired for the {@code valueChangeMode} property.
*
* @return desired {@code valueChangeMode} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setValueChangeMode(com.vaadin.flow.data.value.ValueChangeMode)
*/
com.vaadin.flow.data.value.ValueChangeMode valueChangeMode() default com.vaadin.flow.data.value.ValueChangeMode.ON_CHANGE;
/**
* Get the value desired for the {@code valueChangeTimeout} property.
*
* @return desired {@code valueChangeTimeout} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setValueChangeTimeout(int)
*/
int valueChangeTimeout() default 400;
/**
* Get the value desired for the {@code visible} property.
*
* @return desired {@code visible} property value
* @see com.vaadin.flow.component.Component#setVisible(boolean)
*/
boolean visible() default true;
/**
* Get the value desired for the {@code width} property.
*
* @return desired {@code width} property value
* @see com.vaadin.flow.component.HasSize#setWidth(String)
*/
String width() default "";
}
/**
* Specifies how a Java bean property should be edited using a {@link com.vaadin.flow.component.textfield.TextField}.
*
* @see FieldBuilder
* @see com.vaadin.flow.component.textfield.TextField
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface TextField {
/**
* Get the sub-type of {@link com.vaadin.flow.component.textfield.TextField} that will edit the property.
*
*
* This property allows custom widget subclasses to be used.
*
*
* The specified type must have a public constructor that takes either no arguments,
* or one {@code FieldBuilderContext}.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.textfield.TextField> implementation() default com.vaadin.flow.component.textfield.TextField.class;
/**
* Specify CSS properties to be set via {@link com.vaadin.flow.dom.Style#set Style.set()}.
*
*
* The array value consists of name, value pairs. If the array has odd length, the last element is ignored.
*
* @return zero or more style property name, value pairs
* @see com.vaadin.flow.dom.Style
* @see com.vaadin.flow.component.HasStyle
*/
String[] styleProperties() default {};
/**
* Get the value desired for the {@code allowedCharPattern} property.
*
* @return desired {@code allowedCharPattern} property value
* @see com.vaadin.flow.component.shared.HasAllowedCharPattern#setAllowedCharPattern(String)
*/
String allowedCharPattern() default "";
/**
* Get the value desired for the {@code ariaLabel} property.
*
* @return desired {@code ariaLabel} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setAriaLabel(String)
*/
String ariaLabel() default "";
/**
* Get the value desired for the {@code ariaLabelledBy} property.
*
* @return desired {@code ariaLabelledBy} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setAriaLabelledBy(String)
*/
String ariaLabelledBy() default "";
/**
* Get the value desired for the {@code autocapitalize} property.
*
* @return desired {@code autocapitalize} property value
* @see com.vaadin.flow.component.textfield.HasAutocapitalize#setAutocapitalize(com.vaadin.flow.component.textfield.Autocapitalize)
*/
com.vaadin.flow.component.textfield.Autocapitalize autocapitalize() default com.vaadin.flow.component.textfield.Autocapitalize.NONE;
/**
* Get the value desired for the {@code autocomplete} property.
*
* @return desired {@code autocomplete} property value
* @see com.vaadin.flow.component.textfield.HasAutocomplete#setAutocomplete(com.vaadin.flow.component.textfield.Autocomplete)
*/
com.vaadin.flow.component.textfield.Autocomplete autocomplete() default com.vaadin.flow.component.textfield.Autocomplete.ON;
/**
* Get the value desired for the {@code autocorrect} property.
*
* @return desired {@code autocorrect} property value
* @see com.vaadin.flow.component.textfield.HasAutocorrect#setAutocorrect(boolean)
*/
boolean autocorrect() default false;
/**
* Get the value desired for the {@code autofocus} property.
*
* @return desired {@code autofocus} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setAutofocus(boolean)
*/
boolean autofocus() default false;
/**
* Get the value desired for the {@code autoselect} property.
*
* @return desired {@code autoselect} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setAutoselect(boolean)
*/
boolean autoselect() default false;
/**
* Add the specified class names.
*
* @return zero or more class names to add
* @see com.vaadin.flow.component.HasStyle#addClassNames(String[])
*/
String[] addClassNames() default {};
/**
* Get the value desired for the {@code clearButtonVisible} property.
*
* @return desired {@code clearButtonVisible} property value
* @see com.vaadin.flow.component.shared.HasClearButton#setClearButtonVisible(boolean)
*/
boolean clearButtonVisible() default false;
/**
* Get the value desired for the {@code enabled} property.
*
* @return desired {@code enabled} property value
* @see com.vaadin.flow.component.HasEnabled#setEnabled(boolean)
*/
boolean enabled() default true;
/**
* Get the value desired for the {@code errorMessage} property.
*
* @return desired {@code errorMessage} property value
* @see com.vaadin.flow.component.shared.HasValidationProperties#setErrorMessage(String)
*/
String errorMessage() default "";
/**
* Get the value desired for the {@code height} property.
*
* @return desired {@code height} property value
* @see com.vaadin.flow.component.HasSize#setHeight(String)
*/
String height() default "";
/**
* Get the class to instantiate for the {@code helperComponent} property.
*
* @return desired {@code helperComponent} property value type
* @see com.vaadin.flow.component.HasHelper#setHelperComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> helperComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code helperText} property.
*
* @return desired {@code helperText} property value
* @see com.vaadin.flow.component.HasHelper#setHelperText(String)
*/
String helperText() default "";
/**
* Get the value desired for the {@code id} property.
*
* @return desired {@code id} property value
* @see com.vaadin.flow.component.Component#setId(String)
*/
String id() default "";
/**
* Get the value desired for the {@code label} property.
*
* @return desired {@code label} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setLabel(String)
*/
String label() default "";
/**
* Get the value desired for the {@code manualValidation} property.
*
* @return desired {@code manualValidation} property value
* @see com.vaadin.flow.component.textfield.TextField#setManualValidation(boolean)
*/
boolean manualValidation() default false;
/**
* Get the value desired for the {@code maxHeight} property.
*
* @return desired {@code maxHeight} property value
* @see com.vaadin.flow.component.HasSize#setMaxHeight(String)
*/
String maxHeight() default "";
/**
* Get the value desired for the {@code maxLength} property.
*
* @return desired {@code maxLength} property value
* @see com.vaadin.flow.component.textfield.TextField#setMaxLength(int)
*/
int maxLength() default 0;
/**
* Get the value desired for the {@code maxWidth} property.
*
* @return desired {@code maxWidth} property value
* @see com.vaadin.flow.component.HasSize#setMaxWidth(String)
*/
String maxWidth() default "";
/**
* Get the value desired for the {@code minHeight} property.
*
* @return desired {@code minHeight} property value
* @see com.vaadin.flow.component.HasSize#setMinHeight(String)
*/
String minHeight() default "";
/**
* Get the value desired for the {@code minLength} property.
*
* @return desired {@code minLength} property value
* @see com.vaadin.flow.component.textfield.TextField#setMinLength(int)
*/
int minLength() default 0;
/**
* Get the value desired for the {@code minWidth} property.
*
* @return desired {@code minWidth} property value
* @see com.vaadin.flow.component.HasSize#setMinWidth(String)
*/
String minWidth() default "";
/**
* Get the value desired for the {@code pattern} property.
*
* @return desired {@code pattern} property value
* @see com.vaadin.flow.component.textfield.TextField#setPattern(String)
*/
String pattern() default "";
/**
* Get the value desired for the {@code placeholder} property.
*
* @return desired {@code placeholder} property value
* @see com.vaadin.flow.component.HasPlaceholder#setPlaceholder(String)
*/
String placeholder() default "";
/**
* Get the class to instantiate for the {@code prefixComponent} property.
*
* @return desired {@code prefixComponent} property value type
* @see com.vaadin.flow.component.shared.HasPrefix#setPrefixComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> prefixComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code readOnly} property.
*
* @return desired {@code readOnly} property value
* @see com.vaadin.flow.component.HasValueAndElement#setReadOnly(boolean)
*/
boolean readOnly() default false;
/**
* Get the value desired for the {@code required} property.
*
* @return desired {@code required} property value
* @see com.vaadin.flow.component.textfield.TextField#setRequired(boolean)
*/
boolean required() default false;
/**
* Get the value desired for the {@code requiredIndicatorVisible} property.
*
* @return desired {@code requiredIndicatorVisible} property value
* @see com.vaadin.flow.component.textfield.TextField#setRequiredIndicatorVisible(boolean)
*/
boolean requiredIndicatorVisible() default false;
/**
* Get the class to instantiate for the {@code suffixComponent} property.
*
* @return desired {@code suffixComponent} property value type
* @see com.vaadin.flow.component.shared.HasSuffix#setSuffixComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> suffixComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code tabIndex} property.
*
* @return desired {@code tabIndex} property value
* @see com.vaadin.flow.component.Focusable#setTabIndex(int)
*/
int tabIndex() default 0;
/**
* Add the specified theme names.
*
* @return zero or more theme names to add
* @see com.vaadin.flow.component.HasTheme#addThemeNames(String[])
*/
String[] addThemeNames() default {};
/**
* Add the specified theme variants.
*
* @return zero or more theme variants to add
* @see com.vaadin.flow.component.shared.HasThemeVariant#addThemeVariants(com.vaadin.flow.component.shared.ThemeVariant[])
*/
com.vaadin.flow.component.textfield.TextFieldVariant[] addThemeVariants() default {};
/**
* Get the value desired for the {@code title} property.
*
* @return desired {@code title} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setTitle(String)
*/
String title() default "";
/**
* Get the value desired for the {@code tooltipText} property.
*
* @return desired {@code tooltipText} property value
* @see com.vaadin.flow.component.shared.HasTooltip#setTooltipText(String)
*/
String tooltipText() default "";
/**
* Get the value desired for the {@code valueChangeMode} property.
*
* @return desired {@code valueChangeMode} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setValueChangeMode(com.vaadin.flow.data.value.ValueChangeMode)
*/
com.vaadin.flow.data.value.ValueChangeMode valueChangeMode() default com.vaadin.flow.data.value.ValueChangeMode.ON_CHANGE;
/**
* Get the value desired for the {@code valueChangeTimeout} property.
*
* @return desired {@code valueChangeTimeout} property value
* @see com.vaadin.flow.component.textfield.TextFieldBase#setValueChangeTimeout(int)
*/
int valueChangeTimeout() default 400;
/**
* Get the value desired for the {@code visible} property.
*
* @return desired {@code visible} property value
* @see com.vaadin.flow.component.Component#setVisible(boolean)
*/
boolean visible() default true;
/**
* Get the value desired for the {@code width} property.
*
* @return desired {@code width} property value
* @see com.vaadin.flow.component.HasSize#setWidth(String)
*/
String width() default "";
}
/**
* Specifies how a Java bean property should be edited using a {@link com.vaadin.flow.component.timepicker.TimePicker}.
*
* @see FieldBuilder
* @see com.vaadin.flow.component.timepicker.TimePicker
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface TimePicker {
/**
* Get the sub-type of {@link com.vaadin.flow.component.timepicker.TimePicker} that will edit the property.
*
*
* This property allows custom widget subclasses to be used.
*
*
* The specified type must have a public constructor that takes either no arguments,
* or one {@code FieldBuilderContext}.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.timepicker.TimePicker> implementation() default com.vaadin.flow.component.timepicker.TimePicker.class;
/**
* Specify CSS properties to be set via {@link com.vaadin.flow.dom.Style#set Style.set()}.
*
*
* The array value consists of name, value pairs. If the array has odd length, the last element is ignored.
*
* @return zero or more style property name, value pairs
* @see com.vaadin.flow.dom.Style
* @see com.vaadin.flow.component.HasStyle
*/
String[] styleProperties() default {};
/**
* Get the value desired for the {@code allowedCharPattern} property.
*
* @return desired {@code allowedCharPattern} property value
* @see com.vaadin.flow.component.shared.HasAllowedCharPattern#setAllowedCharPattern(String)
*/
String allowedCharPattern() default "";
/**
* Get the value desired for the {@code ariaLabel} property.
*
* @return desired {@code ariaLabel} property value
* @see com.vaadin.flow.component.timepicker.TimePicker#setAriaLabel(String)
*/
String ariaLabel() default "";
/**
* Get the value desired for the {@code ariaLabelledBy} property.
*
* @return desired {@code ariaLabelledBy} property value
* @see com.vaadin.flow.component.timepicker.TimePicker#setAriaLabelledBy(String)
*/
String ariaLabelledBy() default "";
/**
* Get the value desired for the {@code autoOpen} property.
*
* @return desired {@code autoOpen} property value
* @see com.vaadin.flow.component.shared.HasAutoOpen#setAutoOpen(boolean)
*/
boolean autoOpen() default true;
/**
* Add the specified class names.
*
* @return zero or more class names to add
* @see com.vaadin.flow.component.HasStyle#addClassNames(String[])
*/
String[] addClassNames() default {};
/**
* Get the value desired for the {@code clearButtonVisible} property.
*
* @return desired {@code clearButtonVisible} property value
* @see com.vaadin.flow.component.shared.HasClearButton#setClearButtonVisible(boolean)
*/
boolean clearButtonVisible() default false;
/**
* Get the value desired for the {@code enabled} property.
*
* @return desired {@code enabled} property value
* @see com.vaadin.flow.component.HasEnabled#setEnabled(boolean)
*/
boolean enabled() default true;
/**
* Get the value desired for the {@code errorMessage} property.
*
* @return desired {@code errorMessage} property value
* @see com.vaadin.flow.component.shared.HasValidationProperties#setErrorMessage(String)
*/
String errorMessage() default "";
/**
* Get the value desired for the {@code height} property.
*
* @return desired {@code height} property value
* @see com.vaadin.flow.component.HasSize#setHeight(String)
*/
String height() default "";
/**
* Get the class to instantiate for the {@code helperComponent} property.
*
* @return desired {@code helperComponent} property value type
* @see com.vaadin.flow.component.HasHelper#setHelperComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> helperComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code helperText} property.
*
* @return desired {@code helperText} property value
* @see com.vaadin.flow.component.HasHelper#setHelperText(String)
*/
String helperText() default "";
/**
* Get the value desired for the {@code id} property.
*
* @return desired {@code id} property value
* @see com.vaadin.flow.component.Component#setId(String)
*/
String id() default "";
/**
* Get the value desired for the {@code label} property.
*
* @return desired {@code label} property value
* @see com.vaadin.flow.component.timepicker.TimePicker#setLabel(String)
*/
String label() default "";
/**
* Get the class to instantiate for the {@code locale} property.
*
* @return desired {@code locale} property value type
* @see com.vaadin.flow.component.timepicker.TimePicker#setLocale(java.util.Locale)
*/
@SuppressWarnings("rawtypes")
Class extends java.util.Locale> locale() default java.util.Locale.class;
/**
* Get the value desired for the {@code manualValidation} property.
*
* @return desired {@code manualValidation} property value
* @see com.vaadin.flow.component.timepicker.TimePicker#setManualValidation(boolean)
*/
boolean manualValidation() default false;
/**
* Get the class to instantiate for the {@code max} property.
*
* @return desired {@code max} property value type
* @see com.vaadin.flow.component.timepicker.TimePicker#setMax(java.time.LocalTime)
*/
@SuppressWarnings("rawtypes")
Class extends java.time.LocalTime> max() default java.time.LocalTime.class;
/**
* Get the value desired for the {@code maxHeight} property.
*
* @return desired {@code maxHeight} property value
* @see com.vaadin.flow.component.HasSize#setMaxHeight(String)
*/
String maxHeight() default "";
/**
* Get the value desired for the {@code maxWidth} property.
*
* @return desired {@code maxWidth} property value
* @see com.vaadin.flow.component.HasSize#setMaxWidth(String)
*/
String maxWidth() default "";
/**
* Get the class to instantiate for the {@code min} property.
*
* @return desired {@code min} property value type
* @see com.vaadin.flow.component.timepicker.TimePicker#setMin(java.time.LocalTime)
*/
@SuppressWarnings("rawtypes")
Class extends java.time.LocalTime> min() default java.time.LocalTime.class;
/**
* Get the value desired for the {@code minHeight} property.
*
* @return desired {@code minHeight} property value
* @see com.vaadin.flow.component.HasSize#setMinHeight(String)
*/
String minHeight() default "";
/**
* Get the value desired for the {@code minWidth} property.
*
* @return desired {@code minWidth} property value
* @see com.vaadin.flow.component.HasSize#setMinWidth(String)
*/
String minWidth() default "";
/**
* Get the value desired for the {@code overlayClassName} property.
*
* @return desired {@code overlayClassName} property value
* @see com.vaadin.flow.component.shared.HasOverlayClassName#setOverlayClassName(String)
*/
String overlayClassName() default "";
/**
* Get the value desired for the {@code placeholder} property.
*
* @return desired {@code placeholder} property value
* @see com.vaadin.flow.component.HasPlaceholder#setPlaceholder(String)
*/
String placeholder() default "";
/**
* Get the class to instantiate for the {@code prefixComponent} property.
*
* @return desired {@code prefixComponent} property value type
* @see com.vaadin.flow.component.shared.HasPrefix#setPrefixComponent(com.vaadin.flow.component.Component)
*/
@SuppressWarnings("rawtypes")
Class extends com.vaadin.flow.component.Component> prefixComponent() default com.vaadin.flow.component.Component.class;
/**
* Get the value desired for the {@code readOnly} property.
*
* @return desired {@code readOnly} property value
* @see com.vaadin.flow.component.HasValueAndElement#setReadOnly(boolean)
*/
boolean readOnly() default false;
/**
* Get the value desired for the {@code required} property.
*
* @return desired {@code required} property value
* @see com.vaadin.flow.component.timepicker.TimePicker#setRequired(boolean)
*/
boolean required() default false;
/**
* Get the value desired for the {@code requiredIndicatorVisible} property.
*
* @return desired {@code requiredIndicatorVisible} property value
* @see com.vaadin.flow.component.timepicker.TimePicker#setRequiredIndicatorVisible(boolean)
*/
boolean requiredIndicatorVisible() default false;
/**
* Get the class to instantiate for the {@code step} property.
*
* @return desired {@code step} property value type
* @see com.vaadin.flow.component.timepicker.TimePicker#setStep(java.time.Duration)
*/
@SuppressWarnings("rawtypes")
Class extends java.time.Duration> step() default java.time.Duration.class;
/**
* Get the value desired for the {@code tabIndex} property.
*
* @return desired {@code tabIndex} property value
* @see com.vaadin.flow.component.Focusable#setTabIndex(int)
*/
int tabIndex() default 0;
/**
* Add the specified theme names.
*
* @return zero or more theme names to add
* @see com.vaadin.flow.component.HasTheme#addThemeNames(String[])
*/
String[] addThemeNames() default {};
/**
* Add the specified theme variants.
*
* @return zero or more theme variants to add
* @see com.vaadin.flow.component.shared.HasThemeVariant#addThemeVariants(com.vaadin.flow.component.shared.ThemeVariant[])
*/
com.vaadin.flow.component.timepicker.TimePickerVariant[] addThemeVariants() default {};
/**
* Get the value desired for the {@code tooltipText} property.
*
* @return desired {@code tooltipText} property value
* @see com.vaadin.flow.component.shared.HasTooltip#setTooltipText(String)
*/
String tooltipText() default "";
/**
* Get the value desired for the {@code visible} property.
*
* @return desired {@code visible} property value
* @see com.vaadin.flow.component.Component#setVisible(boolean)
*/
boolean visible() default true;
/**
* Get the value desired for the {@code width} property.
*
* @return desired {@code width} property value
* @see com.vaadin.flow.component.HasSize#setWidth(String)
*/
String width() default "";
}
}