Browse Source

Update/add @since tags in javadoc

Change-Id: Ifd93251fdc20b93ad276c551796557bb9026766a
tags/7.6.0.alpha7
Henri Sara 8 years ago
parent
commit
ddf4e617b2
31 changed files with 78 additions and 23 deletions
  1. 1
    1
      client/src/com/vaadin/client/ApplicationConfiguration.java
  2. 8
    0
      client/src/com/vaadin/client/ApplicationConnection.java
  3. 1
    0
      client/src/com/vaadin/client/ComputedStyle.java
  4. 4
    0
      client/src/com/vaadin/client/LayoutManager.java
  5. 2
    0
      client/src/com/vaadin/client/Profiler.java
  6. 2
    0
      client/src/com/vaadin/client/Util.java
  7. 2
    0
      client/src/com/vaadin/client/WidgetUtil.java
  8. 1
    1
      client/src/com/vaadin/client/ui/AbstractComponentConnector.java
  9. 1
    0
      client/src/com/vaadin/client/ui/VNotification.java
  10. 2
    0
      client/src/com/vaadin/client/ui/orderedlayout/Slot.java
  11. 1
    1
      server/src/com/vaadin/event/ContextClickEvent.java
  12. 2
    2
      server/src/com/vaadin/server/VaadinSession.java
  13. 1
    0
      server/src/com/vaadin/server/WebBrowser.java
  14. 4
    4
      server/src/com/vaadin/server/WrappedPortletSession.java
  15. 2
    0
      server/src/com/vaadin/server/communication/PushHandler.java
  16. 1
    0
      server/src/com/vaadin/server/communication/ServerRpcHandler.java
  17. 1
    1
      server/src/com/vaadin/ui/AbstractField.java
  18. 1
    0
      server/src/com/vaadin/ui/AbstractSelect.java
  19. 3
    1
      server/src/com/vaadin/ui/Grid.java
  20. 2
    2
      server/src/com/vaadin/ui/PushConfiguration.java
  21. 9
    2
      server/src/com/vaadin/ui/Table.java
  22. 2
    2
      server/src/com/vaadin/ui/Tree.java
  23. 1
    1
      server/src/com/vaadin/ui/declarative/DesignFormatter.java
  24. 4
    0
      shared/src/com/vaadin/shared/ApplicationConstants.java
  25. 1
    1
      shared/src/com/vaadin/shared/ContextClickRpc.java
  26. 1
    0
      shared/src/com/vaadin/shared/VBrowserDetails.java
  27. 2
    0
      shared/src/com/vaadin/shared/ui/grid/GridConstants.java
  28. 1
    1
      shared/src/com/vaadin/shared/ui/grid/GridServerRpc.java
  29. 12
    2
      shared/src/com/vaadin/shared/ui/grid/GridState.java
  30. 2
    0
      shared/src/com/vaadin/shared/ui/table/TableConstants.java
  31. 1
    1
      shared/src/com/vaadin/shared/ui/table/TableServerRpc.java

+ 1
- 1
client/src/com/vaadin/client/ApplicationConfiguration.java View File

@@ -603,7 +603,7 @@ public class ApplicationConfiguration implements EntryPoint {
}

