]> source.dussan.org Git - vaadin-framework.git/commitdiff
Add missing since tags and JavaDocs (#10487) 8.3.0.alpha1
authorTeemu Suo-Anttila <tsuoanttila@users.noreply.github.com>
Wed, 3 Jan 2018 11:32:56 +0000 (13:32 +0200)
committerGitHub <noreply@github.com>
Wed, 3 Jan 2018 11:32:56 +0000 (13:32 +0200)
client/src/main/java/com/vaadin/client/ui/VAbstractCalendarPanel.java
client/src/main/java/com/vaadin/client/ui/VAbstractTextualDate.java
client/src/main/java/com/vaadin/client/ui/VRadioButtonGroup.java
client/src/main/java/com/vaadin/client/widgets/Grid.java
server/src/main/java/com/vaadin/data/PropertyDefinition.java
server/src/main/java/com/vaadin/ui/AbstractDateField.java
server/src/main/java/com/vaadin/ui/Grid.java
server/src/main/java/com/vaadin/ui/MenuBar.java
shared/src/main/java/com/vaadin/shared/ui/datefield/AbstractDateFieldState.java
shared/src/main/java/com/vaadin/shared/ui/grid/ColumnState.java

index fbfde9a3f1e61f8186631227c4d74107f1dc8d7b..21ea8ba4c4b3b8d76b4b78ed1c3a93c45c43cd7c 100644 (file)
@@ -398,7 +398,8 @@ public abstract class VAbstractCalendarPanel<R extends Enum<R>>
 
             selectDate(focusedDate);
         } else {
-            getLogger().info("Trying to select a the focused date which is NULL!");
+            getLogger()
+                    .info("Trying to select the focused date which is NULL!");
         }
     }
 
@@ -452,6 +453,14 @@ public abstract class VAbstractCalendarPanel<R extends Enum<R>>
         }
     }
 
