Some Checkstyle fixes. (#12379)

- Added and updated JavaDocs.
- Deprecated unused fields and methods that update them.
- Suppressed unavoidable deprecated calls.
- Switched other deprecated calls to use currently recommended calls.

Author: Ansku

client/src/main/java/com/vaadin/client/ui/VPopupView.java

@@ -46,9 +46,16 @@
 import com.vaadin.client.ui.popupview.VisibilityChangeEvent;
 import com.vaadin.client.ui.popupview.VisibilityChangeHandler;
 
+/**
+ * Widget class for the PopupView component.
+ *
+ * @author Vaadin Ltd
+ *
+ */
 public class VPopupView extends HTML
         implements HasEnabled, Iterable<Widget>, DeferredWorker {
 
+    /** Default classname for this widget. */
     public static final String CLASSNAME = "v-popupview";
 
     /**
@@ -113,7 +120,12 @@ public void onClose(CloseEvent<PopupPanel> event) {
         popup.setAutoHideOnHistoryEventsEnabled(false);
     }
 
-    /** For internal use only. May be removed or replaced in the future. */
+    /**
+     * For internal use only. May be removed or replaced in the future.
+     *
+     * @param popup
+     *            the popup that should be shown
+     */
     public void preparePopup(final CustomPopup popup) {
         popup.setVisible(true);
         popup.setWidget(loading);
@@ -130,6 +142,7 @@ public void preparePopup(final CustomPopup popup) {
      * Can be overridden to customize the popup position.
      *
      * @param popup
+     *            the popup whose position should be updated
      */
     public void showPopup(final CustomPopup popup) {
         popup.setPopupPosition(0, 0);
@@ -220,6 +233,7 @@ public void setEnabled(boolean enabled) {
      * (other than it being a VOverlay) is to be considered private and
      * potentially subject to change.
      */
+    @SuppressWarnings("deprecation")
     public class CustomPopup extends VOverlay
             implements StateChangeEvent.StateChangeHandler {
 
@@ -237,6 +251,11 @@ public class CustomPopup extends VOverlay
 
         private ShortcutActionHandler shortcutActionHandler;
 
+        /**
+         * Constructs a popup widget for VPopupView.
+         *
+         * @see CustomPopup
+         */
         public CustomPopup() {
             super(true, false); // autoHide, not modal
             setOwner(VPopupView.this);
@@ -361,6 +380,13 @@ public boolean remove(Widget w) {
             return super.remove(w);
         }
 
+        /**
+         * Sets the connector of the popup content widget. Should not be
+         * {@code null}.
+         *
+         * @param newPopupComponent
+         *            the connector to set
+         */
         public void setPopupConnector(ComponentConnector newPopupComponent) {
 
             if (newPopupComponent != popupComponentConnector) {
@@ -377,6 +403,15 @@ public void setPopupConnector(ComponentConnector newPopupComponent) {
 
         }
 
+        /**
+         * Should this popup automatically hide when the user takes the mouse
+         * cursor out of the popup area? If this is {@code false}, the user must
+         * click outside the popup to close it. The default is {@code true}.
+         *
+         * @param hideOnMouseOut
+         *            {@code true} if this popup should hide when mouse is moved
+         *            away, {@code false} otherwise
+         */
         public void setHideOnMouseOut(boolean hideOnMouseOut) {
             this.hideOnMouseOut = hideOnMouseOut;
         }
@@ -405,6 +440,14 @@ private ShortcutActionHandler findShortcutActionHandler() {
         }
     }
 
+    /**
+     * Adds the given visibility change handler to this widget.
+     *
+     * @param visibilityChangeHandler
+     *            the handler that should be triggered when visibility changes
+     * @return the registration object for removing the given handler when no
+     *         longer needed
+     */
     public HandlerRegistration addVisibilityChangeHandler(
             final VisibilityChangeHandler visibilityChangeHandler) {
         return addHandler(visibilityChangeHandler,

client/src/main/java/com/vaadin/client/ui/VProgressBar.java

@@ -36,6 +36,7 @@
  */
 public class VProgressBar extends Widget implements HasEnabled {
 
+    /** Default classname for this widget. */
     public static final String PRIMARY_STYLE_NAME = "v-progressbar";
 
     Element wrapper = DOM.createDiv();
@@ -45,6 +46,10 @@ public class VProgressBar extends Widget implements HasEnabled {
     private float state = 0.0f;
     private boolean enabled;
 
+    /**
+     * Constructs a widget for the ProgressBar component or renderer.
+     */
+    @SuppressWarnings("deprecation")
     public VProgressBar() {
         setElement(DOM.createDiv());
         getElement().appendChild(wrapper);
@@ -68,20 +73,52 @@ public void setStylePrimaryName(String style) {
 
     }
 
+    /**
+     * Sets whether or not this progress indicator is indeterminate. In
+     * indeterminate mode there is an animation indicating that the task is
+     * running but without providing any information about the current progress.
+     *
+     * @param indeterminate
+     *            {@code true} to set to indeterminate mode, {@code false}
+     *            otherwise
+     */
     public void setIndeterminate(boolean indeterminate) {
         this.indeterminate = indeterminate;
         setStyleName(getStylePrimaryName() + "-indeterminate", indeterminate);
     }
 
+    /**
+     * Sets the value of this progress bar. The value is a {@code float} between
+     * 0 and 1 where 0 represents no progress at all and 1 represents fully
+     * completed.
+     *
+     * @param state
+     *            the new progress value
+     */
     public void setState(float state) {
         final int size = Math.round(100 * state);
         indicator.getStyle().setWidth(size, Unit.PCT);
     }
 
+    /**
+     * Gets whether or not this progress indicator is indeterminate. In
+     * indeterminate mode there is an animation indicating that the task is
+     * running but without providing any information about the current progress.
+     *
+     * @return {@code true} if set to indeterminate mode, {@code false}
+     *         otherwise
+     */
     public boolean isIndeterminate() {
         return indeterminate;
     }
 
+    /**
+     * Returns the current value of this progress bar. The value is a
+     * {@code float} between 0 and 1 where 0 represents no progress at all and 1
+     * represents fully completed.
+     *
+     * @return the current progress value
+     */
     public float getState() {
         return state;
     }

client/src/main/java/com/vaadin/client/ui/VRadioButtonGroup.java

@@ -53,8 +53,11 @@
 public class VRadioButtonGroup extends FocusableFlowPanelComposite
         implements Field, ClickHandler, HasEnabled {
 
+    /** Default classname for this widget. */
     public static final String CLASSNAME = "v-select-optiongroup";
+    /** Default classname for all radio buttons within this widget. */
     public static final String CLASSNAME_OPTION = "v-select-option";
+    /** Default classname for the selected radio button within this widget. */
     public static final String CLASSNAME_OPTION_SELECTED = "v-select-option-selected";
 
     private final Map<RadioButton, JsonObject> optionsToItems;
@@ -72,6 +75,9 @@ public class VRadioButtonGroup extends FocusableFlowPanelComposite
     private final String groupId;
     private List<Consumer<JsonObject>> selectionChangeListeners;
 
+    /**
+     * Constructs a widget for the RadioButtonGroup component.
+     */
     public VRadioButtonGroup() {
         groupId = DOM.createUniqueId();
         getWidget().setStyleName(CLASSNAME);
@@ -80,8 +86,11 @@ public VRadioButtonGroup() {
         selectionChangeListeners = new ArrayList<>();
     }
 
-    /*
-     * Build all the options
+    /**
+     * Build all the options.
+     *
+     * @param items
+     *            the list of options
      */
     public void buildOptions(List<JsonObject> items) {
         Roles.getRadiogroupRole().set(getElement());
@@ -194,16 +203,26 @@ public void onClick(ClickEvent event) {
         }
     }
 
+    /**
+     * Sets the tabulator index for the container element that holds the radio
+     * buttons. It represents the entire radio button group within the browser's
+     * focus cycle.
+     *
+     * @param tabIndex
+     *            tabulator index for the radio button group
+     */
     public void setTabIndex(int tabIndex) {
         for (Widget anOptionsContainer : getWidget()) {
             FocusWidget widget = (FocusWidget) anOptionsContainer;
             widget.setTabIndex(tabIndex);
         }
     }
 
+    /**
+     * Sets radio buttons enabled according to this widget's enabled and
+     * read-only status, as well as each option's own enabled status.
+     */
     protected void updateEnabledState() {
-        // sets options enabled according to the widget's enabled,
-        // readonly and each options own enabled
         for (Map.Entry<RadioButton, JsonObject> entry : optionsToItems
                 .entrySet()) {
             RadioButton radioButton = entry.getKey();
@@ -214,10 +233,28 @@ protected void updateEnabledState() {
         }
     }
 
+    /**
+     * Returns whether HTML is allowed in the item captions.
+     *
+     * @return {@code true} if the captions are used as HTML, {@code false} if
+     *         used as plain text
+     */
     public boolean isHtmlContentAllowed() {
         return htmlContentAllowed;
     }
 
+    /**
+     * Sets whether HTML is allowed in the item captions. If set to
+     * {@code true}, the captions are displayed as HTML and the developer is
+     * responsible for ensuring no harmful HTML is used. If set to
+     * {@code false}, the content is displayed as plain text.
+     * <p>
+     * This value is delegated from the RadioButtonGroupState.
+     *
+     * @param htmlContentAllowed
+     *            {@code true} if the captions are used as HTML, {@code false}
+     *            if used as plain text
+     */
     public void setHtmlContentAllowed(boolean htmlContentAllowed) {
         this.htmlContentAllowed = htmlContentAllowed;
     }
@@ -227,10 +264,22 @@ public boolean isEnabled() {
         return enabled;
     }
 
+    /**
+     * Returns whether this radio button group is read-only or not.
+     *
+     * @return {@code true} if this widget is read-only, {@code false} otherwise
+     */
     public boolean isReadonly() {
         return readonly;
     }
 
+    /**
+     * Sets the read-only status of this radio button group.
+     *
+     * @param readonly
+     *            {@code true} if this widget should be read-only, {@code false}
+     *            otherwise
+     */
     public void setReadonly(boolean readonly) {
         if (this.readonly != readonly) {
             this.readonly = readonly;
@@ -246,13 +295,27 @@ public void setEnabled(boolean enabled) {
         }
     }
 
+    /**
+     * Adds the given selection change handler to this widget.
+     *
+     * @param selectionChanged
+     *            the handler that should be triggered when selection changes
+     * @return the registration object for removing the given handler when no
+     *         longer needed
+     */
     public Registration addSelectionChangeHandler(
             Consumer<JsonObject> selectionChanged) {
         selectionChangeListeners.add(selectionChanged);
         return (Registration) () -> selectionChangeListeners
                 .remove(selectionChanged);
     }
 
+    /**
+     * Removes previous selection and adds new selection.
+     *
+     * @param selectedItemKey
+     *            the key of the selected radio button
+     */
     public void selectItemKey(String selectedItemKey) {
         // At most one item could be selected so reset all radio buttons
         // before applying current selection