Skip to content

Commit

Permalink
Fix since tags for 8.0 (#8575)
Browse files Browse the repository at this point in the history
Fix since tags for the server and shared modules and new types in client.
  • Loading branch information
hesara committed Feb 16, 2017
1 parent d80c420 commit 52d03c7
Show file tree
Hide file tree
Showing 134 changed files with 335 additions and 101 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* execute a command after all dependencies have finished loading.
*
* @author Vaadin Ltd
* @since 8.0.0
* @since 8.0
*/
public class DependencyLoader {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
*
* @param <WIDGET>
* widget type which has to allow to register focus/blur handlers
* @since 8.0
*/
public abstract class AbstractFocusableListingConnector<WIDGET extends Widget & HasAllFocusHandlers>
extends AbstractListingConnector {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
* An abstract class for single selection connectors.
*
* @author Vaadin Ltd
* @since 8.0.0
* @since 8.0
*/
public abstract class AbstractSingleSelectConnector<WIDGET extends Widget & HasAllFocusHandlers>
extends AbstractFocusableListingConnector<WIDGET>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
* @param <T>
* the presentation type of the renderer
*
* @since 7.4
* @since 8.0
* @author Vaadin Ltd
*/
public abstract class AbstractGridRendererConnector<T>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
* string, and displayed as-is on the client side. This is to be able to support
* the server's locale.
*
* @since 7.4
* @since 8.0
* @author Vaadin Ltd
*/
@Connect(com.vaadin.ui.renderers.DateRenderer.class)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
* string, and displayed as-is on the client side. This is to be able to support
* the server's locale.
*
* @since 7.4
* @since 8.0
* @author Vaadin Ltd
*/
@Connect(com.vaadin.ui.renderers.NumberRenderer.class)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
/**
* A connector for {@link ProgressBarRenderer}.
*
* @since 7.4
* @since 8.0
* @author Vaadin Ltd
*/
@Connect(com.vaadin.ui.renderers.ProgressBarRenderer.class)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
/**
* A connector for {@link TextRenderer}.
*
* @since 7.4
* @since 8.0
* @author Vaadin Ltd
*/
@Connect(com.vaadin.ui.renderers.TextRenderer.class)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
/**
* A connector for {@link UnsafeHtmlRenderer}
*
* @since 7.4
* @since 8.0
* @author Vaadin Ltd
*/
@Connect(com.vaadin.ui.renderers.HtmlRenderer.class)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
/**
* Implemented by all widgets used by a connector extending
* {@link AbstractTextFieldConnector}.
*
* @since 8.0
*/
public interface AbstractTextFieldWidget {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@

/**
* Implemented by connectors supporting an error indicator.
*
* @since 8.0
*/
public interface HasErrorIndicator extends ComponentConnector {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@

/**
* Implemented by connectors supporting a required flag.
*
* @since 8.0
*/
public interface HasRequiredIndicator extends ComponentConnector {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,12 @@
/**
* Abstract calendar panel to show and select a date using a resolution. The
* class is parameterized by the date resolution enumeration type.
*
*
* @author Vaadin Ltd
*
* @param <R>
* the resolution type which this field is based on (day, month, ...)
* @since 8.0
*/
@SuppressWarnings("deprecation")
public abstract class VAbstractCalendarPanel<R extends Enum<R>>
Expand Down Expand Up @@ -265,15 +266,15 @@ private void focusDay(Date date) {
/**
* Returns {@code true} if current resolution assumes handling focus event
* for day UI component.
*
*
* @return {@code true} if day focus events should be handled, {@code false}
* otherwise
*/
protected abstract boolean acceptDayFocus();

/**
* Returns {@code true} if the provided {@code resolution} represents a day.
*
*
* @param resolution
* the given resolution
* @return {@code true} if the {@code resolution} represents a day
Expand All @@ -283,7 +284,7 @@ private void focusDay(Date date) {
/**
* Returns {@code true} if the provided {@code resolution} represents a
* month.
*
*
* @param resolution
* the given resolution
* @return {@code true} if the {@code resolution} represents a month
Expand All @@ -293,7 +294,7 @@ private void focusDay(Date date) {
/**
* Returns {@code true} if the provided {@code resolution} represents an
* year.
*
*
* @param resolution
* the given resolution
* @return {@code true} if the {@code resolution} represents a year
Expand All @@ -305,7 +306,7 @@ protected boolean isYear(R resolution) {
/**
* Returns {@code true} if the {@code resolution} representation is strictly
* below month (day, hour, etc..).
*
*
* @param resolution
* the given resolution
* @return whether the {@code resolution} is below the month resolution
Expand All @@ -314,7 +315,7 @@ protected boolean isYear(R resolution) {

/**
* Returns all available resolutions for the widget.
*
*
* @return all available resolutions
*/
protected Stream<R> getResolutions() {
Expand All @@ -323,7 +324,7 @@ protected Stream<R> getResolutions() {

/**
* Finds the resolution by the {@code filter}.
*
*
* @param filter
* predicate to filter resolutions
* @return the resolution accepted by the {@code filter}
Expand Down Expand Up @@ -423,7 +424,7 @@ public void setResolution(R resolution) {

/**
* Checks whether the widget is not editable (read-only).
*
*
* @return {@code true} if the widget is read-only
*/
protected boolean isReadonly() {
Expand All @@ -432,7 +433,7 @@ protected boolean isReadonly() {

/**
* Checks whether the widget is enabled.
*
*
* @return {@code true} is the widget is enabled
*/
protected boolean isEnabled() {
Expand Down Expand Up @@ -595,9 +596,9 @@ private void updateControlButtonRangeStyles(boolean needsMonth) {

/**
* Returns date time service for the widget.
*
*
* @see #setDateTimeService(DateTimeService)
*
*
* @return date time service
*/
protected DateTimeService getDateTimeService() {
Expand All @@ -606,7 +607,7 @@ protected DateTimeService getDateTimeService() {

/**
* Returns the date field which this panel is attached to.
*
*
* @return the "parent" date field
*/
protected VDateField<R> getDateField() {
Expand Down Expand Up @@ -903,7 +904,7 @@ public void renderCalendar(boolean updateDate) {
* Subclasses may override this method to provide a custom implementation
* avoiding {@link #renderCalendar(boolean)} override. The latter method
* contains a common logic which should not be overriden.
*
*
* @param updateDate
* The value false prevents setting the selected date of the
* calendar based on focusedDate. That can be used when only the
Expand Down Expand Up @@ -1666,7 +1667,7 @@ public void setDate(Date currentDate) {
* The actual implementation of the logic which sets the data of the Panel.
* The method {@link #setDate(Date)} just delegate a call to this method
* providing additional config parameters.
*
*
* @param currentDate
* currentDate The date to set
* @param needRerender
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@
* then pass set it by calling the
* <code>setCalendarPanel(VAbstractCalendarPanel panel)</code> method.
*
* @since 8.0
*/
public abstract class VAbstractPopupCalendar<PANEL extends VAbstractCalendarPanel<R>, R extends Enum<R>>
extends VAbstractTextualDate<R>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,12 @@
* Abstract textual date field base implementation. Provides a text box as an
* editor for a date. The class is parameterized by the date resolution
* enumeration type.
*
*
* @author Vaadin Ltd
*
* @param <R>
* the resolution type which this field is based on (day, month, ...)
* @since 8.0
*/
public abstract class VAbstractTextualDate<R extends Enum<R>>
extends VDateField<R> implements Field, ChangeHandler, Focusable,
Expand Down Expand Up @@ -91,7 +92,7 @@ protected void updateStyleNames() {

/**
* Gets the date format string for the current locale.
*
*
* @return the format string
*/
protected String getFormatString() {
Expand Down Expand Up @@ -240,9 +241,9 @@ protected void updateDateVariables() {
/**
* Clean date format string to make it suitable for
* {@link #getFormatString()}.
*
*
* @see #getFormatString()
*
*
* @param format
* date format string
* @return cleaned up string
Expand Down
2 changes: 2 additions & 0 deletions client/src/main/java/com/vaadin/client/ui/VComboBox.java
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,8 @@
* Client side implementation of the ComboBox component.
*
* TODO needs major refactoring (to be extensible etc)
*
* @since 8.0
*/
@SuppressWarnings("deprecation")
public class VComboBox extends Composite implements Field, KeyDownHandler,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

/**
* @author Vaadin Ltd
*
* @since 8.0
*/
public class VDateCalendarPanel extends VAbstractCalendarPanel<DateResolution> {

Expand Down
4 changes: 2 additions & 2 deletions client/src/main/java/com/vaadin/client/ui/VWindow.java
Original file line number Diff line number Diff line change
Expand Up @@ -356,7 +356,7 @@ private void setWindowOrder(int order) {
/**
* Returns window position in list of opened and shown windows.
*
* @since 8.0.0
* @since 8.0
*/
public final int getWindowOrder() {
return windowOrder.indexOf(this);
Expand Down Expand Up @@ -1510,7 +1510,7 @@ public HandlerRegistration addMoveHandler(WindowMoveHandler handler) {
/**
* Adds a Handler for window order change event.
*
* @since 8.0.0
* @since 8.0
*
* @return registration object to deregister the handler
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,14 @@

/**
* Base class for inline data field connector.
*
*
* @author Vaadin Ltd
*
* @param <R>
* the resolution type which the field is based on (day, month, ...)
* @param <PANEL>
* Subclass of VAbstractCalendarPanel specific for the implementation
* @since 8.0
*/
public abstract class AbstractInlineDateFieldConnector<PANEL extends VAbstractCalendarPanel<R>, R extends Enum<R>>
extends AbstractDateFieldConnector<R> {
Expand Down Expand Up @@ -122,7 +123,7 @@ public InlineDateFieldState getState() {
/**
* Returns {@code true} is the current resolution of the widget is month or
* less specific (e.g. month, year, quarter, etc).
*
*
* @return {@code true} if the current resolution is above month
*/
protected abstract boolean isResolutionMonthOrHigher();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,15 @@
import com.vaadin.client.ui.VAbstractTextualDate;
import com.vaadin.shared.ui.datefield.AbstractTextualDateFieldState;

/**
* Abstract base class for date fields with textual date representation.
*
* @author Vaadin Ltd
* @since 8.0
*
* @param <R>
* resolution type
*/
public abstract class AbstractTextualDateConnector<R extends Enum<R>>
extends AbstractDateFieldConnector<R> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,12 @@

import elemental.json.JsonObject;

/**
* CheckBoxGroup client side connector.
*
* @author Vaadin Ltd
* @since 8.0
*/
@Connect(CheckBoxGroup.class)
// We don't care about the framework-provided selection model at this point
// TODO refactor to extend AbstractMultiSelectConnector, maybe when
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,12 @@

import elemental.json.JsonObject;

/**
* CheckBoxGroup client side connector.
*
* @author Vaadin Ltd
* @since 8.0
*/
@Connect(RadioButtonGroup.class)
public class RadioButtonGroupConnector
extends AbstractSingleSelectConnector<VRadioButtonGroup> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
/**
* Connector for {@link VProgressBar}.
*
* @since 7.1
* @since 8.0
* @author Vaadin Ltd
*/
@Connect(ProgressBar.class)
Expand Down
Loading

0 comments on commit 52d03c7

Please sign in to comment.