/**
*
* @since 7.6
* @param c
*/
public static void runWhenDependenciesLoaded(Command c) {

+ 8
- 0
client/src/com/vaadin/client/ApplicationConnection.java View File

@@ -42,6 +42,7 @@ import com.google.gwt.user.client.Timer;
import com.google.gwt.user.client.ui.HasWidgets;
import com.google.gwt.user.client.ui.Widget;
import com.vaadin.client.ApplicationConfiguration.ErrorMessage;
import com.vaadin.client.ApplicationConnection.ApplicationStoppedEvent;
import com.vaadin.client.ResourceLoader.ResourceLoadEvent;
import com.vaadin.client.ResourceLoader.ResourceLoadListener;
import com.vaadin.client.communication.ConnectionStateHandler;
@@ -1202,6 +1203,7 @@ public class ApplicationConnection implements HasHandlers {
* Sets a resource that has been pre-loaded via UIDL, such as custom
* layouts.
*
* @since 7.6
* @param name
* identifier of the resource to Set
* @param resource
@@ -1578,6 +1580,7 @@ public class ApplicationConnection implements HasHandlers {
/**
* Gets the server RPC queue for this application
*
* @since 7.6
* @return the server RPC queue
*/
public ServerRpcQueue getServerRpcQueue() {
@@ -1587,6 +1590,7 @@ public class ApplicationConnection implements HasHandlers {
/**
* Gets the communication error handler for this application
*
* @since 7.6
* @return the server RPC queue
*/
public ConnectionStateHandler getConnectionStateHandler() {
@@ -1596,6 +1600,7 @@ public class ApplicationConnection implements HasHandlers {
/**
* Gets the (server to client) message handler for this application
*
* @since 7.6
* @return the message handler
*/
public MessageHandler getMessageHandler() {
@@ -1605,6 +1610,7 @@ public class ApplicationConnection implements HasHandlers {
/**
* Gets the server rpc manager for this application
*
* @since 7.6
* @return the server rpc manager
*/
public RpcManager getRpcManager() {
@@ -1614,6 +1620,7 @@ public class ApplicationConnection implements HasHandlers {
/**
* Gets the (client to server) message sender for this application
*
* @since 7.6
* @return the message sender
*/
public MessageSender getMessageSender() {
@@ -1621,6 +1628,7 @@ public class ApplicationConnection implements HasHandlers {
}

/**
* @since 7.6
* @return the widget set
*/
public WidgetSet getWidgetSet() {

+ 1
- 0
client/src/com/vaadin/client/ComputedStyle.java View File

@@ -151,6 +151,7 @@ public class ComputedStyle {
*
* Returns NaN if the property cannot be converted to a double
*
* @since 7.5.1
* @param name
* the property to retrieve
* @return the double value of the property

+ 4
- 0
client/src/com/vaadin/client/LayoutManager.java View File

@@ -990,6 +990,7 @@ public class LayoutManager {
* -1 is returned if the element has not been measured. If 0 is returned, it
* might indicate that the element is not attached to the DOM.
*
* @since 7.5.1
* @param element
* the element to get the measured size for
* @return the measured outer height (including margins, paddings and
@@ -1017,6 +1018,7 @@ public class LayoutManager {
* The value returned by this method is always rounded up. To get the exact
* outer width, use {@link #getOuterWidthDouble(Element)}
*
* @since 7.5.1
* @param element
* the element to get the measured size for
* @return the measured outer width (including margins, paddings and
@@ -1094,6 +1096,7 @@ public class LayoutManager {
* -1 is returned if the element has not been measured. If 0 is returned, it
* might indicate that the element is not attached to the DOM.
*
* @since 7.5.1
* @param element
* the element to get the measured size for
* @return the measured inner height (excluding margins, paddings and
@@ -1146,6 +1149,7 @@ public class LayoutManager {
* -1 is returned if the element has not been measured. If 0 is returned, it
* might indicate that the element is not attached to the DOM.
*
* @since 7.5.1
* @param element
* the element to get the measured size for
* @return the measured inner width (excluding margins, paddings and

+ 2
- 0
client/src/com/vaadin/client/Profiler.java View File

@@ -390,6 +390,8 @@ public class Profiler {
* Returns time relative to the particular page load time. The value should
* not be used directly but rather difference between two values returned by
* this method should be used to compare measurements.
*
* @since 7.6
*/
public static double getRelativeTimeMillis() {
return RELATIVE_TIME_SUPPLIER.getRelativeTime();

+ 2
- 0
client/src/com/vaadin/client/Util.java View File

@@ -1178,6 +1178,8 @@ public class Util {

/**
* Round {@code num} up to {@code exp} decimal positions.
*
* @since 7.6
*/
public static native double round(double num, int exp)
/*-{

+ 2
- 0
client/src/com/vaadin/client/WidgetUtil.java View File

@@ -562,6 +562,7 @@ public class WidgetUtil {
* Gets the border-box width for the given element, i.e. element width +
* border + padding.
*
* @since 7.5.1
* @param element
* The element to check
* @return The border-box width for the element
@@ -612,6 +613,7 @@ public class WidgetUtil {
* Gets the border-box height for the given element, i.e. element height +
* border + padding.
*
* @since 7.5.1
* @param element
* The element to check
* @return The border-box height for the element

+ 1
- 1
client/src/com/vaadin/client/ui/AbstractComponentConnector.java View File

@@ -95,7 +95,7 @@ public abstract class AbstractComponentConnector extends AbstractConnector
* overridden to provide extra information through an alternative RPC
* interface.
*
* @since
* @since 7.6
* @param event
*/
protected void sendContextClickEvent(ContextMenuEvent event) {

+ 1
- 0
client/src/com/vaadin/client/ui/VNotification.java View File

@@ -606,6 +606,7 @@ public class VNotification extends VOverlay {
* If both message and caption are null, redirects the user to the url
* immediately
*
* @since 7.5.1
* @param connection
* A reference to the ApplicationConnection
* @param caption

+ 2
- 0
client/src/com/vaadin/client/ui/orderedlayout/Slot.java View File

@@ -93,6 +93,8 @@ public class Slot extends SimplePanel {
*
* When using this constructor, the layout and widget must be set before any
* other operations are performed on the slot.
*
* @since 7.6
*/
public Slot() {
setStyleName(SLOT_CLASSNAME);

+ 1
- 1
server/src/com/vaadin/event/ContextClickEvent.java View File

@@ -27,7 +27,7 @@ import com.vaadin.util.ReflectTools;
* Context click event fired by a {@link Component}. ContextClickEvent happens
* when context click happens on the client-side inside the Component.
*
* @since
* @since 7.6
* @author Vaadin Ltd
*/
public class ContextClickEvent extends ClickEvent {

+ 2
- 2
server/src/com/vaadin/server/VaadinSession.java View File

@@ -781,7 +781,7 @@ public class VaadinSession implements HttpSessionBindingListener, Serializable {
* Checks if the current thread has exclusive access to this VaadinSession
*
* @return true if the thread has exclusive access, false otherwise
* @since
* @since 7.1
*/
public boolean hasLock() {
ReentrantLock l = ((ReentrantLock) getLockInstance());
@@ -793,7 +793,7 @@ public class VaadinSession implements HttpSessionBindingListener, Serializable {
* WrappedSession.
*
* @return true if this thread has exclusive access, false otherwise
* @since
* @since 7.6
*/
protected static boolean hasLock(VaadinService service,
WrappedSession session) {

+ 1
- 0
server/src/com/vaadin/server/WebBrowser.java View File

@@ -128,6 +128,7 @@ public class WebBrowser implements Serializable {
/**
* Tests whether the user is using Edge.
*
* @since 7.5.3
* @return true if the user is using Edge, false if the user is not using
* Edge or if no information on the browser is present
*/

+ 4
- 4
server/src/com/vaadin/server/WrappedPortletSession.java View File

@@ -73,7 +73,7 @@ public class WrappedPortletSession implements WrappedSession {
* @see PortletSession#PORTLET_SCOPE
* @see PortletSession#APPLICATION_SCOPE
*
* @since
* @since 7.6
*/
public Object getAttribute(String name, int scope) {
return session.getAttribute(name, scope);
@@ -113,7 +113,7 @@ public class WrappedPortletSession implements WrappedSession {
* @see PortletSession#PORTLET_SCOPE
* @see PortletSession#APPLICATION_SCOPE
*
* @since
* @since 7.6
*/
public void setAttribute(String name, Object value, int scope) {
session.setAttribute(name, value, scope);
@@ -144,7 +144,7 @@ public class WrappedPortletSession implements WrappedSession {
*
* @see PortletSession#getAttributeNames()
*
* @since
* @since 7.6
*/
public Set<String> getAttributeNames(int scope) {
return WrappedHttpSession.enumerationToSet(session
@@ -200,7 +200,7 @@ public class WrappedPortletSession implements WrappedSession {
* @see PortletSession#PORTLET_SCOPE
* @see PortletSession#APPLICATION_SCOPE
*
* @since
* @since 7.6
*/
public void removeAttribute(String name, int scope) {
session.removeAttribute(name, scope);

+ 2
- 0
server/src/com/vaadin/server/communication/PushHandler.java View File

@@ -517,6 +517,7 @@ public class PushHandler {
* timeout to a value smaller than the proxy timeout so that the server is
* aware of a reconnect taking place.
*
* @since 7.6
* @param suspendTimeout
* the timeout to use for suspended AtmosphereResources
*/
@@ -527,6 +528,7 @@ public class PushHandler {
/**
* Gets the timeout used for suspend calls when using long polling.
*
* @since 7.6
* @return the timeout to use for suspended AtmosphereResources
*/
public int getLongPollingSuspendTimeout() {

+ 1
- 0
server/src/com/vaadin/server/communication/ServerRpcHandler.java View File

@@ -167,6 +167,7 @@ public class ServerRpcHandler implements Serializable {
/**
* Gets the id of the client to server message
*
* @since 7.6
* @return the server message id
*/
public int getClientToServerId() {

+ 1
- 1
server/src/com/vaadin/ui/AbstractField.java View File

@@ -471,7 +471,7 @@ public abstract class AbstractField<T> extends AbstractComponent implements
/**
* Sets the value of the field.
*
* @since
* @since 7.5.7
* @param newFieldValue
* the New value of the field.
* @param repaintIsNotNeeded

+ 1
- 0
server/src/com/vaadin/ui/AbstractSelect.java View File

@@ -699,6 +699,7 @@ public abstract class AbstractSelect extends AbstractField<Object> implements
* multiselect mode all collections of id:s can be assigned.
* </p>
*
* @since 7.5.7
* @param newValue
* the New selected item or collection of selected items.
* @param repaintIsNotNeeded

+ 3
- 1
server/src/com/vaadin/ui/Grid.java View File

@@ -390,7 +390,7 @@ public class Grid extends AbstractFocusable implements SelectionNotifier,
/**
* ContextClickEvent for the Grid Component.
*
* @since
* @since 7.6
*/
public static class GridContextClickEvent extends ContextClickEvent {

@@ -1801,6 +1801,7 @@ public class Grid extends AbstractFocusable implements SelectionNotifier,
/**
* Abstract base class for Grid header and footer sections.
*
* @since 7.6
* @param <ROWTYPE>
* the type of the rows in the section
*/
@@ -3721,6 +3722,7 @@ public class Grid extends AbstractFocusable implements SelectionNotifier,
* given converter and renderer. This method is public only for testing
* purposes.
*
* @since 7.6
* @param renderer
* the renderer to use
* @param converter

+ 2
- 2
server/src/com/vaadin/ui/PushConfiguration.java View File

@@ -145,7 +145,7 @@ public interface PushConfiguration extends Serializable {
* This is only used when overriding the URL to use. Setting this to null
* (the default) will use the default URL.
*
* @since
* @since 7.6
* @param pushUrl
* The push URL to use
*/
@@ -157,7 +157,7 @@ public interface PushConfiguration extends Serializable {
* This is only used when overriding the URL to use. Returns null (the
* default) when the default URL is used.
*
* @since
* @since 7.6
* @return the URL to use for push requests, or null to use to default
*/
public String getPushUrl();

+ 9
- 2
server/src/com/vaadin/ui/Table.java View File

@@ -5776,7 +5776,9 @@ public class Table extends AbstractSelect implements Action.Container,
}

/**
* This event is fired when the collapse state of a column changes
* This event is fired when the collapse state of a column changes.
*
* @since 7.6
*/
public static class ColumnCollapseEvent extends Component.Event {

@@ -5810,6 +5812,8 @@ public class Table extends AbstractSelect implements Action.Container,

/**
* Interface for listening to column collapse events.
*
* @since 7.6
*/
public interface ColumnCollapseListener extends Serializable {

@@ -5867,6 +5871,8 @@ public class Table extends AbstractSelect implements Action.Container,
* Adds a column collapse listener to the Table. A column collapse listener
* is called when the collapsed state of a column changes.
*
* @since 7.6
*
* @param listener
* The listener to attach
*/
@@ -5877,7 +5883,8 @@ public class Table extends AbstractSelect implements Action.Container,

/**
* Removes a column reorder listener from the Table.
*
*
* @since 7.6
* @param listener
* The listener to remove
*/

+ 2
- 2
server/src/com/vaadin/ui/Tree.java View File

@@ -1946,7 +1946,7 @@ public class Tree extends AbstractSelect implements Container.Hierarchical,
* <code>false</code>, the content is passed to the browser as plain text.
* The default setting is <code>false</code>
*
* @since
* @since 7.6
* @param htmlContentAllowed
* <code>true</code> if the captions are used as html,
* <code>false</code> if used as plain text
@@ -1959,7 +1959,7 @@ public class Tree extends AbstractSelect implements Container.Hierarchical,
/**
* Checks whether captions are interpreted as html or plain text.
*
* @since
* @since 7.6
* @return <code>true</code> if the captions are displayed as html,
* <code>false</code> if displayed as plain text
* @see #setHtmlContentAllowed(boolean)

+ 1
- 1
server/src/com/vaadin/ui/declarative/DesignFormatter.java View File

@@ -403,7 +403,7 @@ public class DesignFormatter implements Serializable {
* unencodes more characters than {@link #encodeForTextNode(String)} encodes
* </p>
*
* @since
* @since 7.6
* @param input
* @return
*/

+ 4
- 0
shared/src/com/vaadin/shared/ApplicationConstants.java View File

@@ -135,6 +135,8 @@ public class ApplicationConstants implements Serializable {
/**
* The name of the parameter used to transmit the id of the client to server
* messages.
*
* @since 7.6
*/
public static final String CLIENT_TO_SERVER_ID = "clientId";

@@ -151,6 +153,8 @@ public class ApplicationConstants implements Serializable {
/**
* The name of the parameter used for sending the widget set version to the
* server
*
* @since 7.6
*/
public static final String WIDGETSET_VERSION_ID = "wsver";


+ 1
- 1
shared/src/com/vaadin/shared/ContextClickRpc.java View File

@@ -20,7 +20,7 @@ import com.vaadin.shared.communication.ServerRpc;
/**
* Client-to-server RPC interface for context click events
*
* @since
* @since 7.6
* @author Vaadin Ltd
*/
public interface ContextClickRpc extends ServerRpc {

+ 1
- 0
shared/src/com/vaadin/shared/VBrowserDetails.java View File

@@ -391,6 +391,7 @@ public class VBrowserDetails implements Serializable {
/**
* Tests if the browser is Edge.
*
* @since 7.5.3
* @return true if it is Edge, false otherwise
*/
public boolean isEdge() {

+ 2
- 0
shared/src/com/vaadin/shared/ui/grid/GridConstants.java View File

@@ -28,6 +28,8 @@ public final class GridConstants implements Serializable {

/**
* Enum describing different sections of Grid.
*
* @since 7.6
*/
public enum Section {
HEADER, BODY, FOOTER

+ 1
- 1
shared/src/com/vaadin/shared/ui/grid/GridServerRpc.java View File

@@ -48,7 +48,7 @@ public interface GridServerRpc extends ServerRpc {
/**
* Informs the server that a context click has happened inside of Grid.
*
* @since
* @since 7.6
* @param rowIndex
* index of clicked row in Grid section
* @param rowKey

+ 12
- 2
shared/src/com/vaadin/shared/ui/grid/GridState.java View File

@@ -105,6 +105,7 @@ public class GridState extends TabIndexState {
/**
* The key in which a row's description can be found
*
* @since 7.6
* @see com.vaadin.shared.data.DataProviderRpc#setRowData(int, String)
*/
public static final String JSONKEY_ROWDESCRIPTION = "rd";
@@ -112,6 +113,7 @@ public class GridState extends TabIndexState {
/**
* The key in which a cell's description can be found
*
* @since 7.6
* @see com.vaadin.shared.data.DataProviderRpc#setRowData(int, String)
*/
public static final String JSONKEY_CELLDESCRIPTION = "cd";
@@ -169,11 +171,19 @@ public class GridState extends TabIndexState {
/** The enabled state of the editor interface */
public boolean editorEnabled = false;

/** Buffered editor mode */
/**
* Buffered editor mode
*
* @since 7.6
*/
@DelegateToWidget
public boolean editorBuffered = true;

/** Whether rows and/or cells have generated descriptions (tooltips) */
/**
* Whether rows and/or cells have generated descriptions (tooltips)
*
* @since 7.6
*/
public boolean hasDescriptions;

/** The caption for the save button in the editor */

+ 2
- 0
shared/src/com/vaadin/shared/ui/table/TableConstants.java View File

@@ -20,6 +20,8 @@ import java.io.Serializable;
public class TableConstants implements Serializable {
/**
* Enum describing different sections of Table.
*
* @since 7.6
*/
public enum Section {
HEADER, BODY, FOOTER

+ 1
- 1
shared/src/com/vaadin/shared/ui/table/TableServerRpc.java View File

@@ -22,7 +22,7 @@ import com.vaadin.shared.ui.table.TableConstants.Section;
/**
* Client-to-server RPC interface for the Table component
*
* @since
* @since 7.6
* @author Vaadin Ltd
*/
public interface TableServerRpc extends ServerRpc {

Loading…
Cancel
Save