+    /**
+     * Sets the style names for dates.
+     *
+     * @param dateStyles
+     *            the map of date string to style name
+     *
+     * @since 8.3
+     */
     public void setDateStyles(Map<String, String> dateStyles) {
         this.dateStyles.clear();
         if (dateStyles != null) {
index 11102a218e6e5d5cec23af49fc0ab720374ee7f3..daa2701e2ad221b3acf14c9cbffc9845eb0bd9cf 100644 (file)
@@ -420,7 +420,7 @@ public abstract class VAbstractTextualDate<R extends Enum<R>>
      *
      * @param textFocus
      *            the focus of the {@link #text}
-     * @since
+     * @since 8.3
      */
     protected void checkGroupFocus(boolean textFocus) {
         boolean newGroupFocus = textFocus | hasChildFocus();
@@ -444,7 +444,7 @@ public abstract class VAbstractTextualDate<R extends Enum<R>>
      *
      * @return {@code true} if any of the child component has focus,
      *         {@code false} otherwise
-     * @since
+     * @since 8.3
      */
     protected boolean hasChildFocus() {
         return false;
index 3a010c238037d280ac2a9051858bd5c103dc3f4e..91ea471543838714574d47a912ab06f66347fe68 100644 (file)
@@ -157,7 +157,8 @@ public class VRadioButtonGroup extends FocusableFlowPanelComposite
         // #9258 apply the v-disabled class when disabled for UX
         button.setStyleName(StyleConstants.DISABLED,
                 !isEnabled() || !optionEnabled);
-        updateItemSelection(button, item.getBoolean(ListingJsonConstants.JSONKEY_ITEM_SELECTED));
+        updateItemSelection(button,
+                item.getBoolean(ListingJsonConstants.JSONKEY_ITEM_SELECTED));
 
         String key = item.getString(DataCommunicatorConstants.KEY);
 
@@ -260,7 +261,8 @@ public class VRadioButtonGroup extends FocusableFlowPanelComposite
     public void selectItemKey(String selectedItemKey) {
         // At most one item could be selected so reset all radio buttons
         // before applying current selection
-        keyToOptions.values().forEach(button -> updateItemSelection(button, false));
+        keyToOptions.values()
+                .forEach(button -> updateItemSelection(button, false));
         if (selectedItemKey != null) {
             RadioButton radioButton = keyToOptions.get(selectedItemKey);
             if (radioButton != null) { // Items might not be loaded yet
@@ -269,6 +271,14 @@ public class VRadioButtonGroup extends FocusableFlowPanelComposite
         }
     }
 
+    /**
+     * Updates the selected state of a radio button.
+     * 
+     * @param radioButton
+     *            the radio button to update
+     * @param value
+     *            {@code true} if selected; {@code false} if not
+     */
     protected void updateItemSelection(RadioButton radioButton, boolean value) {
         radioButton.setValue(value);
         radioButton.setStyleName(CLASSNAME_OPTION_SELECTED, value);
index 405b6ab208532c20b3426c00510fc0afb588afb8..9e186ba64d3bf7fb412108bfe192be5089990bec 100755 (executable)
@@ -5548,6 +5548,7 @@ public class Grid<T> extends ResizeComposite implements HasSelectionHandlers<T>,
          * 
          * @return {@code true} to handle events from widgets; {@code false} to
          *         not
+         * @since 8.3
          */
         public boolean isWidgetEventsAllowed() {
             return widgetEventsAllowed;
@@ -5559,6 +5560,8 @@ public class Grid<T> extends ResizeComposite implements HasSelectionHandlers<T>,
          * @param widgetEventsAllowed
          *            {@code true} to let grid handle events from widgets;
          *            {@code false} to not
+         *
+         * @since 8.3
          */
         public void setWidgetEventsAllowed(boolean widgetEventsAllowed) {
             this.widgetEventsAllowed = widgetEventsAllowed;
index 68be55a48bfcca9cc7e57f13f6f7f8f46c6b7f0e..a4b90d024a12d29fa875902d4d46112a5824d243 100644 (file)
@@ -71,12 +71,15 @@ public interface PropertyDefinition<T, V> extends Serializable {
     public String getName();
 
     /**
-     * Gets the top level name of this property
+     * Gets the top level name of this property.
      * 
      * @return the top level property name, not <code>null</code>
+     * @since 8.3
      */
-    public default String getTopLevelName() {return getName();}
-    
+    public default String getTopLevelName() {
+        return getName();
+    }
+
     /**
      * Gets the human readable caption to show for this property.
      *
index 781848cb19f453455906d1790dfc1ee9d945cc98..1198e04d6674a8c2718b93e8be4e959d25788d00 100644 (file)
@@ -826,6 +826,8 @@ public abstract class AbstractDateField<T extends Temporal & TemporalAdjuster &
      * @param styleName
      *            the custom style name(s) for given date, {@code null} to clear
      *            custom style name(s)
+     *
+     * @since 8.3
      */
     public void setDateStyle(LocalDate date, String styleName) {
         if (date != null) {
@@ -846,6 +848,7 @@ public abstract class AbstractDateField<T extends Temporal & TemporalAdjuster &
      * @return the corresponding style name(s), if any, {@code null} otherwise
      *
      * @see {@link #setDateStyle(LocalDate, String)}
+     * @since 8.3
      */
     public String getDateStyle(LocalDate date) {
         if (date == null) {
@@ -861,6 +864,7 @@ public abstract class AbstractDateField<T extends Temporal & TemporalAdjuster &
      * @return map from dates to custom style names in each date's calendar cell
      *
      * @see {@link #setDateStyle(LocalDate, String)}
+     * @since 8.3
      */
     public Map<LocalDate, String> getDateStyles() {
         HashMap<LocalDate, String> hashMap = new HashMap<>();
index 58945bfc4663b4a4b3a4124e596e92e43e7f4bbf..803ac58b587a15b0c318f6b5eedbd89e81542488 100644 (file)
@@ -2068,6 +2068,7 @@ public class Grid<T> extends AbstractListing<T> implements HasComponents,
          * @param widgetEventsAllowed
          *            {@code true} to handle events; {@code false} to not
          * @return this column
+         * @since 8.3
          */
         public Column<T, V> setWidgetEventsAllowed(
                 boolean widgetEventsAllowed) {
@@ -2084,6 +2085,7 @@ public class Grid<T> extends AbstractListing<T> implements HasComponents,
          * @see #setWidgetEventsAllowed(boolean)
          * 
          * @return {@code true} if handling events; {@code false} if not
+         * @since 8.3
          */
         public boolean isWidgetEventsAllowed() {
             return getState(false).widgetEventsAllowed;
index 72a3671d4e38d9f3c3d35f1c53979ed31e290ff6..1525782c8a22995fda28e6312d443e56c14eb3f5 100644 (file)
@@ -821,7 +821,7 @@ public class MenuBar extends AbstractComponent
          *            the new description string for the component.
          * @param mode
          *            the content mode for the description
-         * @since
+         * @since 8.3
          */
         public void setDescription(String description, ContentMode mode) {
             this.description = description;
@@ -900,7 +900,7 @@ public class MenuBar extends AbstractComponent
          *
          * @return the {@link ContentMode} of the description of this menu item
          * @see ContentMode
-         * @since
+         * @since 8.3
          */
         public ContentMode getContentMode() {
             return contentMode;
index 7dab44803942f59cf0c8b7381fa720ce8aebfb2c..69bc065cffbe6519199a8eea11d47f02f628917b 100644 (file)
@@ -109,6 +109,8 @@ public class AbstractDateFieldState extends AbstractFieldState {
     /**
      * Map of custom style names that correspond with given dates. Each date
      * must be set to midnight for the handling logic to work correctly.
+     * 
+     * @since 8.3
      */
     public Map<String, String> dateStyles = new HashMap<String, String>();
 
index 3b4f2af681389f7674d45207e74e02c980661129..225eff104d2ed00d3893d55449da81b9dc39afb0 100644 (file)
@@ -30,6 +30,13 @@ public class ColumnState extends AbstractGridExtensionState {
     public String internalId;
     public boolean sortable = false;
     public boolean editable = false;
+
+    /**
+     * Sets whether Grid should handle events from Widgets from this column or
+     * not.
+     * 
+     * @since 8.3
+     */
     public boolean widgetEventsAllowed = false;
 
     /** The assistive device caption for the column. */