diff options
| author | Ahmed Ashour <asashour@yahoo.com> | 2017-10-02 09:09:37 +0200 |
|---|---|---|
| committer | Henri Sara <henri.sara@gmail.com> | 2017-10-02 10:09:37 +0300 |
| commit | 763a5cbe8c13ff4a169aae9062c643ad1588cea0 (patch) | |
| tree | cf41f4ac4c31925f5ca69d66a3fa6a47fbecfd4f /compatibility-server/src/main | |
| parent | adcf2e2e80c6a05ea5e43be15dc7a2576fd2bbb4 (diff) | |
| download | vaadin-framework-763a5cbe8c13ff4a169aae9062c643ad1588cea0.tar.gz vaadin-framework-763a5cbe8c13ff4a169aae9062c643ad1588cea0.zip | |
First sentence of javadoc should end with a period (#10114)
Also includes minor other javadoc and formatting fixes.
Diffstat (limited to 'compatibility-server/src/main')
57 files changed, 296 insertions, 280 deletions
diff --git a/compatibility-server/src/main/java/com/vaadin/v7/data/Buffered.java b/compatibility-server/src/main/java/com/vaadin/v7/data/Buffered.java index 8bb2cefccc..3e604841b5 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/data/Buffered.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/data/Buffered.java @@ -46,7 +46,8 @@ import com.vaadin.v7.data.Validator.InvalidValueException; * * @author Vaadin Ltd. * @since 3.0 - * @deprecated As of 8.0, no replacement available, see {@link Binder#writeBean(Object)}, {@link Binder#clearFields()} + * @deprecated As of 8.0, no replacement available, see + * {@link Binder#writeBean(Object)}, {@link Binder#clearFields()} * */ @Deprecated @@ -94,7 +95,7 @@ public interface Buffered extends Serializable { public void setBuffered(boolean buffered); /** - * Checks the buffered mode + * Checks the buffered mode. * * @return true if buffered mode is on, false otherwise * @since 7.0 diff --git a/compatibility-server/src/main/java/com/vaadin/v7/data/Container.java b/compatibility-server/src/main/java/com/vaadin/v7/data/Container.java index e996d306df..fb0739a1cf 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/data/Container.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/data/Container.java @@ -1045,7 +1045,7 @@ public interface Container extends Serializable { public void removeAllContainerFilters(); /** - * Returns the filters which have been applied to the container + * Returns the filters which have been applied to the container. * * @return A collection of filters which have been applied to the * container. An empty collection if no filters have been diff --git a/compatibility-server/src/main/java/com/vaadin/v7/data/fieldgroup/FieldGroup.java b/compatibility-server/src/main/java/com/vaadin/v7/data/fieldgroup/FieldGroup.java index ff4779ee8e..87cc641322 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/data/fieldgroup/FieldGroup.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/data/fieldgroup/FieldGroup.java @@ -536,7 +536,7 @@ public class FieldGroup implements Serializable { /** * Exception which wraps InvalidValueExceptions from all invalid fields in a - * FieldGroup + * FieldGroup. * * @since 7.4 */ @@ -648,7 +648,7 @@ public class FieldGroup implements Serializable { } /** - * Returns the field that is bound to the given property id + * Returns the field that is bound to the given property id. * * @param propertyId * The property id to use to lookup the field @@ -660,7 +660,7 @@ public class FieldGroup implements Serializable { } /** - * Returns the property id that is bound to the given field + * Returns the property id that is bound to the given field. * * @param field * The field to use to lookup the property id @@ -748,7 +748,7 @@ public class FieldGroup implements Serializable { } /** - * FIXME javadoc + * The commit event. * */ @Deprecated @@ -760,7 +760,7 @@ public class FieldGroup implements Serializable { } /** - * Returns the field binder that this commit relates to + * Returns the field binder that this commit relates to. * * @return The FieldBinder that is being committed. */ @@ -1120,7 +1120,7 @@ public class FieldGroup implements Serializable { } /** - * Returns the field group where the exception occurred + * Returns the field group where the exception occurred. * * @since 7.4 * @return the field group diff --git a/compatibility-server/src/main/java/com/vaadin/v7/data/fieldgroup/FieldGroupFieldFactory.java b/compatibility-server/src/main/java/com/vaadin/v7/data/fieldgroup/FieldGroupFieldFactory.java index 93a48b8ad1..68e9882e0a 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/data/fieldgroup/FieldGroupFieldFactory.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/data/fieldgroup/FieldGroupFieldFactory.java @@ -27,13 +27,14 @@ import com.vaadin.v7.ui.Field; * * @author Vaadin Ltd. * @since 7.0 - * @deprecated As of 8.0, no direct replacement available. {@link Binder#forMemberField(HasValue)} and - * {@link Binder#bindInstanceFields(Object)} should be used instead. + * @deprecated As of 8.0, no direct replacement available. + * {@link Binder#forMemberField(HasValue)} and + * {@link Binder#bindInstanceFields(Object)} should be used instead. */ @Deprecated public interface FieldGroupFieldFactory extends Serializable { /** - * Creates a field based on the data type that we want to edit + * Creates a field based on the data type that we want to edit. * * @param dataType * The type that we want to edit using the field diff --git a/compatibility-server/src/main/java/com/vaadin/v7/data/sort/Sort.java b/compatibility-server/src/main/java/com/vaadin/v7/data/sort/Sort.java index e187033ed7..693ac308d3 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/data/sort/Sort.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/data/sort/Sort.java @@ -128,7 +128,7 @@ public class Sort implements Serializable { } /** - * Build a sort order list, ready to be passed to Grid + * Build a sort order list, ready to be passed to Grid. * * @return a sort order list. */ diff --git a/compatibility-server/src/main/java/com/vaadin/v7/data/util/GeneratedPropertyContainer.java b/compatibility-server/src/main/java/com/vaadin/v7/data/util/GeneratedPropertyContainer.java index 93cad4b57b..ba0a0fa56b 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/data/util/GeneratedPropertyContainer.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/data/util/GeneratedPropertyContainer.java @@ -77,7 +77,7 @@ public class GeneratedPropertyContainer extends AbstractContainer private final Set<Object> removedProperties = new HashSet<Object>(); /** - * Property implementation for generated properties + * Property implementation for generated properties. */ @Deprecated protected static class GeneratedProperty<T> implements Property<T> { @@ -208,7 +208,7 @@ public class GeneratedPropertyContainer extends AbstractContainer } /** - * Returns the wrapped Item that belongs to the wrapped container + * Returns the wrapped Item that belongs to the wrapped container. * * @return wrapped item. * @since 7.6.8 diff --git a/compatibility-server/src/main/java/com/vaadin/v7/data/util/MethodProperty.java b/compatibility-server/src/main/java/com/vaadin/v7/data/util/MethodProperty.java index d982d98c3f..f2fab292af 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/data/util/MethodProperty.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/data/util/MethodProperty.java @@ -64,7 +64,8 @@ import com.vaadin.v7.util.SerializerHelper; * @author Vaadin Ltd. * @since 3.0 * - * @deprecated As of 8.0, replaced by {@link ValueProvider}, {@link Setter}, see {@link Binder} + * @deprecated As of 8.0, replaced by {@link ValueProvider}, {@link Setter}, see + * {@link Binder} */ @Deprecated @SuppressWarnings("serial") @@ -102,8 +103,7 @@ public class MethodProperty<T> extends AbstractProperty<T> { private static final Object[] DEFAULT_SET_ARGS = new Object[1]; /* Special serialization to handle method references */ - private void writeObject(ObjectOutputStream out) - throws IOException { + private void writeObject(ObjectOutputStream out) throws IOException { out.defaultWriteObject(); SerializerHelper.writeClass(out, type); out.writeObject(instance); @@ -752,7 +752,8 @@ public class MethodProperty<T> extends AbstractProperty<T> { */ public MethodProperty getMethodProperty() { return (property instanceof MethodProperty) - ? (MethodProperty) property : null; + ? (MethodProperty) property + : null; } /** @@ -777,7 +778,7 @@ public class MethodProperty<T> extends AbstractProperty<T> { } /** - * The instance used by this property + * The instance used by this property. * * @return the instance used for fetching the property value * @since 7.7.7 diff --git a/compatibility-server/src/main/java/com/vaadin/v7/data/util/NestedMethodProperty.java b/compatibility-server/src/main/java/com/vaadin/v7/data/util/NestedMethodProperty.java index 6cbff702ad..48052a7671 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/data/util/NestedMethodProperty.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/data/util/NestedMethodProperty.java @@ -47,7 +47,8 @@ import com.vaadin.v7.data.util.MethodProperty.MethodException; * * @since 6.6 * - * @deprecated As of 8.0, replaced by {@link ValueProvider}, {@link Setter}, see {@link Binder} + * @deprecated As of 8.0, replaced by {@link ValueProvider}, {@link Setter}, see + * {@link Binder} */ @Deprecated public class NestedMethodProperty<T> extends AbstractProperty<T> { @@ -70,8 +71,7 @@ public class NestedMethodProperty<T> extends AbstractProperty<T> { private Class<? extends T> type; /* Special serialization to handle method references */ - private void writeObject(ObjectOutputStream out) - throws IOException { + private void writeObject(ObjectOutputStream out) throws IOException { out.defaultWriteObject(); // getMethods and setMethod are reconstructed on read based on // propertyName @@ -276,7 +276,7 @@ public class NestedMethodProperty<T> extends AbstractProperty<T> { } /** - * The instance used by this property + * The instance used by this property. * * @return the instance used for fetching the property value * @since 7.7.7 diff --git a/compatibility-server/src/main/java/com/vaadin/v7/data/util/converter/StringToBooleanConverter.java b/compatibility-server/src/main/java/com/vaadin/v7/data/util/converter/StringToBooleanConverter.java index bf972867ce..ceef081def 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/data/util/converter/StringToBooleanConverter.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/data/util/converter/StringToBooleanConverter.java @@ -42,7 +42,7 @@ public class StringToBooleanConverter implements Converter<String, Boolean> { /** * Creates converter with default string representations - "true" and - * "false" + * "false". * */ public StringToBooleanConverter() { diff --git a/compatibility-server/src/main/java/com/vaadin/v7/data/util/converter/StringToByteConverter.java b/compatibility-server/src/main/java/com/vaadin/v7/data/util/converter/StringToByteConverter.java index 40014d4595..3c3ecace81 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/data/util/converter/StringToByteConverter.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/data/util/converter/StringToByteConverter.java @@ -16,11 +16,11 @@ package com.vaadin.v7.data.util.converter; -import com.vaadin.data.Binder; - import java.text.NumberFormat; import java.util.Locale; +import com.vaadin.data.Binder; + /** * A converter that converts from {@link String} to {@link Byte} and back. Uses * the given locale and a {@link NumberFormat} instance for formatting and @@ -33,7 +33,7 @@ import java.util.Locale; * @since 7.4 * * @deprecated As of 8.0, a lightweight lambda-based converter can be build with - * {@link Binder}{@code .forField(...).withConverter(...)} methods. + * {@link Binder}{@code .forField(...).withConverter(...)} methods. */ @Deprecated public class StringToByteConverter @@ -42,7 +42,7 @@ public class StringToByteConverter /** * Returns the format used by * {@link #convertToPresentation(Byte, Class, Locale)} and - * {@link #convertToModel(String, Class, Locale)} + * {@link #convertToModel(String, Class, Locale)}. * * @param locale * The locale to use diff --git a/compatibility-server/src/main/java/com/vaadin/v7/data/util/converter/StringToEnumConverter.java b/compatibility-server/src/main/java/com/vaadin/v7/data/util/converter/StringToEnumConverter.java index 18b1ed70cb..651c92bbfe 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/data/util/converter/StringToEnumConverter.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/data/util/converter/StringToEnumConverter.java @@ -15,11 +15,11 @@ */ package com.vaadin.v7.data.util.converter; -import com.vaadin.data.Binder; - import java.util.EnumSet; import java.util.Locale; +import com.vaadin.data.Binder; + /** * A converter that converts from {@link String} to an {@link Enum} and back. * <p> @@ -39,7 +39,7 @@ import java.util.Locale; * @since 7.4 * * @deprecated As of 8.0, a lightweight lambda-based converter can be build with - * {@link Binder}{@code .forField(...).withConverter(...)} methods. + * {@link Binder}{@code .forField(...).withConverter(...)} methods. */ @Deprecated public class StringToEnumConverter implements Converter<String, Enum> { @@ -55,7 +55,7 @@ public class StringToEnumConverter implements Converter<String, Enum> { } /** - * Converts the given string to the given enum type using the given locale + * Converts the given string to the given enum type using the given locale. * <p> * Compatible with {@link #enumToString(Enum, Locale)} * @@ -110,7 +110,8 @@ public class StringToEnumConverter implements Converter<String, Enum> { } /** - * Converts the given enum to a human readable string using the given locale + * Converts the given enum to a human readable string using the given + * locale. * <p> * Compatible with {@link #stringToEnum(String, Class, Locale)} * diff --git a/compatibility-server/src/main/java/com/vaadin/v7/data/util/converter/StringToIntegerConverter.java b/compatibility-server/src/main/java/com/vaadin/v7/data/util/converter/StringToIntegerConverter.java index ecc381b338..69ae972ec4 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/data/util/converter/StringToIntegerConverter.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/data/util/converter/StringToIntegerConverter.java @@ -37,7 +37,7 @@ public class StringToIntegerConverter /** * Returns the format used by * {@link #convertToPresentation(Integer, Class, Locale)} and - * {@link #convertToModel(String, Class, Locale)} + * {@link #convertToModel(String, Class, Locale)}. * * @param locale * The locale to use diff --git a/compatibility-server/src/main/java/com/vaadin/v7/data/util/converter/StringToLongConverter.java b/compatibility-server/src/main/java/com/vaadin/v7/data/util/converter/StringToLongConverter.java index 2fee7273b7..077f9bbc1d 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/data/util/converter/StringToLongConverter.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/data/util/converter/StringToLongConverter.java @@ -37,7 +37,7 @@ public class StringToLongConverter /** * Returns the format used by * {@link #convertToPresentation(Long, Class, Locale)} and - * {@link #convertToModel(String, Class, Locale)} + * {@link #convertToModel(String, Class, Locale)}. * * @param locale * The locale to use diff --git a/compatibility-server/src/main/java/com/vaadin/v7/data/util/converter/StringToShortConverter.java b/compatibility-server/src/main/java/com/vaadin/v7/data/util/converter/StringToShortConverter.java index 1bb0da0c85..763c9bd9db 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/data/util/converter/StringToShortConverter.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/data/util/converter/StringToShortConverter.java @@ -30,7 +30,8 @@ import java.util.Locale; * @author Vaadin Ltd * @since 7.4 * - * @deprecated As of 8.0, no direct replacement available, see {@link com.vaadin.data.converter.StringToIntegerConverter} + * @deprecated As of 8.0, no direct replacement available, see + * {@link com.vaadin.data.converter.StringToIntegerConverter} */ @Deprecated public class StringToShortConverter @@ -39,7 +40,7 @@ public class StringToShortConverter /** * Returns the format used by * {@link #convertToPresentation(Short, Class, Locale)} and - * {@link #convertToModel(String, Class, Locale)} + * {@link #convertToModel(String, Class, Locale)}. * * @param locale * The locale to use diff --git a/compatibility-server/src/main/java/com/vaadin/v7/data/util/sqlcontainer/SQLContainer.java b/compatibility-server/src/main/java/com/vaadin/v7/data/util/sqlcontainer/SQLContainer.java index 5ff356cbfe..7591ca7a75 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/data/util/sqlcontainer/SQLContainer.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/data/util/sqlcontainer/SQLContainer.java @@ -65,7 +65,7 @@ public class SQLContainer implements Container, Container.Filterable, private int pageLength = DEFAULT_PAGE_LENGTH; public static final int DEFAULT_PAGE_LENGTH = 100; - /** Number of items to cache = CACHE_RATIO x pageLength */ + /** Number of items to cache = CACHE_RATIO x pageLength. */ public static final int CACHE_RATIO = 2; /** Amount of cache to overlap with previous page */ @@ -128,7 +128,7 @@ public class SQLContainer implements Container, Container.Filterable, } /** - * Creates and initializes SQLContainer using the given QueryDelegate + * Creates and initializes SQLContainer using the given QueryDelegate. * * @param delegate * QueryDelegate implementation @@ -1493,7 +1493,7 @@ public class SQLContainer implements Container, Container.Filterable, /**************************************************/ /** - * Adds a RowIdChangeListener to the QueryDelegate + * Adds a RowIdChangeListener to the QueryDelegate. * * @param listener */ @@ -1514,7 +1514,7 @@ public class SQLContainer implements Container, Container.Filterable, } /** - * Removes a RowIdChangeListener from the QueryDelegate + * Removes a RowIdChangeListener from the QueryDelegate. * * @param listener */ diff --git a/compatibility-server/src/main/java/com/vaadin/v7/data/util/sqlcontainer/query/TableQuery.java b/compatibility-server/src/main/java/com/vaadin/v7/data/util/sqlcontainer/query/TableQuery.java index 3cfd95e489..8aa6aa0c26 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/data/util/sqlcontainer/query/TableQuery.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/data/util/sqlcontainer/query/TableQuery.java @@ -757,7 +757,7 @@ public class TableQuery extends AbstractTransactionalQuery } /** - * Adds RowIdChangeListener to this query + * Adds RowIdChangeListener to this query. */ @Override public void addRowIdChangeListener(RowIdChangeListener listener) { @@ -778,7 +778,7 @@ public class TableQuery extends AbstractTransactionalQuery } /** - * Removes the given RowIdChangeListener from this query + * Removes the given RowIdChangeListener from this query. */ @Override public void removeRowIdChangeListener(RowIdChangeListener listener) { diff --git a/compatibility-server/src/main/java/com/vaadin/v7/data/util/sqlcontainer/query/generator/DefaultSQLGenerator.java b/compatibility-server/src/main/java/com/vaadin/v7/data/util/sqlcontainer/query/generator/DefaultSQLGenerator.java index 88fc18084c..3f5c60d8e8 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/data/util/sqlcontainer/query/generator/DefaultSQLGenerator.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/data/util/sqlcontainer/query/generator/DefaultSQLGenerator.java @@ -47,7 +47,7 @@ public class DefaultSQLGenerator implements SQLGenerator { /** * Create a new DefaultSqlGenerator instance that uses the given - * implementation of {@link StatementHelper} + * implementation of {@link StatementHelper}. * * @param statementHelper */ @@ -285,7 +285,7 @@ public class DefaultSQLGenerator implements SQLGenerator { } /** - * Generates sorting rules as an ORDER BY -clause + * Generates sorting rules as an ORDER BY -clause. * * @param sb * StringBuffer to which the clause is appended. diff --git a/compatibility-server/src/main/java/com/vaadin/v7/data/util/sqlcontainer/query/generator/filter/StringDecorator.java b/compatibility-server/src/main/java/com/vaadin/v7/data/util/sqlcontainer/query/generator/filter/StringDecorator.java index 047856d9d8..e6aa7ccc09 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/data/util/sqlcontainer/query/generator/filter/StringDecorator.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/data/util/sqlcontainer/query/generator/filter/StringDecorator.java @@ -61,7 +61,7 @@ public class StringDecorator implements Serializable { } /** - * Groups a string by surrounding it in parenthesis + * Groups a string by surrounding it in parenthesis. * * @param str * the string to group diff --git a/compatibility-server/src/main/java/com/vaadin/v7/data/validator/RangeValidator.java b/compatibility-server/src/main/java/com/vaadin/v7/data/validator/RangeValidator.java index f343a0e76b..3889aa890a 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/data/validator/RangeValidator.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/data/validator/RangeValidator.java @@ -65,7 +65,7 @@ public class RangeValidator<T extends Comparable> extends AbstractValidator<T> { } /** - * Checks if the minimum value is part of the accepted range + * Checks if the minimum value is part of the accepted range. * * @return true if the minimum value is part of the range, false otherwise */ @@ -74,7 +74,7 @@ public class RangeValidator<T extends Comparable> extends AbstractValidator<T> { } /** - * Sets if the minimum value is part of the accepted range + * Sets if the minimum value is part of the accepted range. * * @param minValueIncluded * true if the minimum value should be part of the range, false @@ -85,7 +85,7 @@ public class RangeValidator<T extends Comparable> extends AbstractValidator<T> { } /** - * Checks if the maximum value is part of the accepted range + * Checks if the maximum value is part of the accepted range. * * @return true if the maximum value is part of the range, false otherwise */ @@ -94,7 +94,7 @@ public class RangeValidator<T extends Comparable> extends AbstractValidator<T> { } /** - * Sets if the maximum value is part of the accepted range + * Sets if the maximum value is part of the accepted range. * * @param maxValueIncluded * true if the maximum value should be part of the range, false @@ -105,7 +105,7 @@ public class RangeValidator<T extends Comparable> extends AbstractValidator<T> { } /** - * Gets the minimum value of the range + * Gets the minimum value of the range. * * @return the minimum value */ @@ -126,7 +126,7 @@ public class RangeValidator<T extends Comparable> extends AbstractValidator<T> { } /** - * Gets the maximum value of the range + * Gets the maximum value of the range. * * @return the maximum value */ diff --git a/compatibility-server/src/main/java/com/vaadin/v7/event/ItemClickEvent.java b/compatibility-server/src/main/java/com/vaadin/v7/event/ItemClickEvent.java index 7de27e3eba..179581acc7 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/event/ItemClickEvent.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/event/ItemClickEvent.java @@ -61,7 +61,7 @@ public class ItemClickEvent extends ClickEvent implements Serializable { } /** - * Gets a possible identifier in source for clicked Item + * Gets a possible identifier in source for clicked Item. * * @return */ diff --git a/compatibility-server/src/main/java/com/vaadin/v7/event/SelectionEvent.java b/compatibility-server/src/main/java/com/vaadin/v7/event/SelectionEvent.java index 01fb94b879..5213a7d64a 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/event/SelectionEvent.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/event/SelectionEvent.java @@ -117,7 +117,7 @@ public class SelectionEvent extends EventObject { @Deprecated public interface SelectionNotifier extends Serializable { /** - * Registers a new selection listener + * Registers a new selection listener. * * @param listener * the listener to register @@ -125,7 +125,7 @@ public class SelectionEvent extends EventObject { void addSelectionListener(SelectionListener listener); /** - * Removes a previously registered selection change listener + * Removes a previously registered selection change listener. * * @param listener * the listener to remove diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/AbstractColorPicker.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/AbstractColorPicker.java index baa8f1b34e..8fb42de9ed 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/AbstractColorPicker.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/AbstractColorPicker.java @@ -57,13 +57,13 @@ public abstract class AbstractColorPicker extends AbstractLegacyComponent } /** - * Interface for converting 2d-coordinates to a Color + * Interface for converting 2d-coordinates to a Color. */ @Deprecated public interface Coordinates2Color extends Serializable { /** - * Calculate color from coordinates + * Calculate color from coordinates. * * @param x * the x-coordinate @@ -75,7 +75,7 @@ public abstract class AbstractColorPicker extends AbstractLegacyComponent public Color calculate(int x, int y); /** - * Calculate coordinates from color + * Calculate coordinates from color. * * @param c * the c @@ -203,7 +203,7 @@ public abstract class AbstractColorPicker extends AbstractLegacyComponent } /** - * Sets the position of the popup window + * Sets the position of the popup window. * * @param x * the x-coordinate @@ -238,7 +238,7 @@ public abstract class AbstractColorPicker extends AbstractLegacyComponent } /** - * Fired when a color change event occurs + * Fired when a color change event occurs. * * @param event * The color change event @@ -249,14 +249,14 @@ public abstract class AbstractColorPicker extends AbstractLegacyComponent } /** - * Notifies the listeners that the selected color has changed + * Notifies the listeners that the selected color has changed. */ public void fireColorChanged() { fireEvent(new ColorChangeEvent(this, color)); } /** - * The style for the popup window + * The style for the popup window. * * @param style * The style @@ -286,7 +286,7 @@ public abstract class AbstractColorPicker extends AbstractLegacyComponent } /** - * Gets the style for the popup window + * Gets the style for the popup window. * * @since 7.5.0 * @return popup window style @@ -296,7 +296,7 @@ public abstract class AbstractColorPicker extends AbstractLegacyComponent } /** - * Set the visibility of the RGB Tab + * Set the visibility of the RGB Tab. * * @param visible * The visibility @@ -314,7 +314,7 @@ public abstract class AbstractColorPicker extends AbstractLegacyComponent } /** - * Gets the visibility of the RGB Tab + * Gets the visibility of the RGB Tab. * * @since 7.5.0 * @return visibility of the RGB tab @@ -324,7 +324,7 @@ public abstract class AbstractColorPicker extends AbstractLegacyComponent } /** - * Set the visibility of the HSV Tab + * Set the visibility of the HSV Tab. * * @param visible * The visibility @@ -341,7 +341,7 @@ public abstract class AbstractColorPicker extends AbstractLegacyComponent } /** - * Gets the visibility of the HSV Tab + * Gets the visibility of the HSV Tab. * * @since 7.5.0 * @return visibility of the HSV tab @@ -351,7 +351,7 @@ public abstract class AbstractColorPicker extends AbstractLegacyComponent } /** - * Set the visibility of the Swatches Tab + * Set the visibility of the Swatches Tab. * * @param visible * The visibility @@ -368,7 +368,7 @@ public abstract class AbstractColorPicker extends AbstractLegacyComponent } /** - * Gets the visibility of the Swatches Tab + * Gets the visibility of the Swatches Tab. * * @since 7.5.0 * @return visibility of the swatches tab @@ -378,7 +378,7 @@ public abstract class AbstractColorPicker extends AbstractLegacyComponent } /** - * Sets the visibility of the Color History + * Sets the visibility of the Color History. * * @param visible * The visibility @@ -391,7 +391,7 @@ public abstract class AbstractColorPicker extends AbstractLegacyComponent } /** - * Gets the visibility of the Color History + * Gets the visibility of the Color History. * * @since 7.5.0 * @return visibility of color history @@ -401,7 +401,7 @@ public abstract class AbstractColorPicker extends AbstractLegacyComponent } /** - * Sets the visibility of the CSS color code text field + * Sets the visibility of the CSS color code text field. * * @param visible * The visibility @@ -414,7 +414,7 @@ public abstract class AbstractColorPicker extends AbstractLegacyComponent } /** - * Gets the visibility of CSS color code text field + * Gets the visibility of CSS color code text field. * * @since 7.5.0 * @return visibility of css color code text field @@ -434,7 +434,7 @@ public abstract class AbstractColorPicker extends AbstractLegacyComponent } /** - * Sets the default styles of the component + * Sets the default styles of the component. * */ protected abstract void setDefaultStyles(); @@ -532,7 +532,7 @@ public abstract class AbstractColorPicker extends AbstractLegacyComponent } /** - * Return HTML rendering setting + * Return HTML rendering setting. * * @return <code>true</code> if the caption text is to be rendered as HTML, * <code>false</code> otherwise diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/AbstractSelect.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/AbstractSelect.java index a6472c61db..620a29f83a 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/AbstractSelect.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/AbstractSelect.java @@ -558,19 +558,21 @@ public abstract class AbstractSelect extends AbstractField<Object> implements } /** - * TODO refine doc Setter for new item handler that is called when user adds - * new item in newItemAllowed mode. + * TODO refine doc Setter for new item handler, which is called when user + * adds new item in {@code newItemAllowed} mode. * * @param newItemHandler + * The new item handler */ public void setNewItemHandler(NewItemHandler newItemHandler) { this.newItemHandler = newItemHandler; } /** - * TODO refine doc + * Returns the new item handler, which is called when user adds new item in + * {@code newItemAllowed} mode. * - * @return + * @return NewItemHandler */ public NewItemHandler getNewItemHandler() { if (newItemHandler == null) { @@ -821,7 +823,7 @@ public abstract class AbstractSelect extends AbstractField<Object> implements /** * Gets the Property identified by the given itemId and propertyId from the - * Container + * Container. * * @see Container#getContainerProperty(Object, Object) */ @@ -2127,7 +2129,7 @@ public abstract class AbstractSelect extends AbstractField<Object> implements /** * Constructor that automatically converts itemIdOver key to - * corresponding item Id + * corresponding item Id. * */ protected AbstractSelectTargetDetails( @@ -2193,7 +2195,7 @@ public abstract class AbstractSelect extends AbstractField<Object> implements /** * Called by Table when a cell (and row) is painted or a item is painted - * in Tree + * in Tree. * * @param source * The source of the generator, the Tree or Table the diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/Calendar.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/Calendar.java index a763eccba2..e04888fa91 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/Calendar.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/Calendar.java @@ -239,7 +239,7 @@ public class Calendar extends AbstractLegacyComponent private Integer customFirstDayOfWeek; /** - * Returns the logger for the calendar + * Returns the logger for the calendar. */ protected Logger getLogger() { return Logger.getLogger(Calendar.class.getName()); @@ -1056,7 +1056,7 @@ public class Calendar extends AbstractLegacyComponent } /** - * Is the user allowed to trigger events which alters the events + * Is the user allowed to trigger events which alters the events. * * @return true if the client is allowed to send changes to server * @see #isEventClickAllowed() @@ -1095,7 +1095,7 @@ public class Calendar extends AbstractLegacyComponent } /** - * Fires an event move event to all server side move listerners + * Fires an event move event to all server side move listeners. * * @param index * The index of the event in the events list @@ -1308,7 +1308,7 @@ public class Calendar extends AbstractLegacyComponent /** * Finds the first day of the week and returns a day representing the start - * of that day + * of that day. * * @param start * The actual date @@ -1339,7 +1339,7 @@ public class Calendar extends AbstractLegacyComponent /** * Finds the last day of the week and returns a day representing the end of - * that day + * that day. * * @param end * The actual date @@ -1496,7 +1496,7 @@ public class Calendar extends AbstractLegacyComponent } /** - * Get the currently active drop handler + * Get the currently active drop handler. */ @Override public DropHandler getDropHandler() { @@ -1713,7 +1713,7 @@ public class Calendar extends AbstractLegacyComponent } /** - * Is the calendar in a mode where all days of the month is shown + * Is the calendar in a mode where all days of the month is shown. * * @return Returns true if calendar is in monthly mode and false if it is in * weekly mode diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/Form.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/Form.java index b37bcd933b..ea8fa1c528 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/Form.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/Form.java @@ -1298,7 +1298,7 @@ public class Form extends AbstractField<Object> } /** - * Removes all action handlers + * Removes all action handlers. */ public void removeAllActionHandlers() { if (ownActionManager != null) { diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/Grid.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/Grid.java index 4349ad49b4..9e8dd1086c 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/Grid.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/Grid.java @@ -292,7 +292,7 @@ public class Grid extends AbstractComponent @Deprecated public interface DetailsGenerator extends Serializable { - /** A details generator that provides no details */ + /** A details generator that provides no details. */ public DetailsGenerator NULL = new DetailsGenerator() { @Override public Component getDetails(RowReference rowReference) { @@ -618,7 +618,7 @@ public class Grid extends AbstractComponent } /** - * Returns the singleton instance + * Returns the singleton instance. * * @return the singleton instance */ @@ -659,13 +659,13 @@ public class Grid extends AbstractComponent } /** - * Error handler for the editor + * Error handler for the editor. */ @Deprecated public interface EditorErrorHandler extends Serializable { /** - * Called when an exception occurs while the editor row is being saved + * Called when an exception occurs while the editor row is being saved. * * @param event * An event providing more information about the error @@ -742,7 +742,7 @@ public class Grid extends AbstractComponent } /** - * An event which is fired when saving the editor fails + * An event which is fired when saving the editor fails. */ @Deprecated public static class CommitErrorEvent extends Component.Event { @@ -760,7 +760,7 @@ public class Grid extends AbstractComponent } /** - * Retrieves the cause of the failure + * Retrieves the cause of the failure. * * @return the cause of the failure */ @@ -774,7 +774,7 @@ public class Grid extends AbstractComponent } /** - * Checks if validation exceptions caused this error + * Checks if validation exceptions caused this error. * * @return true if the problem was caused by a validation error */ @@ -941,7 +941,7 @@ public class Grid extends AbstractComponent } /** - * Interface for an editor event listener + * Interface for an editor event listener. */ @Deprecated public interface EditorListener extends Serializable { @@ -955,7 +955,7 @@ public class Grid extends AbstractComponent EditorCloseEvent.class); /** - * Called when an editor is opened + * Called when an editor is opened. * * @param e * an editor open event object @@ -963,7 +963,7 @@ public class Grid extends AbstractComponent public void editorOpened(EditorOpenEvent e); /** - * Called when an editor is reopened without closing it first + * Called when an editor is reopened without closing it first. * * @param e * an editor move event object @@ -971,7 +971,7 @@ public class Grid extends AbstractComponent public void editorMoved(EditorMoveEvent e); /** - * Called when an editor is closed + * Called when an editor is closed. * * @param e * an editor close event object @@ -981,7 +981,7 @@ public class Grid extends AbstractComponent } /** - * Base class for editor related events + * Base class for editor related events. */ @Deprecated public abstract static class EditorEvent extends Component.Event { @@ -994,7 +994,7 @@ public class Grid extends AbstractComponent } /** - * Get the item (row) for which this editor was opened + * Get the item (row) for which this editor was opened. */ public Object getItem() { return itemID; @@ -1003,7 +1003,7 @@ public class Grid extends AbstractComponent } /** - * This event gets fired when an editor is opened + * This event gets fired when an editor is opened. */ @Deprecated public static class EditorOpenEvent extends EditorEvent { @@ -1038,7 +1038,7 @@ public class Grid extends AbstractComponent } /** - * Default error handler for the editor + * Default error handler for the editor. * */ @Deprecated @@ -1098,7 +1098,7 @@ public class Grid extends AbstractComponent */ @Deprecated public enum SelectionMode { - /** A SelectionMode that maps to {@link SingleSelectionModel} */ + /** A SelectionMode that maps to {@link SingleSelectionModel}. */ SINGLE { @Override protected SelectionModel createModel() { @@ -1107,7 +1107,7 @@ public class Grid extends AbstractComponent }, - /** A SelectionMode that maps to {@link MultiSelectionModel} */ + /** A SelectionMode that maps to {@link MultiSelectionModel}. */ MULTI { @Override protected SelectionModel createModel() { @@ -1115,7 +1115,7 @@ public class Grid extends AbstractComponent } }, - /** A SelectionMode that maps to {@link NoSelectionModel} */ + /** A SelectionMode that maps to {@link NoSelectionModel}. */ NONE { @Override protected SelectionModel createModel() { @@ -1282,7 +1282,7 @@ public class Grid extends AbstractComponent throws IllegalArgumentException; /** - * Marks all the items in the current Container as selected + * Marks all the items in the current Container as selected. * * @return <code>true</code> if some items were previously not * selected @@ -1291,7 +1291,7 @@ public class Grid extends AbstractComponent boolean selectAll(); /** - * Marks all the items in the current Container as deselected + * Marks all the items in the current Container as deselected. * * @return <code>true</code> if some items were previously selected * @see #selectAll() @@ -2075,7 +2075,7 @@ public class Grid extends AbstractComponent } /** - * Sets the identifying information for this row + * Sets the identifying information for this row. * * @param itemId * the item id of the row @@ -2132,7 +2132,7 @@ public class Grid extends AbstractComponent } /** - * Sets the identifying information for this cell + * Sets the identifying information for this cell. * * @param propertyId * the property id of the column @@ -3431,7 +3431,7 @@ public class Grid extends AbstractComponent } /** - * Returns the property id for the backing property of this Column + * Returns the property id for the backing property of this Column. * * @return property id */ @@ -3598,7 +3598,7 @@ public class Grid extends AbstractComponent /** * Checks if column is attached and throws an - * {@link IllegalStateException} if it is not + * {@link IllegalStateException} if it is not. * * @throws IllegalStateException * if the column is no longer attached to any grid @@ -4359,7 +4359,7 @@ public class Grid extends AbstractComponent } /** - * Null representation for the renderer + * Null representation for the renderer. * * @return a textual representation of {@code null} */ @@ -5217,7 +5217,7 @@ public class Grid extends AbstractComponent } /** - * Returns a column based on the property id + * Returns a column based on the property id. * * @param propertyId * the property id of the column @@ -6777,7 +6777,7 @@ public class Grid extends AbstractComponent /** * Returns the {@code RowDescriptionGenerator} instance used to generate - * descriptions (tooltips) for Grid rows + * descriptions (tooltips) for Grid rows. * * @return the description generator or {@code} null if no generator is set * @@ -6788,7 +6788,7 @@ public class Grid extends AbstractComponent } /** - * Sets the style generator that is used for generating styles for cells + * Sets the style generator that is used for generating styles for cells. * * @param cellStyleGenerator * the cell style generator to set, or <code>null</code> to @@ -6800,7 +6800,7 @@ public class Grid extends AbstractComponent } /** - * Gets the style generator that is used for generating styles for cells + * Gets the style generator that is used for generating styles for cells. * * @return the cell style generator, or <code>null</code> if no generator is * set @@ -6810,7 +6810,7 @@ public class Grid extends AbstractComponent } /** - * Sets the style generator that is used for generating styles for rows + * Sets the style generator that is used for generating styles for rows. * * @param rowStyleGenerator * the row style generator to set, or <code>null</code> to remove @@ -6822,7 +6822,7 @@ public class Grid extends AbstractComponent } /** - * Gets the style generator that is used for generating styles for rows + * Gets the style generator that is used for generating styles for rows. * * @return the row style generator, or <code>null</code> if no generator is * set @@ -7258,7 +7258,7 @@ public class Grid extends AbstractComponent } /** - * Gets the error handler used for the editor + * Gets the error handler used for the editor. * * @see #setErrorHandler(com.vaadin.server.ErrorHandler) * @return the editor error handler, never null @@ -7400,7 +7400,7 @@ public class Grid extends AbstractComponent } /** - * Registers a new column visibility change listener + * Registers a new column visibility change listener. * * @since 7.5.0 * @param listener @@ -7413,7 +7413,7 @@ public class Grid extends AbstractComponent } /** - * Removes a previously registered column visibility change listener + * Removes a previously registered column visibility change listener. * * @since 7.5.0 * @param listener diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/Label.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/Label.java index ca00a8c7e4..4b8c8ebd6f 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/Label.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/Label.java @@ -329,7 +329,7 @@ public class Label extends AbstractLegacyComponent implements Property<String>, } /** - * Value change event + * Value change event. * * @author Vaadin Ltd. * @since 3.0 @@ -339,7 +339,7 @@ public class Label extends AbstractLegacyComponent implements Property<String>, implements Property.ValueChangeEvent { /** - * New instance of text change event + * New instance of text change event. * * @param source * the Source of the event. diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/Slider.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/Slider.java index 9777677e4c..62af89c602 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/Slider.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/Slider.java @@ -155,7 +155,7 @@ public class Slider extends AbstractField<Double> { } /** - * Gets the maximum slider value + * Gets the maximum slider value. * * @return the largest value the slider can have */ @@ -184,7 +184,7 @@ public class Slider extends AbstractField<Double> { } /** - * Gets the minimum slider value + * Gets the minimum slider value. * * @return the smallest value the slider can have */ diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/Table.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/Table.java index 9002f11c77..3c717ac954 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/Table.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/Table.java @@ -1016,7 +1016,7 @@ public class Table extends AbstractSelect implements Action.Container, } /** - * Gets the pixel width of column + * Gets the pixel width of column. * * @param propertyId * @return width of column or -1 when value not set @@ -1271,7 +1271,7 @@ public class Table extends AbstractSelect implements Action.Container, } /** - * Sets the column header for the specified column; + * Sets the column header for the specified column. * * @param propertyId * the propertyId identifying the column. @@ -1813,7 +1813,7 @@ public class Table extends AbstractSelect implements Action.Container, } /** - * Returns the cause(s) for this exception + * Returns the cause(s) for this exception. * * @return the exception(s) which caused this exception */ @@ -4132,7 +4132,7 @@ public class Table extends AbstractSelect implements Action.Container, /* Action container */ /** - * Registers a new action handler for this container + * Registers a new action handler for this container. * * @see com.vaadin.event.Action.Container#addActionHandler(Action.Handler) */ @@ -4185,7 +4185,7 @@ public class Table extends AbstractSelect implements Action.Container, } /** - * Removes all action handlers + * Removes all action handlers. */ public void removeAllActionHandlers() { actionHandlers = null; @@ -4245,7 +4245,7 @@ public class Table extends AbstractSelect implements Action.Container, } /** - * Notifies the component that it is detached from the application + * Notifies the component that it is detached from the application. * * @see Component#detach() */ @@ -5334,7 +5334,7 @@ public class Table extends AbstractSelect implements Action.Container, } /** - * Gets the property id of the column which header was pressed + * Gets the property id of the column which header was pressed. * * @return The column property id */ @@ -5369,7 +5369,7 @@ public class Table extends AbstractSelect implements Action.Container, private final Object columnPropertyId; /** - * Constructor + * Constructor. * * @param source * The source of the component @@ -5385,7 +5385,7 @@ public class Table extends AbstractSelect implements Action.Container, } /** - * Gets the property id of the column which header was pressed + * Gets the property id of the column which header was pressed. * * @return The column property id */ @@ -5402,7 +5402,7 @@ public class Table extends AbstractSelect implements Action.Container, public interface HeaderClickListener extends Serializable { /** - * Called when a user clicks a header column cell + * Called when a user clicks a header column cell. * * @param event * The event which contains information about the column and @@ -5419,7 +5419,7 @@ public class Table extends AbstractSelect implements Action.Container, public interface FooterClickListener extends Serializable { /** - * Called when a user clicks a footer column cell + * Called when a user clicks a footer column cell. * * @param event * The event which contains information about the column and @@ -5455,7 +5455,7 @@ public class Table extends AbstractSelect implements Action.Container, } /** - * Removes a header click listener + * Removes a header click listener. * * @param listener * The listener to remove. @@ -5501,7 +5501,7 @@ public class Table extends AbstractSelect implements Action.Container, } /** - * Removes a footer click listener + * Removes a footer click listener. * * @param listener * The listener to remove. @@ -5521,7 +5521,7 @@ public class Table extends AbstractSelect implements Action.Container, } /** - * Gets the footer caption beneath the rows + * Gets the footer caption beneath the rows. * * @param propertyId * The propertyId of the column * @@ -5602,7 +5602,7 @@ public class Table extends AbstractSelect implements Action.Container, private final Object columnPropertyId; /** - * Constructor + * Constructor. * * @param source * The source of the event @@ -5631,7 +5631,7 @@ public class Table extends AbstractSelect implements Action.Container, } /** - * Get the width in pixels of the column before the resize event + * Get the width in pixels of the column before the resize event. * * @return Width in pixels */ @@ -5640,7 +5640,7 @@ public class Table extends AbstractSelect implements Action.Container, } /** - * Get the width in pixels of the column after the resize event + * Get the width in pixels of the column after the resize event. * * @return Width in pixels */ @@ -5656,7 +5656,7 @@ public class Table extends AbstractSelect implements Action.Container, public interface ColumnResizeListener extends Serializable { /** - * This method is triggered when the column has been resized + * This method is triggered when the column has been resized. * * @param event * The event which contains the column property id, the @@ -5727,7 +5727,7 @@ public class Table extends AbstractSelect implements Action.Container, } /** - * Constructor + * Constructor. * * @param source * The source of the event @@ -5745,7 +5745,7 @@ public class Table extends AbstractSelect implements Action.Container, public interface ColumnReorderListener extends Serializable { /** - * This method is triggered when the column has been reordered + * This method is triggered when the column has been reordered. * * @param event */ @@ -5766,7 +5766,7 @@ public class Table extends AbstractSelect implements Action.Container, private Object propertyId; /** - * Constructor + * Constructor. * * @param source * The source of the event @@ -5779,7 +5779,7 @@ public class Table extends AbstractSelect implements Action.Container, } /** - * Gets the id of the column whose collapse state changed + * Gets the id of the column whose collapse state changed. * * @return the property id of the column */ @@ -5798,7 +5798,7 @@ public class Table extends AbstractSelect implements Action.Container, /** * This method is triggered when the collapse state for a column has - * changed + * changed. * * @param event */ @@ -5875,7 +5875,7 @@ public class Table extends AbstractSelect implements Action.Container, /** * Set the item description generator which generates tooltips for cells and - * rows in the Table + * rows in the Table. * * @param generator * The generator to use or null to disable @@ -5960,7 +5960,7 @@ public class Table extends AbstractSelect implements Action.Container, /** * Pass one String if spanColumns is used, one String for each visible - * column otherwise + * column otherwise. */ public void setText(String... text) { if (text == null || (text.length == 1 && text[0] == null)) { diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/Tree.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/Tree.java index 6a2da71bb7..2d6c1e521e 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/Tree.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/Tree.java @@ -292,7 +292,7 @@ public class Tree extends AbstractSelect implements Container.Hierarchical, /* Expanding and collapsing */ /** - * Check is an item is expanded + * Check is an item is expanded. * * @param itemId * the item id. @@ -481,7 +481,7 @@ public class Tree extends AbstractSelect implements Container.Hierarchical, } /** - * Sets the behavior of the multiselect mode + * Sets the behavior of the multiselect mode. * * @param mode * The mode to set @@ -1029,7 +1029,7 @@ public class Tree extends AbstractSelect implements Container.Hierarchical, private final Object expandedItemId; /** - * New instance of options change event + * New instance of options change event. * * @param source * the Source of the event. @@ -1123,7 +1123,7 @@ public class Tree extends AbstractSelect implements Container.Hierarchical, /* Collapse event */ /** - * Collapse event + * Collapse event. * * @author Vaadin Ltd. * @since 3.0 @@ -1272,7 +1272,7 @@ public class Tree extends AbstractSelect implements Container.Hierarchical, } /** - * Removes all action handlers + * Removes all action handlers. */ public void removeAllActionHandlers() { actionHandlers = null; @@ -1758,7 +1758,7 @@ public class Tree extends AbstractSelect implements Container.Hierarchical, /** * Constructs a criteria that accepts the drag if the targeted Item is a - * descendant of Item identified by given id + * descendant of Item identified by given id. * * @param parentItemId * the item identifier of the parent node @@ -1817,7 +1817,7 @@ public class Tree extends AbstractSelect implements Container.Hierarchical, /** * Set the item description generator which generates tooltips for the tree - * items + * items. * * @param generator * The generator to use or null to disable @@ -1832,7 +1832,7 @@ public class Tree extends AbstractSelect implements Container.Hierarchical, /** * Get the item description generator which generates tooltips for tree - * items + * items. */ public ItemDescriptionGenerator getItemDescriptionGenerator() { return itemDescriptionGenerator; diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/Upload.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/Upload.java index a9a09ae49b..df95453a64 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/Upload.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/Upload.java @@ -623,7 +623,7 @@ public class Upload extends AbstractLegacyComponent } /** - * Listener for {@link ChangeEvent} + * Listener for {@link ChangeEvent}. * * @since 7.2 */ @@ -829,7 +829,7 @@ public class Upload extends AbstractLegacyComponent } /** - * Adds a filename change event listener + * Adds a filename change event listener. * * @param listener * the Listener to add, not null @@ -840,7 +840,7 @@ public class Upload extends AbstractLegacyComponent } /** - * Removes a filename change event listener + * Removes a filename change event listener. * * @param listener * the listener to be removed @@ -1048,7 +1048,7 @@ public class Upload extends AbstractLegacyComponent @Deprecated public interface ProgressListener extends Serializable { /** - * Updates progress to listener + * Updates progress to listener. * * @param readBytes * bytes transferred diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/CalendarComponentEvent.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/CalendarComponentEvent.java index a4b9901f22..afb2783552 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/CalendarComponentEvent.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/CalendarComponentEvent.java @@ -31,7 +31,7 @@ import com.vaadin.v7.ui.Calendar; public class CalendarComponentEvent extends Component.Event { /** - * Set the source of the event + * Set the source of the event. * * @param source * The source calendar diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/CalendarComponentEvents.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/CalendarComponentEvents.java index 0359c72272..f20cce2186 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/CalendarComponentEvents.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/CalendarComponentEvents.java @@ -37,7 +37,7 @@ import com.vaadin.v7.ui.components.calendar.event.CalendarEvent; public interface CalendarComponentEvents extends Serializable { /** - * Notifier interface for notifying listener of calendar events + * Notifier interface for notifying listener of calendar events. */ @Deprecated public interface CalendarEventNotifier extends Serializable { @@ -119,7 +119,7 @@ public interface CalendarComponentEvents extends Serializable { } /** - * Handler interface for when events are being dragged on the calendar + * Handler interface for when events are being dragged on the calendar. * */ @Deprecated @@ -526,7 +526,7 @@ public interface CalendarComponentEvents extends Serializable { } /** - * EventResize is sent when an event is resized + * EventResize is sent when an event is resized. */ @SuppressWarnings("serial") @Deprecated @@ -568,7 +568,7 @@ public interface CalendarComponentEvents extends Serializable { } /** - * Returns the updated start date/time of the event + * Returns the updated start date/time of the event. * * @return The new date for the event */ @@ -587,7 +587,7 @@ public interface CalendarComponentEvents extends Serializable { } /** - * Returns the updates end date/time of the event + * Returns the updates end date/time of the event. * * @return The new date for the event */ diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/CalendarDateRange.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/CalendarDateRange.java index ff93a84c35..293975db1b 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/CalendarDateRange.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/CalendarDateRange.java @@ -39,7 +39,7 @@ public class CalendarDateRange implements Serializable { private final transient TimeZone tz; /** - * Constructor + * Constructor. * * @param start * The start date and time of the date range @@ -54,7 +54,7 @@ public class CalendarDateRange implements Serializable { } /** - * Get the start date of the date range + * Get the start date of the date range. * * @return the start Date of the range */ @@ -63,7 +63,7 @@ public class CalendarDateRange implements Serializable { } /** - * Get the end date of the date range + * Get the end date of the date range. * * @return the end Date of the range */ @@ -72,7 +72,7 @@ public class CalendarDateRange implements Serializable { } /** - * Is a date in the date range + * Is a date in the date range. * * @param date * The date to check diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/CalendarTargetDetails.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/CalendarTargetDetails.java index 2f81ae3246..6575774c26 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/CalendarTargetDetails.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/CalendarTargetDetails.java @@ -53,7 +53,7 @@ public class CalendarTargetDetails extends TargetDetailsImpl { } /** - * Does the dropped item have a time associated with it + * Does the dropped item have a time associated with it. * * @param hasDropTime */ diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/ContainerEventProvider.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/ContainerEventProvider.java index ccaf1f60d5..7b7b409219 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/ContainerEventProvider.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/ContainerEventProvider.java @@ -112,7 +112,7 @@ public class ContainerEventProvider private Object allDayProperty = ALL_DAY_PROPERTY; /** - * Constructor + * Constructor. * * @param container * Container to use as a data source. @@ -123,7 +123,7 @@ public class ContainerEventProvider } /** - * Set the container data source + * Set the container data source. * * @param container * The container to use as datasource @@ -138,7 +138,7 @@ public class ContainerEventProvider } /** - * Returns the container used as data source + * Returns the container used as data source. * */ public Container.Indexed getContainerDataSource() { @@ -299,77 +299,77 @@ public class ContainerEventProvider } /** - * Get the property which provides the caption of the event + * Get the property which provides the caption of the event. */ public Object getCaptionProperty() { return captionProperty; } /** - * Set the property which provides the caption of the event + * Set the property which provides the caption of the event. */ public void setCaptionProperty(Object captionProperty) { this.captionProperty = captionProperty; } /** - * Get the property which provides the description of the event + * Get the property which provides the description of the event. */ public Object getDescriptionProperty() { return descriptionProperty; } /** - * Set the property which provides the description of the event + * Set the property which provides the description of the event. */ public void setDescriptionProperty(Object descriptionProperty) { this.descriptionProperty = descriptionProperty; } /** - * Get the property which provides the starting date and time of the event + * Get the property which provides the starting date and time of the event. */ public Object getStartDateProperty() { return startDateProperty; } /** - * Set the property which provides the starting date and time of the event + * Set the property which provides the starting date and time of the event. */ public void setStartDateProperty(Object startDateProperty) { this.startDateProperty = startDateProperty; } /** - * Get the property which provides the ending date and time of the event + * Get the property which provides the ending date and time of the event. */ public Object getEndDateProperty() { return endDateProperty; } /** - * Set the property which provides the ending date and time of the event + * Set the property which provides the ending date and time of the event. */ public void setEndDateProperty(Object endDateProperty) { this.endDateProperty = endDateProperty; } /** - * Get the property which provides the style name for the event + * Get the property which provides the style name for the event. */ public Object getStyleNameProperty() { return styleNameProperty; } /** - * Set the property which provides the style name for the event + * Set the property which provides the style name for the event. */ public void setStyleNameProperty(Object styleNameProperty) { this.styleNameProperty = styleNameProperty; } /** - * Set the all day property for the event + * Set the all day property for the event. * * @since 7.3.4 */ @@ -378,7 +378,7 @@ public class ContainerEventProvider } /** - * Get the all day property for the event + * Get the all day property for the event. * * @since 7.3.4 */ @@ -451,7 +451,7 @@ public class ContainerEventProvider * If you are reusing the container which previously have been attached to * this ContainerEventProvider call this method to remove this event * providers container listeners before attaching it to an other - * ContainerEventProvider + * ContainerEventProvider. */ public void detachContainerDataSource() { ignoreContainerEvents(); diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/event/BasicEvent.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/event/BasicEvent.java index 114e696058..c0384be12d 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/event/BasicEvent.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/event/BasicEvent.java @@ -43,14 +43,14 @@ public class BasicEvent implements EditableCalendarEvent, EventChangeNotifier { private boolean isAllDay; /** - * Default constructor + * Default constructor. */ public BasicEvent() { } /** - * Constructor for creating an event with the same start and end date + * Constructor for creating an event with the same start and end date. * * @param caption * The caption for the event diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/event/BasicEventProvider.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/event/BasicEventProvider.java index e84a8384f8..5df4939824 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/event/BasicEventProvider.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/event/BasicEventProvider.java @@ -81,7 +81,7 @@ public class BasicEventProvider implements CalendarEditableEventProvider, } /** - * Does this event provider container this event + * Does this event provider container this event. * * @param event * The event to check for diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/event/CalendarEditableEventProvider.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/event/CalendarEditableEventProvider.java index 6092fe2208..1fccbfe1ab 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/event/CalendarEditableEventProvider.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/event/CalendarEditableEventProvider.java @@ -17,7 +17,7 @@ package com.vaadin.v7.ui.components.calendar.event; /** - * An event provider which allows adding and removing events + * An event provider which allows adding and removing events. * * @since 7.1.0 * @author Vaadin Ltd. @@ -26,7 +26,7 @@ package com.vaadin.v7.ui.components.calendar.event; public interface CalendarEditableEventProvider extends CalendarEventProvider { /** - * Adds an event to the event provider + * Adds an event to the event provider. * * @param event * The event to add @@ -34,7 +34,7 @@ public interface CalendarEditableEventProvider extends CalendarEventProvider { void addEvent(CalendarEvent event); /** - * Removes an event from the event provider + * Removes an event from the event provider. * * @param event * The event diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/event/CalendarEventProvider.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/event/CalendarEventProvider.java index 831b6c1731..70b4c4bb40 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/event/CalendarEventProvider.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/event/CalendarEventProvider.java @@ -106,7 +106,8 @@ public interface CalendarEventProvider extends Serializable { void addEventSetChangeListener(EventSetChangeListener listener); /** - * Remove a listener which listens to {@link EventSetChangeEvent}-events + * Remove a listener which listens to + * {@link EventSetChangeEvent}-events. * * @param listener * The listener to remove diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/event/EditableCalendarEvent.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/event/EditableCalendarEvent.java index eb7d12a058..0aa90ebe81 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/event/EditableCalendarEvent.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/event/EditableCalendarEvent.java @@ -72,7 +72,7 @@ public interface EditableCalendarEvent extends CalendarEvent { void setStart(Date start); /** - * Set the style name for the event used for styling the event cells + * Set the style name for the event used for styling the event cells. * * @param styleName * The stylename to use @@ -81,7 +81,7 @@ public interface EditableCalendarEvent extends CalendarEvent { void setStyleName(String styleName); /** - * Does the event span the whole day. If so then set this to true + * Does the event span the whole day. If so then set this to true. * * @param isAllDay * True if the event spans the whole day. In this case the start diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/handler/BasicBackwardHandler.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/handler/BasicBackwardHandler.java index 7d8206c8f5..2a770204d1 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/handler/BasicBackwardHandler.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/handler/BasicBackwardHandler.java @@ -81,7 +81,7 @@ public class BasicBackwardHandler implements BackwardHandler { } /** - * Set the start and end dates for the event + * Set the start and end dates for the event. * * @param event * The event that the start and end dates should be set diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/handler/BasicDateClickHandler.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/handler/BasicDateClickHandler.java index d90d94d774..eca2a31815 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/handler/BasicDateClickHandler.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/handler/BasicDateClickHandler.java @@ -55,7 +55,7 @@ public class BasicDateClickHandler implements DateClickHandler { } /** - * Set the start and end dates for the event + * Set the start and end dates for the event. * * @param event * The event that the start and end dates should be set diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/handler/BasicEventMoveHandler.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/handler/BasicEventMoveHandler.java index cb1422d90b..3893450c24 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/handler/BasicEventMoveHandler.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/handler/BasicEventMoveHandler.java @@ -59,7 +59,7 @@ public class BasicEventMoveHandler implements EventMoveHandler { } /** - * Set the start and end dates for the event + * Set the start and end dates for the event. * * @param event * The event that the start and end dates should be set diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/handler/BasicEventResizeHandler.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/handler/BasicEventResizeHandler.java index 5a722e9365..d4ac3ae9a2 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/handler/BasicEventResizeHandler.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/handler/BasicEventResizeHandler.java @@ -55,7 +55,7 @@ public class BasicEventResizeHandler implements EventResizeHandler { } /** - * Set the start and end dates for the event + * Set the start and end dates for the event. * * @param event * The event that the start and end dates should be set diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/handler/BasicForwardHandler.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/handler/BasicForwardHandler.java index b354a7cdae..abeb19840c 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/handler/BasicForwardHandler.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/handler/BasicForwardHandler.java @@ -79,7 +79,7 @@ public class BasicForwardHandler implements ForwardHandler { } /** - * Set the start and end dates for the event + * Set the start and end dates for the event. * * @param event * The event that the start and end dates should be set diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/handler/BasicWeekClickHandler.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/handler/BasicWeekClickHandler.java index 7827127973..ec7e1bf9e3 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/handler/BasicWeekClickHandler.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/calendar/handler/BasicWeekClickHandler.java @@ -66,7 +66,7 @@ public class BasicWeekClickHandler implements WeekClickHandler { } /** - * Set the start and end dates for the event + * Set the start and end dates for the event. * * @param event * The event that the start and end dates should be set diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/colorpicker/ColorPickerGradient.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/colorpicker/ColorPickerGradient.java index 6dab06e69b..e479fe7ac8 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/colorpicker/ColorPickerGradient.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/colorpicker/ColorPickerGradient.java @@ -29,8 +29,8 @@ import com.vaadin.v7.ui.AbstractColorPicker.Coordinates2Color; * @since 7.0.0 */ @Deprecated -public class ColorPickerGradient extends AbstractComponent implements - ColorSelector { +public class ColorPickerGradient extends AbstractComponent + implements ColorSelector { private static final Method COLOR_CHANGE_METHOD; static { @@ -129,7 +129,7 @@ public class ColorPickerGradient extends AbstractComponent implements } /** - * Notifies the listeners that the color has changed + * Notifies the listeners that the color has changed. * * @param color * The color which it changed to diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/colorpicker/ColorPickerGrid.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/colorpicker/ColorPickerGrid.java index 4b96f0de12..0326f1e224 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/colorpicker/ColorPickerGrid.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/colorpicker/ColorPickerGrid.java @@ -202,7 +202,7 @@ public class ColorPickerGrid extends AbstractComponent } /** - * Adds a color change listener + * Adds a color change listener. * * @param listener * The color change listener @@ -218,7 +218,7 @@ public class ColorPickerGrid extends AbstractComponent } /** - * Removes a color change listener + * Removes a color change listener. * * @param listener * The listener @@ -261,7 +261,7 @@ public class ColorPickerGrid extends AbstractComponent } /** - * Notifies the listeners that a color change has occurred + * Notifies the listeners that a color change has occurred. * * @param color * The color which it changed to diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/colorpicker/ColorPickerHistory.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/colorpicker/ColorPickerHistory.java index 0cab53c13e..5f4161ccab 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/colorpicker/ColorPickerHistory.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/colorpicker/ColorPickerHistory.java @@ -183,7 +183,7 @@ public class ColorPickerHistory extends CustomComponent } /** - * Adds a color change listener + * Adds a color change listener. * * @param listener * The listener @@ -194,7 +194,7 @@ public class ColorPickerHistory extends CustomComponent } /** - * Removes a color change listener + * Removes a color change listener. * * @param listener * The listener diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/colorpicker/ColorPickerPopup.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/colorpicker/ColorPickerPopup.java index 71d8ef7a2c..5ce6295d87 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/colorpicker/ColorPickerPopup.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/colorpicker/ColorPickerPopup.java @@ -490,7 +490,7 @@ public class ColorPickerPopup extends Window } /** - * Notifies the listeners that the color changed + * Notifies the listeners that the color changed. */ public void fireColorChanged() { fireEvent(new ColorChangeEvent(this, getColor())); @@ -627,7 +627,7 @@ public class ColorPickerPopup extends Window } /** - * Set RGB tab visibility + * Set RGB tab visibility. * * @param visible * The visibility of the RGB tab @@ -643,7 +643,7 @@ public class ColorPickerPopup extends Window } /** - * Set HSV tab visibility + * Set HSV tab visibility. * * @param visible * The visibility of the HSV tab @@ -659,7 +659,7 @@ public class ColorPickerPopup extends Window } /** - * Set Swatches tab visibility + * Set Swatches tab visibility. * * @param visible * The visibility of the Swatches tab @@ -675,7 +675,7 @@ public class ColorPickerPopup extends Window } /** - * Set the History visibility + * Set the History visibility. * * @param visible */ @@ -685,7 +685,7 @@ public class ColorPickerPopup extends Window } /** - * Set the preview visibility + * Set the preview visibility. * * @param visible */ diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/colorpicker/ColorPickerPreview.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/colorpicker/ColorPickerPreview.java index ba4ba7e82f..bcdf11b3c9 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/colorpicker/ColorPickerPreview.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/colorpicker/ColorPickerPreview.java @@ -189,7 +189,7 @@ public class ColorPickerPreview extends CssLayout } /** - * Called when the component is refreshing + * Called when the component is refreshing. */ @Override protected String getCss(Component c) { diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/renderers/ProgressBarRenderer.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/renderers/ProgressBarRenderer.java index 76210bf3bc..470eb9ee3c 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/renderers/ProgressBarRenderer.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/renderers/ProgressBarRenderer.java @@ -29,7 +29,7 @@ import elemental.json.JsonValue; public class ProgressBarRenderer extends AbstractRenderer<Double> { /** - * Creates a new text renderer + * Creates a new text renderer. */ public ProgressBarRenderer() { super(Double.class, null); diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/renderers/TextRenderer.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/renderers/TextRenderer.java index 4103e15193..67ae687b1a 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/renderers/TextRenderer.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/renderers/TextRenderer.java @@ -27,14 +27,14 @@ import com.vaadin.v7.ui.Grid.AbstractRenderer; public class TextRenderer extends AbstractRenderer<String> { /** - * Creates a new text renderer + * Creates a new text renderer. */ public TextRenderer() { this(""); } /** - * Creates a new text renderer + * Creates a new text renderer. * * @param nullRepresentation * the textual representation of {@code null} value diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/themes/ChameleonTheme.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/themes/ChameleonTheme.java index fabba1a6f9..bc6ba5c0ee 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/themes/ChameleonTheme.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/themes/ChameleonTheme.java @@ -18,8 +18,9 @@ package com.vaadin.v7.ui.themes; import com.vaadin.ui.themes.ValoTheme; /** - * @deprecated As of 8.0, no replacement available, only {@link ValoTheme} is supported. -*/ + * @deprecated As of 8.0, no replacement available, only {@link ValoTheme} is + * supported. + */ @Deprecated public class ChameleonTheme extends BaseTheme { @@ -30,32 +31,32 @@ public class ChameleonTheme extends BaseTheme { **************************************************************************/ /** - * Large font for main application headings + * Large font for main application headings. */ public static final String LABEL_H1 = "h1"; /** - * Large font for different sections in the application + * Large font for different sections in the application. */ public static final String LABEL_H2 = "h2"; /** - * Font for sub-section headers + * Font for sub-section headers. */ public static final String LABEL_H3 = "h3"; /** - * Font for paragraphs headers + * Font for paragraphs headers. */ public static final String LABEL_H4 = "h4"; /** - * Big font for important or emphasized texts + * Big font for important or emphasized texts. */ public static final String LABEL_BIG = "big"; /** - * Small and a little lighter font + * Small and a little lighter font. */ public static final String LABEL_SMALL = "small"; @@ -67,22 +68,23 @@ public class ChameleonTheme extends BaseTheme { public static final String LABEL_TINY = "tiny"; /** - * Adds color to the text (usually the alternate color of the theme) + * Adds color to the text (usually the alternate color of the theme). */ public static final String LABEL_COLOR = "color"; /** - * Adds a warning icon on the left side and a yellow background to the label + * Adds a warning icon on the left side and a yellow background to the + * label. */ public static final String LABEL_WARNING = "warning"; /** - * Adds an error icon on the left side and a red background to the label + * Adds an error icon on the left side and a red background to the label. */ public static final String LABEL_ERROR = "error"; /** - * Adds a spinner icon on the left side of the label + * Adds a spinner icon on the left side of the label. */ public static final String LABEL_LOADING = "loading"; @@ -98,12 +100,12 @@ public class ChameleonTheme extends BaseTheme { public static final String BUTTON_DEFAULT = "default"; /** - * Small sized button, use for context specific actions for example + * Small sized button, use for context specific actions for example. */ public static final String BUTTON_SMALL = "small"; /** - * Big button, use to get more attention for the button action + * Big button, use to get more attention for the button action. */ public static final String BUTTON_BIG = "big"; @@ -138,7 +140,7 @@ public class ChameleonTheme extends BaseTheme { public static final String BUTTON_ICON_ON_RIGHT = "icon-on-right"; /** - * Removes the button caption and only shows its icon + * Removes the button caption and only shows its icon. */ public static final String BUTTON_ICON_ONLY = "icon-only"; @@ -153,17 +155,17 @@ public class ChameleonTheme extends BaseTheme { **************************************************************************/ /** - * Small sized text field with small font + * Small sized text field with small font. */ public static final String TEXTFIELD_SMALL = "small"; /** - * Large sized text field with big font + * Large sized text field with big font. */ public static final String TEXTFIELD_BIG = "big"; /** - * Adds a magnifier icon on the left side of the fields text + * Adds a magnifier icon on the left side of the fields text. */ public static final String TEXTFIELD_SEARCH = "search"; @@ -172,22 +174,22 @@ public class ChameleonTheme extends BaseTheme { **************************************************************************/ /** - * Small sized select with small font + * Small sized select with small font. */ public static final String SELECT_SMALL = "small"; /** - * Large sized select with big font + * Large sized select with big font. */ public static final String SELECT_BIG = "big"; /** - * Adds a magnifier icon on the left side of the fields text + * Adds a magnifier icon on the left side of the fields text. */ public static final String COMBOBOX_SEARCH = "search"; /** - * Adds a magnifier icon on the left side of the fields text + * Adds a magnifier icon on the left side of the fields text. */ public static final String COMBOBOX_SELECT_BUTTON = "select-button"; @@ -196,12 +198,12 @@ public class ChameleonTheme extends BaseTheme { **************************************************************************/ /** - * Small sized date field with small font + * Small sized date field with small font. */ public static final String DATEFIELD_SMALL = "small"; /** - * Large sized date field with big font + * Large sized date field with big font. */ public static final String DATEFIELD_BIG = "big"; @@ -210,19 +212,19 @@ public class ChameleonTheme extends BaseTheme { **************************************************************************/ /** - * Removes borders and background color from the panel + * Removes borders and background color from the panel. */ public static final String PANEL_BORDERLESS = "borderless"; /** * Adds a more vibrant header for the panel, using the alternate color of * the theme, and adds slight rounded corners (not supported in all - * browsers) + * browsers). */ public static final String PANEL_BUBBLE = "bubble"; /** - * Removes borders and background color from the panel + * Removes borders and background color from the panel. */ public static final String PANEL_LIGHT = "light"; @@ -231,7 +233,7 @@ public class ChameleonTheme extends BaseTheme { **************************************************************************/ /** - * Reduces the split handle to a minimal size (1 pixel) + * Reduces the split handle to a minimal size (1 pixel). */ public static final String SPLITPANEL_SMALL = "small"; @@ -240,7 +242,7 @@ public class ChameleonTheme extends BaseTheme { **************************************************************************/ /** - * Removes borders and background color from the tab sheet + * Removes borders and background color from the tab sheet. */ public static final String TABSHEET_BORDERLESS = "borderless"; @@ -249,7 +251,7 @@ public class ChameleonTheme extends BaseTheme { **************************************************************************/ /** - * Makes the accordion background opaque (non-transparent) + * Makes the accordion background opaque (non-transparent). */ public static final String ACCORDION_OPAQUE = "opaque"; @@ -258,17 +260,17 @@ public class ChameleonTheme extends BaseTheme { **************************************************************************/ /** - * Removes borders and background color from the table + * Removes borders and background color from the table. */ public static final String TABLE_BORDERLESS = "borderless"; /** - * Makes the column header and content font size smaller inside the table + * Makes the column header and content font size smaller inside the table. */ public static final String TABLE_SMALL = "small"; /** - * Makes the column header and content font size bigger inside the table + * Makes the column header and content font size bigger inside the table. */ public static final String TABLE_BIG = "big"; @@ -282,7 +284,7 @@ public class ChameleonTheme extends BaseTheme { **************************************************************************/ /** - * Reduces the height of the progress bar + * Reduces the height of the progress bar. */ public static final String PROGRESS_INDICATOR_SMALL = "small"; diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/themes/Reindeer.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/themes/Reindeer.java index 2d288a66d9..8e700fe0a4 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/themes/Reindeer.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/themes/Reindeer.java @@ -24,7 +24,8 @@ import com.vaadin.ui.VerticalSplitPanel; import com.vaadin.ui.themes.ValoTheme; /** - * @deprecated As of 8.0, no replacement available, only {@link ValoTheme} is supported. + * @deprecated As of 8.0, no replacement available, only {@link ValoTheme} is + * supported. */ @Deprecated public class Reindeer extends BaseTheme { @@ -38,17 +39,17 @@ public class Reindeer extends BaseTheme { **************************************************************************/ /** - * Large font for main application headings + * Large font for main application headings. */ public static final String LABEL_H1 = "h1"; /** - * Large font for different sections in the application + * Large font for different sections in the application. */ public static final String LABEL_H2 = "h2"; /** - * Small and a little lighter font + * Small and a little lighter font. */ public static final String LABEL_SMALL = "light"; @@ -66,7 +67,7 @@ public class Reindeer extends BaseTheme { public static final String BUTTON_DEFAULT = "primary"; /** - * Small sized button, use for context specific actions for example + * Small sized button, use for context specific actions for example. */ public static final String BUTTON_SMALL = "small"; @@ -77,7 +78,7 @@ public class Reindeer extends BaseTheme { **************************************************************************/ /** - * Small sized text field with small font + * Small sized text field with small font. */ public static final String TEXTFIELD_SMALL = "small"; @@ -88,7 +89,7 @@ public class Reindeer extends BaseTheme { **************************************************************************/ /** - * Removes borders and background color from the panel + * Removes borders and background color from the panel. */ public static final String PANEL_LIGHT = "light"; @@ -111,7 +112,7 @@ public class Reindeer extends BaseTheme { **************************************************************************/ /** - * Reduces the split handle to a minimal size (1 pixel) + * Reduces the split handle to a minimal size (1 pixel). */ public static final String SPLITPANEL_SMALL = "small"; @@ -156,7 +157,7 @@ public class Reindeer extends BaseTheme { **************************************************************************/ /** - * Removes borders from the table + * Removes borders from the table. */ public static final String TABLE_BORDERLESS = "borderless"; @@ -173,8 +174,9 @@ public class Reindeer extends BaseTheme { /** * Changes the background of a layout to white. Applies to - * {@link VerticalLayout}, {@link HorizontalLayout}, {@link com.vaadin.ui.GridLayout GridLayout}, - * {@link FormLayout}, {@link CssLayout}, {@link VerticalSplitPanel} and + * {@link VerticalLayout}, {@link HorizontalLayout}, + * {@link com.vaadin.ui.GridLayout GridLayout}, {@link FormLayout}, + * {@link CssLayout}, {@link VerticalSplitPanel} and * {@link HorizontalSplitPanel}. * <p> * <em>Does not revert any contained components back to normal if some @@ -184,8 +186,9 @@ public class Reindeer extends BaseTheme { /** * Changes the background of a layout to a shade of blue. Applies to - * {@link VerticalLayout}, {@link HorizontalLayout}, {@link com.vaadin.ui.GridLayout GridLayout}, - * {@link FormLayout}, {@link CssLayout}, {@link VerticalSplitPanel} and + * {@link VerticalLayout}, {@link HorizontalLayout}, + * {@link com.vaadin.ui.GridLayout GridLayout}, {@link FormLayout}, + * {@link CssLayout}, {@link VerticalSplitPanel} and * {@link HorizontalSplitPanel}. * <p> * <em>Does not revert any contained components back to normal if some @@ -202,7 +205,8 @@ public class Reindeer extends BaseTheme { * </p> * <p> * Applies to {@link VerticalLayout}, {@link HorizontalLayout}, - * {@link com.vaadin.ui.GridLayout GridLayout}, {@link FormLayout} and {@link CssLayout}. + * {@link com.vaadin.ui.GridLayout GridLayout}, {@link FormLayout} and + * {@link CssLayout}. * </p> * */ diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/themes/Runo.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/themes/Runo.java index 1ab1d3b7fe..727b44ce37 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/themes/Runo.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/themes/Runo.java @@ -18,7 +18,8 @@ package com.vaadin.v7.ui.themes; import com.vaadin.ui.themes.ValoTheme; /** - * @deprecated As of 8.0, no replacement available, only {@link ValoTheme} is supported. + * @deprecated As of 8.0, no replacement available, only {@link ValoTheme} is + * supported. */ @Deprecated public class Runo extends BaseTheme { @@ -36,12 +37,13 @@ public class Runo extends BaseTheme { **************************************************************************/ /** - * Small sized button, use for context specific actions for example + * Small sized button, use for context specific actions for example. */ public static final String BUTTON_SMALL = "small"; /** - * Big sized button, use to gather much attention for some particular action + * Big sized button, use to gather much attention for some particular + * action. */ public static final String BUTTON_BIG = "big"; @@ -59,7 +61,7 @@ public class Runo extends BaseTheme { **************************************************************************/ /** - * Removes borders and background color from the panel + * Removes borders and background color from the panel. */ public static final String PANEL_LIGHT = "light"; @@ -82,7 +84,7 @@ public class Runo extends BaseTheme { **************************************************************************/ /** - * Smaller tabs, no border and background for content area + * Smaller tabs, no border and background for content area. */ public static final String TABSHEET_SMALL = "light"; @@ -165,7 +167,7 @@ public class Runo extends BaseTheme { **************************************************************************/ /** - * Small sized text field with small font + * Small sized text field with small font. */ public static final String TEXTFIELD_SMALL = "small"; |