diff options
author | Teemu Suo-Anttila <tsuoanttila@users.noreply.github.com> | 2018-01-03 13:32:56 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-01-03 13:32:56 +0200 |
commit | 580d60744473b2d01547b1daa4049603c7f05561 (patch) | |
tree | eca49fbf17e1c97c00021406615da08155a84034 | |
parent | 2558f364c1b9634a79fcd04ca756c01da5b36fbf (diff) | |
download | vaadin-framework-8.3.0.alpha1.tar.gz vaadin-framework-8.3.0.alpha1.zip |
Add missing since tags and JavaDocs (#10487)8.3.0.alpha1
10 files changed, 50 insertions, 10 deletions
diff --git a/client/src/main/java/com/vaadin/client/ui/VAbstractCalendarPanel.java b/client/src/main/java/com/vaadin/client/ui/VAbstractCalendarPanel.java index fbfde9a3f1..21ea8ba4c4 100644 --- a/client/src/main/java/com/vaadin/client/ui/VAbstractCalendarPanel.java +++ b/client/src/main/java/com/vaadin/client/ui/VAbstractCalendarPanel.java @@ -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) { diff --git a/client/src/main/java/com/vaadin/client/ui/VAbstractTextualDate.java b/client/src/main/java/com/vaadin/client/ui/VAbstractTextualDate.java index 11102a218e..daa2701e2a 100644 --- a/client/src/main/java/com/vaadin/client/ui/VAbstractTextualDate.java +++ b/client/src/main/java/com/vaadin/client/ui/VAbstractTextualDate.java @@ -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; diff --git a/client/src/main/java/com/vaadin/client/ui/VRadioButtonGroup.java b/client/src/main/java/com/vaadin/client/ui/VRadioButtonGroup.java index 3a010c2380..91ea471543 100644 --- a/client/src/main/java/com/vaadin/client/ui/VRadioButtonGroup.java +++ b/client/src/main/java/com/vaadin/client/ui/VRadioButtonGroup.java @@ -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); diff --git a/client/src/main/java/com/vaadin/client/widgets/Grid.java b/client/src/main/java/com/vaadin/client/widgets/Grid.java index 405b6ab208..9e186ba64d 100755 --- a/client/src/main/java/com/vaadin/client/widgets/Grid.java +++ b/client/src/main/java/com/vaadin/client/widgets/Grid.java @@ -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; diff --git a/server/src/main/java/com/vaadin/data/PropertyDefinition.java b/server/src/main/java/com/vaadin/data/PropertyDefinition.java index 68be55a48b..a4b90d024a 100644 --- a/server/src/main/java/com/vaadin/data/PropertyDefinition.java +++ b/server/src/main/java/com/vaadin/data/PropertyDefinition.java @@ -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. * diff --git a/server/src/main/java/com/vaadin/ui/AbstractDateField.java b/server/src/main/java/com/vaadin/ui/AbstractDateField.java index 781848cb19..1198e04d66 100644 --- a/server/src/main/java/com/vaadin/ui/AbstractDateField.java +++ b/server/src/main/java/com/vaadin/ui/AbstractDateField.java @@ -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<>(); diff --git a/server/src/main/java/com/vaadin/ui/Grid.java b/server/src/main/java/com/vaadin/ui/Grid.java index 58945bfc46..803ac58b58 100644 --- a/server/src/main/java/com/vaadin/ui/Grid.java +++ b/server/src/main/java/com/vaadin/ui/Grid.java @@ -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; diff --git a/server/src/main/java/com/vaadin/ui/MenuBar.java b/server/src/main/java/com/vaadin/ui/MenuBar.java index 72a3671d4e..1525782c8a 100644 --- a/server/src/main/java/com/vaadin/ui/MenuBar.java +++ b/server/src/main/java/com/vaadin/ui/MenuBar.java @@ -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; diff --git a/shared/src/main/java/com/vaadin/shared/ui/datefield/AbstractDateFieldState.java b/shared/src/main/java/com/vaadin/shared/ui/datefield/AbstractDateFieldState.java index 7dab448039..69bc065cff 100644 --- a/shared/src/main/java/com/vaadin/shared/ui/datefield/AbstractDateFieldState.java +++ b/shared/src/main/java/com/vaadin/shared/ui/datefield/AbstractDateFieldState.java @@ -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>(); diff --git a/shared/src/main/java/com/vaadin/shared/ui/grid/ColumnState.java b/shared/src/main/java/com/vaadin/shared/ui/grid/ColumnState.java index 3b4f2af681..225eff104d 100644 --- a/shared/src/main/java/com/vaadin/shared/ui/grid/ColumnState.java +++ b/shared/src/main/java/com/vaadin/shared/ui/grid/ColumnState.java @@ -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. */ |