diff --git a/all/src/main/templates/release-notes.html b/all/src/main/templates/release-notes.html index 20dd5d53c20..8368ef44849 100644 --- a/all/src/main/templates/release-notes.html +++ b/all/src/main/templates/release-notes.html @@ -83,6 +83,12 @@

Enhancements in Vaadin Framework @version-minor@

enhancements. Below is a list of the most notable changes:

@@ -97,8 +103,9 @@

Enhancements in Vaadin Framework @version-minor@

Incompatible or Behavior-altering Changes in @version-minor@

-
  • BindingBuilder will now automatically mark bound field read-only when bound to a read-only property or a null setter.
  • Date range limits in AbstractDateFieldState are now Strings instead of Dates, some client-side method signatures were changed
    • +
  • BrowserResizeListener is only called once resizing ends.
    • +
  • ItemClickEvent for Grid now takes and additional row index parameter.

    • For incompatible or behavior-altering changes in 8.3, please see 8.3 release notes

    diff --git a/client/src/main/java/com/vaadin/client/BrowserInfo.java b/client/src/main/java/com/vaadin/client/BrowserInfo.java index 055cf75c75d..953cca03359 100644 --- a/client/src/main/java/com/vaadin/client/BrowserInfo.java +++ b/client/src/main/java/com/vaadin/client/BrowserInfo.java @@ -516,7 +516,7 @@ public int getBrowserMinorVersion() { * other than dots and digits. * * @return the complete browser version or {@code null} if unknown - * @since + * @since 8.4 */ public String getBrowserVersion() { return browserDetails.getBrowserVersion(); diff --git a/client/src/main/java/com/vaadin/client/DateTimeService.java b/client/src/main/java/com/vaadin/client/DateTimeService.java index a6aa153f074..00606a25c19 100644 --- a/client/src/main/java/com/vaadin/client/DateTimeService.java +++ b/client/src/main/java/com/vaadin/client/DateTimeService.java @@ -61,11 +61,12 @@ public DateTimeService(String locale) throws LocaleNotLoadedException { } /** - * Utility method to format positive int as zero-padded two-digits number + * Utility method to format positive int as zero-padded two-digits number. * - * @param i the value + * @param i + * the value * @return "00".."99" - * @since + * @since 8.4 */ public static String asTwoDigits(int i) { return (i < 10 ? "0" : "") + i; diff --git a/client/src/main/java/com/vaadin/client/WidgetUtil.java b/client/src/main/java/com/vaadin/client/WidgetUtil.java index 006e3d3648d..58604fe0050 100644 --- a/client/src/main/java/com/vaadin/client/WidgetUtil.java +++ b/client/src/main/java/com/vaadin/client/WidgetUtil.java @@ -56,7 +56,7 @@ public class WidgetUtil { * * @param * the object type to store - * @since + * @since 8.4 */ public static class Reference { diff --git a/client/src/main/java/com/vaadin/client/ui/VAbstractCalendarPanel.java b/client/src/main/java/com/vaadin/client/ui/VAbstractCalendarPanel.java index bde58480dea..67436339b58 100644 --- a/client/src/main/java/com/vaadin/client/ui/VAbstractCalendarPanel.java +++ b/client/src/main/java/com/vaadin/client/ui/VAbstractCalendarPanel.java @@ -2113,7 +2113,7 @@ public void setRangeEnd(String newRangeEnd) { * * @param label * the label to set - * @since + * @since 8.4 */ public void setAssistiveLabelPreviousYear(String label) { prevYearAssistiveLabel = label; @@ -2124,7 +2124,7 @@ public void setAssistiveLabelPreviousYear(String label) { * * @param label * the label to set - * @since + * @since 8.4 */ public void setAssistiveLabelNextYear(String label) { nextYearAssistiveLabel = label; @@ -2135,7 +2135,7 @@ public void setAssistiveLabelNextYear(String label) { * * @param label * the label to set - * @since + * @since 8.4 */ public void setAssistiveLabelPreviousMonth(String label) { prevMonthAssistiveLabel = label; @@ -2146,7 +2146,7 @@ public void setAssistiveLabelPreviousMonth(String label) { * * @param label * the label to set - * @since + * @since 8.4 */ public void setAssistiveLabelNextMonth(String label) { nextMonthAssistiveLabel = label; @@ -2155,7 +2155,7 @@ public void setAssistiveLabelNextMonth(String label) { /** * Updates assistive labels of the navigation elements. * - * @since + * @since 8.4 */ public void updateAssistiveLabels() { if (prevMonth != null) { diff --git a/client/src/main/java/com/vaadin/client/ui/VDateField.java b/client/src/main/java/com/vaadin/client/ui/VDateField.java index e9eeecad731..0402875206e 100644 --- a/client/src/main/java/com/vaadin/client/ui/VDateField.java +++ b/client/src/main/java/com/vaadin/client/ui/VDateField.java @@ -271,7 +271,7 @@ public String getResolutionVariable(R resolution) { * This method can be implemented by subclasses to update buffered values * from component values. * - * @since + * @since 8.4 */ public abstract void updateBufferedValues(); diff --git a/client/src/main/java/com/vaadin/client/ui/VRadioButtonGroup.java b/client/src/main/java/com/vaadin/client/ui/VRadioButtonGroup.java index 974f5af3ebe..0e2edf82f61 100644 --- a/client/src/main/java/com/vaadin/client/ui/VRadioButtonGroup.java +++ b/client/src/main/java/com/vaadin/client/ui/VRadioButtonGroup.java @@ -308,7 +308,7 @@ protected void updateItemSelection(RadioButton radioButton, boolean value) { * @param value * {@code true} if enabled; {@code false} if not * - * @since + * @since 8.4 */ protected void updateItemEnabled(RadioButton radioButton, boolean value) { boolean enabled = value && !isReadonly() && isEnabled(); diff --git a/client/src/main/java/com/vaadin/client/ui/datefield/AbstractDateFieldConnector.java b/client/src/main/java/com/vaadin/client/ui/datefield/AbstractDateFieldConnector.java index 9997d38e991..02c0f85243e 100644 --- a/client/src/main/java/com/vaadin/client/ui/datefield/AbstractDateFieldConnector.java +++ b/client/src/main/java/com/vaadin/client/ui/datefield/AbstractDateFieldConnector.java @@ -151,7 +151,7 @@ private void updateAssistiveLabels() { * * @param calendar * the calendar panel for which to set the assistive labels - * @since + * @since 8.4 */ protected void setAndUpdateAssistiveLabels( VAbstractCalendarPanel calendar) { diff --git a/client/src/main/java/com/vaadin/client/widgets/Grid.java b/client/src/main/java/com/vaadin/client/widgets/Grid.java index ef1839c2aab..1f75801c27c 100755 --- a/client/src/main/java/com/vaadin/client/widgets/Grid.java +++ b/client/src/main/java/com/vaadin/client/widgets/Grid.java @@ -445,7 +445,8 @@ void detach() { * The tooltip is shown in the mode returned by * {@link #getDescriptionContentMode()}. * - * @since + * @return the tooltip text for this cell + * @since 8.4 */ public String getDescription() { return description; @@ -460,7 +461,7 @@ public String getDescription() { * * @param description * the tooltip to show when hovering the cell - * @since + * @since 8.4 */ public void setDescription(String description) { this.description = description; @@ -476,7 +477,7 @@ public void setDescription(String description) { * @param descriptionContentMode * the content mode to use for the tooltip (HTML or plain * text) - * @since + * @since 8.4 */ public void setDescription(String description, ContentMode descriptionContentMode) { @@ -491,7 +492,7 @@ public void setDescription(String description, * * @see ContentMode * @return the content mode for the tooltip - * @since + * @since 8.4 */ public ContentMode getDescriptionContentMode() { return descriptionContentMode; @@ -503,7 +504,7 @@ public ContentMode getDescriptionContentMode() { * @see ContentMode * @param descriptionContentMode * the content mode for the tooltip - * @since + * @since 8.4 */ public void setDescriptionContentMode( ContentMode descriptionContentMode) { @@ -7383,7 +7384,7 @@ public void scrollToRow(int rowIndex, ScrollDestination destination) * the desired scroll destination * @param callback * the callback command to execute when row is available - * @since + * @since 8.4 */ public void scrollToRow(int rowIndex, ScrollDestination destination, Runnable callback) { @@ -7406,7 +7407,7 @@ public void scrollToRow(int rowIndex, ScrollDestination destination, * the row to look for * @param whenRendered * the callback command to execute when row is available - * @since + * @since 8.4 */ public void scrollToRow(int rowIndex, Runnable whenRendered) { scrollToRow(rowIndex, ScrollDestination.ANY, whenRendered); diff --git a/server/src/main/java/com/vaadin/data/Binder.java b/server/src/main/java/com/vaadin/data/Binder.java index 106590dd14b..52c290a5ee4 100644 --- a/server/src/main/java/com/vaadin/data/Binder.java +++ b/server/src/main/java/com/vaadin/data/Binder.java @@ -188,7 +188,7 @@ public default BindingValidationStatus validate() { * @param readOnly * {@code true} to set binding read-only; {@code false} to * enable writes - * @since + * @since 8.4 * @throws IllegalStateException * if trying to make binding read-write and the setter is * {@code null} @@ -201,7 +201,7 @@ public default BindingValidationStatus validate() { * @see #setReadOnly(boolean) * * @return {@code true} if read-only; {@code false} if not - * @since + * @since 8.4 */ public boolean isReadOnly(); @@ -209,7 +209,7 @@ public default BindingValidationStatus validate() { * Gets the getter associated with this Binding. * * @return the getter - * @since + * @since 8.4 */ public ValueProvider getGetter(); @@ -217,7 +217,7 @@ public default BindingValidationStatus validate() { * Gets the setter associated with this Binding. * * @return the setter - * @since + * @since 8.4 */ public Setter getSetter(); } @@ -730,21 +730,21 @@ public BindingBuilder asRequired( ErrorMessageProvider errorMessageProvider); /** - * Sets the field to be required and delegates the required check to a custom validator. - * This means two things: + * Sets the field to be required and delegates the required check to a + * custom validator. This means two things: *
      *
    1. the required indicator will be displayed for this field
      2. - *
    2. the field value is validated by customRequiredValidator
      3. + *
    3. the field value is validated by {@code requiredValidator}
      4. *
    * * @see HasValue#setRequiredIndicatorVisible(boolean) - * @param customRequiredValidator + * @param requiredValidator * validator responsible for the required check * @return this binding, for chaining - * @since + * @since 8.4 */ public BindingBuilder asRequired( - Validator customRequiredValidator); + Validator requiredValidator); } /** @@ -902,10 +902,9 @@ public BindingBuilder withValidationStatusHandler( @Override public BindingBuilder asRequired( ErrorMessageProvider errorMessageProvider) { - return asRequired( - Validator.from( - value -> !Objects.equals(value, field.getEmptyValue()), - errorMessageProvider)); + return asRequired(Validator.from( + value -> !Objects.equals(value, field.getEmptyValue()), + errorMessageProvider)); } @Override diff --git a/server/src/main/java/com/vaadin/data/ReadOnlyHasValue.java b/server/src/main/java/com/vaadin/data/ReadOnlyHasValue.java index ecc8b03d945..27dce5716f4 100644 --- a/server/src/main/java/com/vaadin/data/ReadOnlyHasValue.java +++ b/server/src/main/java/com/vaadin/data/ReadOnlyHasValue.java @@ -24,17 +24,21 @@ import java.util.Objects; /** - * Generic {@link HasValue} to use any type of component with Vaadin data binding. + * Generic {@link HasValue} to use any type of component with Vaadin data + * binding. *

    * Example: + * * 

      * Label label = new Label();
- * ReadOnlyHasValue<String> hasValue = new ReadOnlyHasValue<>(label::setCaption);
+ * ReadOnlyHasValue<String> hasValue = new ReadOnlyHasValue<>(
+ *         label::setCaption);
  * binder.forField(hasValue).bind(SomeBean::getName);
  *
    * - * @param the value type - * @since + * @param + * the value type + * @since 8.4 */ public class ReadOnlyHasValue implements HasValue, Serializable { private V value; @@ -43,12 +47,15 @@ public class ReadOnlyHasValue implements HasValue, Serializable { private LinkedHashSet> listenerList; /** - * Creates new {@code ReadOnlyHasValue} + * Creates new {@code ReadOnlyHasValue}. * - * @param valueProcessor the value valueProcessor, e.g. {@link Label#setValue} - * @param emptyValue the value to be used as empty, {@code null} by default + * @param valueProcessor + * the value valueProcessor, e.g. {@link Label#setValue} + * @param emptyValue + * the value to be used as empty, {@code null} by default */ - public ReadOnlyHasValue(SerializableConsumer valueProcessor, V emptyValue) { + public ReadOnlyHasValue(SerializableConsumer valueProcessor, + V emptyValue) { this.valueProcessor = valueProcessor; this.emptyValue = emptyValue; } @@ -56,10 +63,11 @@ public ReadOnlyHasValue(SerializableConsumer valueProcessor, V emptyValue) { /** * Creates new {@code ReadOnlyHasValue} with {@code null} as an empty value. * - * @param valueProcessor the value valueProcessor, e.g. {@link Label#setValue} + * @param valueProcessor + * the value valueProcessor, e.g. {@link Label#setValue} */ public ReadOnlyHasValue(SerializableConsumer valueProcessor) { - this(valueProcessor,null); + this(valueProcessor, null); } @Override @@ -67,7 +75,7 @@ public void setValue(V value) { V oldValue = this.value; this.value = value; valueProcessor.accept(value); - if (listenerList != null && ! Objects.equals(oldValue, value)) { + if (listenerList != null && !Objects.equals(oldValue, value)) { for (ValueChangeListener valueChangeListener : listenerList) { valueChangeListener.valueChange( new ValueChangeEvent<>(null, this, oldValue, false)); @@ -99,12 +107,14 @@ public boolean isRequiredIndicatorVisible() { @Override public void setRequiredIndicatorVisible(boolean requiredIndicatorVisible) { - if (requiredIndicatorVisible) throw new IllegalArgumentException("Not Writable"); + if (requiredIndicatorVisible) + throw new IllegalArgumentException("Not Writable"); } @Override public void setReadOnly(boolean readOnly) { - if (!readOnly) throw new IllegalArgumentException("Not Writable"); + if (!readOnly) + throw new IllegalArgumentException("Not Writable"); } @Override diff --git a/server/src/main/java/com/vaadin/data/converter/AbstractStringToNumberConverter.java b/server/src/main/java/com/vaadin/data/converter/AbstractStringToNumberConverter.java index 8488f7ea6d4..3ff24f39cd4 100644 --- a/server/src/main/java/com/vaadin/data/converter/AbstractStringToNumberConverter.java +++ b/server/src/main/java/com/vaadin/data/converter/AbstractStringToNumberConverter.java @@ -53,7 +53,7 @@ public abstract class AbstractStringToNumberConverter * @param errorMessageProvider * the error message provider to use if conversion fails * - * @since + * @since 8.4 */ protected AbstractStringToNumberConverter(T emptyValue, ErrorMessageProvider errorMessageProvider) { diff --git a/server/src/main/java/com/vaadin/data/converter/StringToBigDecimalConverter.java b/server/src/main/java/com/vaadin/data/converter/StringToBigDecimalConverter.java index ecab5367a9b..e4a15bb6325 100644 --- a/server/src/main/java/com/vaadin/data/converter/StringToBigDecimalConverter.java +++ b/server/src/main/java/com/vaadin/data/converter/StringToBigDecimalConverter.java @@ -74,7 +74,7 @@ public StringToBigDecimalConverter(BigDecimal emptyValue, * @param errorMessageProvider * the error message provider to use if conversion fails * - * @since + * @since 8.4 */ public StringToBigDecimalConverter( ErrorMessageProvider errorMessageProvider) { @@ -91,7 +91,7 @@ public StringToBigDecimalConverter( * @param errorMessageProvider * the error message provider to use if conversion fails * - * @since + * @since 8.4 */ public StringToBigDecimalConverter(BigDecimal emptyValue, ErrorMessageProvider errorMessageProvider) { diff --git a/server/src/main/java/com/vaadin/data/converter/StringToBigIntegerConverter.java b/server/src/main/java/com/vaadin/data/converter/StringToBigIntegerConverter.java index 9bc8bb51c06..9320da095c1 100644 --- a/server/src/main/java/com/vaadin/data/converter/StringToBigIntegerConverter.java +++ b/server/src/main/java/com/vaadin/data/converter/StringToBigIntegerConverter.java @@ -75,7 +75,7 @@ public StringToBigIntegerConverter(BigInteger emptyValue, * @param errorMessageProvider * the error message provider to use if conversion fails * - * @since + * @since 8.4 */ public StringToBigIntegerConverter( ErrorMessageProvider errorMessageProvider) { @@ -92,7 +92,7 @@ public StringToBigIntegerConverter( * @param errorMessageProvider * the error message provider to use if conversion fails * - * @since + * @since 8.4 */ public StringToBigIntegerConverter(BigInteger emptyValue, ErrorMessageProvider errorMessageProvider) { diff --git a/server/src/main/java/com/vaadin/data/converter/StringToBooleanConverter.java b/server/src/main/java/com/vaadin/data/converter/StringToBooleanConverter.java index 2ca779665b5..13298f98ea7 100644 --- a/server/src/main/java/com/vaadin/data/converter/StringToBooleanConverter.java +++ b/server/src/main/java/com/vaadin/data/converter/StringToBooleanConverter.java @@ -65,7 +65,7 @@ public StringToBooleanConverter(String errorMessage) { * @param errorMessageProvider * the error message provider to use if conversion fails * - * @since + * @since 8.4 */ public StringToBooleanConverter(ErrorMessageProvider errorMessageProvider) { this(Boolean.TRUE.toString(), Boolean.FALSE.toString(), @@ -97,7 +97,7 @@ public StringToBooleanConverter(String errorMessage, String trueString, * @param errorMessageProvider * the error message provider to use if conversion fails * - * @since + * @since 8.4 */ public StringToBooleanConverter(String trueString, String falseString, ErrorMessageProvider errorMessageProvider) { diff --git a/server/src/main/java/com/vaadin/data/converter/StringToDoubleConverter.java b/server/src/main/java/com/vaadin/data/converter/StringToDoubleConverter.java index e658823f19a..73716ed83b0 100644 --- a/server/src/main/java/com/vaadin/data/converter/StringToDoubleConverter.java +++ b/server/src/main/java/com/vaadin/data/converter/StringToDoubleConverter.java @@ -72,7 +72,7 @@ public StringToDoubleConverter(Double emptyValue, String errorMessage) { * @param errorMessageProvider * the error message provider to use if conversion fails * - * @since + * @since 8.4 */ public StringToDoubleConverter(ErrorMessageProvider errorMessageProvider) { this(null, errorMessageProvider); @@ -88,7 +88,7 @@ public StringToDoubleConverter(ErrorMessageProvider errorMessageProvider) { * @param errorMessageProvider * the error message provider to use if conversion fails * - * @since + * @since 8.4 */ public StringToDoubleConverter(Double emptyValue, ErrorMessageProvider errorMessageProvider) { diff --git a/server/src/main/java/com/vaadin/data/converter/StringToFloatConverter.java b/server/src/main/java/com/vaadin/data/converter/StringToFloatConverter.java index db9e7a3abff..85e3d3b3800 100644 --- a/server/src/main/java/com/vaadin/data/converter/StringToFloatConverter.java +++ b/server/src/main/java/com/vaadin/data/converter/StringToFloatConverter.java @@ -70,7 +70,7 @@ public StringToFloatConverter(Float emptyValue, String errorMessage) { * @param errorMessageProvider * the error message provider to use if conversion fails * - * @since + * @since 8.4 */ public StringToFloatConverter(ErrorMessageProvider errorMessageProvider) { this(null, errorMessageProvider); @@ -86,7 +86,7 @@ public StringToFloatConverter(ErrorMessageProvider errorMessageProvider) { * @param errorMessageProvider * the error message provider to use if conversion fails * - * @since + * @since 8.4 */ public StringToFloatConverter(Float emptyValue, ErrorMessageProvider errorMessageProvider) { diff --git a/server/src/main/java/com/vaadin/data/converter/StringToIntegerConverter.java b/server/src/main/java/com/vaadin/data/converter/StringToIntegerConverter.java index e10784292bc..ac91d380f4e 100644 --- a/server/src/main/java/com/vaadin/data/converter/StringToIntegerConverter.java +++ b/server/src/main/java/com/vaadin/data/converter/StringToIntegerConverter.java @@ -69,7 +69,7 @@ public StringToIntegerConverter(Integer emptyValue, String errorMessage) { * @param errorMessageProvider * the error message provider to use if conversion fails * - * @since + * @since 8.4 */ public StringToIntegerConverter(ErrorMessageProvider errorMessageProvider) { this(null, errorMessageProvider); @@ -85,7 +85,7 @@ public StringToIntegerConverter(ErrorMessageProvider errorMessageProvider) { * @param errorMessageProvider * the error message provider to use if conversion fails * - * @since + * @since 8.4 */ public StringToIntegerConverter(Integer emptyValue, ErrorMessageProvider errorMessageProvider) { diff --git a/server/src/main/java/com/vaadin/data/converter/StringToLongConverter.java b/server/src/main/java/com/vaadin/data/converter/StringToLongConverter.java index e87504abc47..9b02d2da26a 100644 --- a/server/src/main/java/com/vaadin/data/converter/StringToLongConverter.java +++ b/server/src/main/java/com/vaadin/data/converter/StringToLongConverter.java @@ -69,7 +69,7 @@ public StringToLongConverter(Long emptyValue, String errorMessage) { * @param errorMessageProvider * the error message provider to use if conversion fails * - * @since + * @since 8.4 */ public StringToLongConverter(ErrorMessageProvider errorMessageProvider) { this(null, errorMessageProvider); @@ -85,7 +85,7 @@ public StringToLongConverter(ErrorMessageProvider errorMessageProvider) { * @param errorMessageProvider * the error message provider to use if conversion fails * - * @since + * @since 8.4 */ public StringToLongConverter(Long emptyValue, ErrorMessageProvider errorMessageProvider) { diff --git a/server/src/main/java/com/vaadin/server/WebBrowser.java b/server/src/main/java/com/vaadin/server/WebBrowser.java index cc186e231b6..8000a6435ff 100644 --- a/server/src/main/java/com/vaadin/server/WebBrowser.java +++ b/server/src/main/java/com/vaadin/server/WebBrowser.java @@ -253,7 +253,7 @@ public int getBrowserMinorVersion() { * than dots and digits. * * @return the complete browser version or {@code null} if unknown - * @since + * @since 8.4 */ public String getBrowserVersion() { return browserDetails != null ? browserDetails.getBrowserVersion() diff --git a/server/src/main/java/com/vaadin/ui/AbstractDateField.java b/server/src/main/java/com/vaadin/ui/AbstractDateField.java index fa386be1569..19b628b1f22 100644 --- a/server/src/main/java/com/vaadin/ui/AbstractDateField.java +++ b/server/src/main/java/com/vaadin/ui/AbstractDateField.java @@ -79,7 +79,8 @@ public abstract class AbstractDateField, R extends Enum> extends AbstractField implements FocusNotifier, BlurNotifier { - private static final DateTimeFormatter RANGE_FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd[ HH:mm:ss]", Locale.ENGLISH); + private static final DateTimeFormatter RANGE_FORMATTER = DateTimeFormatter + .ofPattern("yyyy-MM-dd[ HH:mm:ss]", Locale.ENGLISH); private AbstractDateFieldServerRpc rpc = new AbstractDateFieldServerRpc() { @Override @@ -272,7 +273,7 @@ protected T reconstructDateFromFields(Map resolutions, * - the allowed range's start date */ public void setRangeStart(T startDate) { - if (afterDate(startDate,convertFromDateString(getState().rangeEnd))) { + if (afterDate(startDate, convertFromDateString(getState().rangeEnd))) { throw new IllegalStateException( "startDate cannot be later than endDate"); } @@ -343,7 +344,6 @@ public void setRangeEnd(T endDate) { getState().rangeEnd = date; } - /** * Returns the precise rangeStart used. * @@ -356,11 +356,12 @@ public T getRangeStart() { /** * Parses string representaion of date range limit into date type * - * @param temporalStr the string representation + * @param temporalStr + * the string representation * @return parsed value * @see AbstractDateFieldState#rangeStart * @see AbstractDateFieldState#rangeEnd - * @since + * @since 8.4 */ protected T convertFromDateString(String temporalStr) { if (temporalStr == null) { @@ -371,20 +372,23 @@ protected T convertFromDateString(String temporalStr) { /** * Converts a temporal value into field-specific data type. - * @param temporalAccessor - source value + * + * @param temporalAccessor + * - source value * @return conversion result. - * @since + * @since 8.4 */ protected abstract T toType(TemporalAccessor temporalAccessor); /** - * Converts date range limit itno string representaion + * Converts date range limit into string representation. * - * @param temporal the value + * @param temporal + * the value * @return textual representation * @see AbstractDateFieldState#rangeStart * @see AbstractDateFieldState#rangeEnd - * @since + * @since 8.4 */ protected String convertToDateString(T temporal) { if (temporal == null) { @@ -394,10 +398,14 @@ protected String convertToDateString(T temporal) { } /** - * Checks if {@code value} is after {@code base} or not - * @param value temporal value - * @param base temporal value to compare to - * @return {@code true} if {@code value} is after {@code base}, {@code false} otherwise + * Checks if {@code value} is after {@code base} or not. + * + * @param value + * temporal value + * @param base + * temporal value to compare to + * @return {@code true} if {@code value} is after {@code base}, + * {@code false} otherwise */ protected boolean afterDate(T value, T base) { if (value == null || base == null) { @@ -937,10 +945,10 @@ public Map getDateStyles() { * reading software. * * @param element - * the element for which to set the label. Not {@code null}. + * the element for which to set the label. Not {@code null}. * @param label - * the assistive label to set - * @since + * the assistive label to set + * @since 8.4 */ public void setAssistiveLabel(AccessibleElement element, String label) { Objects.requireNonNull(element, "Element cannot be null"); @@ -951,8 +959,8 @@ public void setAssistiveLabel(AccessibleElement element, String label) { * Gets the assistive label of a calendar navigation element. * * @param element - * the element of which to get the assistive label - * @since + * the element of which to get the assistive label + * @since 8.4 */ public void getAssistiveLabel(AccessibleElement element) { getState(false).assistiveLabels.get(element); diff --git a/server/src/main/java/com/vaadin/ui/Grid.java b/server/src/main/java/com/vaadin/ui/Grid.java index 7f7ceeb4a77..0fe3709ec52 100644 --- a/server/src/main/java/com/vaadin/ui/Grid.java +++ b/server/src/main/java/com/vaadin/ui/Grid.java @@ -404,6 +404,7 @@ public MouseEventDetails getMouseEventDetails() { * Returns the clicked rowIndex. * * @return the clicked rowIndex + * @since 8.4 */ public int getRowIndex() { return rowIndex; @@ -639,7 +640,8 @@ public void itemClick(String rowKey, String columnInternalId, MouseEventDetails details, int rowIndex) { Column column = getColumnByInternalId(columnInternalId); T item = getDataCommunicator().getKeyMapper().get(rowKey); - fireEvent(new ItemClick<>(Grid.this, column, item, details, rowIndex)); + fireEvent(new ItemClick<>(Grid.this, column, item, details, + rowIndex)); } @Override @@ -2531,9 +2533,8 @@ protected void setPropertySet(PropertySet propertySet) { /** * Returns the property set used by this grid. * - * @return propertySet - * the property set to return - * @since + * @return propertySet the property set to return + * @since 8.4 */ protected PropertySet getPropertySet() { return propertySet; diff --git a/server/src/main/java/com/vaadin/ui/Notification.java b/server/src/main/java/com/vaadin/ui/Notification.java index 58bb2af5a51..2204ea0b608 100644 --- a/server/src/main/java/com/vaadin/ui/Notification.java +++ b/server/src/main/java/com/vaadin/ui/Notification.java @@ -398,7 +398,7 @@ public void show(Page page) { *

    * If the notification is not shown, does nothing. * - * @since + * @since 8.4 */ public void close() { close(false); @@ -413,7 +413,7 @@ public void close() { * true if the notification was closed because the * user clicked on it, false if the notification was * closed from the server - * @since + * @since 8.4 */ protected void close(boolean userOriginated) { if (!isAttached()) { diff --git a/server/src/main/java/com/vaadin/ui/Tree.java b/server/src/main/java/com/vaadin/ui/Tree.java index b1808391ecf..2f5ca28ebd4 100644 --- a/server/src/main/java/com/vaadin/ui/Tree.java +++ b/server/src/main/java/com/vaadin/ui/Tree.java @@ -454,7 +454,7 @@ public void expand(Collection items) { * the items to expand recursively * @param depth * the maximum depth of recursion - * @since + * @since 8.4 */ public void expandRecursively(Collection items, int depth) { treeGrid.expandRecursively(items, depth); @@ -497,7 +497,7 @@ public void collapse(Collection items) { * the items to expand recursively * @param depth * the maximum depth of recursion - * @since + * @since 8.4 */ public void collapseRecursively(Collection items, int depth) { treeGrid.collapseRecursively(items, depth); @@ -682,7 +682,7 @@ public void setItemDescriptionGenerator( * @param contentMode * how client should interpret textual values * - * @since + * @since 8.4 */ public void setItemDescriptionGenerator( DescriptionGenerator descriptionGenerator, diff --git a/server/src/main/java/com/vaadin/ui/TreeGrid.java b/server/src/main/java/com/vaadin/ui/TreeGrid.java index bb4c5ec0cd8..b9e9508e24d 100644 --- a/server/src/main/java/com/vaadin/ui/TreeGrid.java +++ b/server/src/main/java/com/vaadin/ui/TreeGrid.java @@ -359,7 +359,7 @@ public void expand(Collection items) { * the items to expand recursively * @param depth * the maximum depth of recursion - * @since + * @since 8.4 */ public void expandRecursively(Collection items, int depth) { expandRecursively(items.stream(), depth); @@ -380,7 +380,7 @@ public void expandRecursively(Collection items, int depth) { * the items to expand recursively * @param depth * the maximum depth of recursion - * @since + * @since 8.4 */ public void expandRecursively(Stream items, int depth) { if (depth < 0) { @@ -447,7 +447,7 @@ public void collapse(Collection items) { * the items to collapse recursively * @param depth * the maximum depth of recursion - * @since + * @since 8.4 */ public void collapseRecursively(Collection items, int depth) { collapseRecursively(items.stream(), depth); @@ -468,7 +468,7 @@ public void collapseRecursively(Collection items, int depth) { * the items to collapse recursively * @param depth * the maximum depth of recursion - * @since + * @since 8.4 */ public void collapseRecursively(Stream items, int depth) { if (depth < 0) { diff --git a/server/src/main/java/com/vaadin/ui/components/grid/FooterCell.java b/server/src/main/java/com/vaadin/ui/components/grid/FooterCell.java index d68e8edaa11..5296cf1401e 100644 --- a/server/src/main/java/com/vaadin/ui/components/grid/FooterCell.java +++ b/server/src/main/java/com/vaadin/ui/components/grid/FooterCell.java @@ -110,7 +110,8 @@ public interface FooterCell extends Serializable { * The tooltip is shown in the mode returned by * {@link #getDescriptionContentMode()}. * - * @since + * @return the tooltip text for this cell + * @since 8.4 */ public String getDescription(); @@ -123,7 +124,7 @@ public interface FooterCell extends Serializable { * * @param description * the tooltip to show when hovering the cell - * @since + * @since 8.4 */ public void setDescription(String description); @@ -135,17 +136,17 @@ public interface FooterCell extends Serializable { * the tooltip to show when hovering the cell * @param descriptionContentMode * the content mode to use for the tooltip (HTML or plain text) - * @since + * @since 8.4 */ public void setDescription(String description, ContentMode descriptionContentMode); /** * Gets the content mode for the tooltip. - + * * @see ContentMode * @return the content mode for the tooltip - * @since + * @since 8.4 */ public ContentMode getDescriptionContentMode(); @@ -155,7 +156,7 @@ public void setDescription(String description, * @see ContentMode * @param descriptionContentMode * the content mode for the tooltip - * @since + * @since 8.4 */ public void setDescriptionContentMode(ContentMode descriptionContentMode); diff --git a/server/src/main/java/com/vaadin/ui/components/grid/HeaderCell.java b/server/src/main/java/com/vaadin/ui/components/grid/HeaderCell.java index 63af4c87fe6..b19c80e83b9 100644 --- a/server/src/main/java/com/vaadin/ui/components/grid/HeaderCell.java +++ b/server/src/main/java/com/vaadin/ui/components/grid/HeaderCell.java @@ -110,7 +110,8 @@ public interface HeaderCell extends Serializable { * The tooltip is shown in the mode returned by * {@link #getDescriptionContentMode()}. * - * @since + * @return the tooltip text for this cell + * @since 8.4 */ public String getDescription(); @@ -123,7 +124,7 @@ public interface HeaderCell extends Serializable { * * @param description * the tooltip to show when hovering the cell - * @since + * @since 8.4 */ public void setDescription(String description); @@ -135,7 +136,7 @@ public interface HeaderCell extends Serializable { * the tooltip to show when hovering the cell * @param descriptionContentMode * the content mode to use for the tooltip (HTML or plain text) - * @since + * @since 8.4 */ public void setDescription(String description, ContentMode descriptionContentMode); @@ -146,7 +147,7 @@ public void setDescription(String description, * * @see ContentMode * @return the content mode for the tooltip - * @since + * @since 8.4 */ public ContentMode getDescriptionContentMode(); @@ -156,7 +157,7 @@ public void setDescription(String description, * @see ContentMode * @param descriptionContentMode * the content mode for the tooltip - * @since + * @since 8.4 */ public void setDescriptionContentMode(ContentMode descriptionContentMode); } diff --git a/server/src/main/java/com/vaadin/ui/components/grid/StaticSection.java b/server/src/main/java/com/vaadin/ui/components/grid/StaticSection.java index f78f4b07f10..29af8bfc6c2 100644 --- a/server/src/main/java/com/vaadin/ui/components/grid/StaticSection.java +++ b/server/src/main/java/com/vaadin/ui/components/grid/StaticSection.java @@ -623,7 +623,7 @@ void detach() { * The tooltip is shown in the mode returned by * {@link #getDescriptionContentMode()}. * - * @since + * @since 8.4 */ public String getDescription() { return cellState.description; @@ -638,7 +638,7 @@ public String getDescription() { * * @param description * the tooltip to show when hovering the cell - * @since + * @since 8.4 */ public void setDescription(String description) { cellState.description = description; @@ -654,7 +654,7 @@ public void setDescription(String description) { * @param descriptionContentMode * the content mode to use for the tooltip (HTML or plain * text) - * @since + * @since 8.4 */ public void setDescription(String description, ContentMode descriptionContentMode) { @@ -667,7 +667,7 @@ public void setDescription(String description, * * @see ContentMode * @return the content mode for the tooltip - * @since + * @since 8.4 */ public ContentMode getDescriptionContentMode() { return cellState.descriptionContentMode; @@ -679,7 +679,7 @@ public ContentMode getDescriptionContentMode() { * @see ContentMode * @param descriptionContentMode * the content mode for the tooltip - * @since + * @since 8.4 */ public void setDescriptionContentMode( ContentMode descriptionContentMode) { diff --git a/shared/src/main/java/com/vaadin/shared/ui/datefield/AbstractDateFieldState.java b/shared/src/main/java/com/vaadin/shared/ui/datefield/AbstractDateFieldState.java index b458b26ae31..9437785f532 100644 --- a/shared/src/main/java/com/vaadin/shared/ui/datefield/AbstractDateFieldState.java +++ b/shared/src/main/java/com/vaadin/shared/ui/datefield/AbstractDateFieldState.java @@ -34,13 +34,10 @@ public class AbstractDateFieldState extends AbstractFieldState { /** * Navigation elements that have assistive label. * - * @since + * @since 8.4 */ public enum AccessibleElement { - PREVIOUS_YEAR, - NEXT_YEAR, - PREVIOUS_MONTH, - NEXT_MONTH + PREVIOUS_YEAR, NEXT_YEAR, PREVIOUS_MONTH, NEXT_MONTH } { @@ -57,8 +54,8 @@ public enum AccessibleElement { public String rangeStart; /** - * End range that has been cleared, depending on the resolution of the - * date field. The format is "2018-05-27" or "2018-05-27 14:38:39" + * End range that has been cleared, depending on the resolution of the date + * field. The format is "2018-05-27" or "2018-05-27 14:38:39" * * @see com.vaadin.ui.AbstractDateField#RANGE_FORMATTER */ @@ -133,7 +130,7 @@ public enum AccessibleElement { /** * Map of elements and their corresponding assistive labels. * - * @since + * @since 8.4 */ public Map assistiveLabels = new HashMap<>();