* Add missing since tags for 8.1.0.alpha1 * Update @since for DataCommunicatorClientRpc * Update @since for DataCommunicatortags/8.1.0.alpha2
@@ -23,9 +23,9 @@ import elemental.json.JsonObject; | |||
/** | |||
* A connector for HierarchicalDataCommunicator class. | |||
* | |||
* | |||
* @author Vaadin Ltd | |||
* @since | |||
* @since 8.1 | |||
*/ | |||
@Connect(HierarchicalDataCommunicator.class) | |||
public class HierarchicalDataCommunicatorConnector |
@@ -225,6 +225,7 @@ public class DataCommunicator<T> extends AbstractExtension { | |||
* Set the range of rows to push for next response. | |||
* | |||
* @param pushRows | |||
* @since 8.1 | |||
*/ | |||
protected void setPushRows(Range pushRows) { | |||
this.pushRows = pushRows; | |||
@@ -234,6 +235,7 @@ public class DataCommunicator<T> extends AbstractExtension { | |||
* Get the current range of rows to push in the next response. | |||
* | |||
* @return the range of rows to push | |||
* @since 8.1 | |||
*/ | |||
protected Range getPushRows() { | |||
return pushRows; | |||
@@ -241,8 +243,9 @@ public class DataCommunicator<T> extends AbstractExtension { | |||
/** | |||
* Get the object used for filtering in this data communicator. | |||
* | |||
* | |||
* @return the filter object of this data communicator | |||
* @since 8.1 | |||
*/ | |||
protected Object getFilter() { | |||
return filter; | |||
@@ -250,8 +253,9 @@ public class DataCommunicator<T> extends AbstractExtension { | |||
/** | |||
* Get the client rpc interface for this data communicator. | |||
* | |||
* | |||
* @return the client rpc interface for this data communicator | |||
* @since 8.1 | |||
*/ | |||
protected DataCommunicatorClientRpc getClientRpc() { | |||
return rpc; | |||
@@ -268,6 +272,7 @@ public class DataCommunicator<T> extends AbstractExtension { | |||
* the index of the first cached row | |||
* @param cacheSize | |||
* the number of cached rows | |||
* @since 8.1 | |||
*/ | |||
protected void onRequestRows(int firstRowIndex, int numberOfRows, | |||
int firstCachedRowIndex, int cacheSize) { | |||
@@ -280,6 +285,7 @@ public class DataCommunicator<T> extends AbstractExtension { | |||
* | |||
* @param keys | |||
* the keys of the rows that have been dropped | |||
* @since 8.1 | |||
*/ | |||
protected void onDropRows(JsonArray keys) { | |||
for (int i = 0; i < keys.length(); ++i) { | |||
@@ -303,6 +309,7 @@ public class DataCommunicator<T> extends AbstractExtension { | |||
* | |||
* @param initial | |||
* {@code true} if initial data load, {@code false} if not | |||
* @since 8.1 | |||
*/ | |||
protected void sendDataToClient(boolean initial) { | |||
if (getDataProvider() == null) { | |||
@@ -421,6 +428,7 @@ public class DataCommunicator<T> extends AbstractExtension { | |||
* Returns the active data handler. | |||
* | |||
* @return the active data handler | |||
* @since 8.1 | |||
*/ | |||
protected ActiveDataHandler getActiveDataHandler() { | |||
return handler; | |||
@@ -488,6 +496,7 @@ public class DataCommunicator<T> extends AbstractExtension { | |||
* Returns the currently set updated data. | |||
* | |||
* @return the set of data that should be updated on the next response | |||
* @since 8.1 | |||
*/ | |||
protected Set<T> getUpdatedData() { | |||
return updatedData; | |||
@@ -508,6 +517,7 @@ public class DataCommunicator<T> extends AbstractExtension { | |||
* Returns the {@link Comparator} to use with in-memory sorting. | |||
* | |||
* @return comparator used to sort data | |||
* @since 8.1 | |||
*/ | |||
public Comparator<T> getInMemorySorting() { | |||
return inMemorySorting; | |||
@@ -529,6 +539,7 @@ public class DataCommunicator<T> extends AbstractExtension { | |||
* Returns the {@link QuerySortOrder} to use with backend sorting. | |||
* | |||
* @return list of sort order information to pass to a query | |||
* @since 8.1 | |||
*/ | |||
public List<QuerySortOrder> getBackEndSorting() { | |||
return backEndSorting; |
@@ -43,7 +43,7 @@ import elemental.json.JsonObject; | |||
* @param <T> | |||
* the bean type | |||
* @author Vaadin Ltd | |||
* @since | |||
* @since 8.1 | |||
*/ | |||
public class HierarchicalDataCommunicator<T> extends DataCommunicator<T> { | |||
@@ -344,8 +344,7 @@ public class HierarchicalDataCommunicator<T> extends DataCommunicator<T> { | |||
int collapsedSubTreeSize = mapper.collapse(collapsedRowKey, | |||
collapsedRowIndex); | |||
getClientRpc().removeRows(collapsedRowIndex + 1, | |||
collapsedSubTreeSize); | |||
getClientRpc().removeRows(collapsedRowIndex + 1, collapsedSubTreeSize); | |||
// FIXME seems like a slight overkill to do this just for refreshing | |||
// expanded status | |||
refresh(collapsedItem); |
@@ -28,7 +28,7 @@ import java.util.Optional; | |||
* @param <F> | |||
* filter type | |||
* | |||
* @since 8.0 | |||
* @since 8.1 | |||
*/ | |||
public class HierarchicalQuery<T, F> extends Query<T, F> { | |||
@@ -74,7 +74,7 @@ public class HierarchicalQuery<T, F> extends Query<T, F> { | |||
/** | |||
* Get the hierarchical parent object, can be <code>null</code>. | |||
* | |||
* | |||
* @return the hierarchical parent object, can be <code>null</code> | |||
*/ | |||
public T getParent() { | |||
@@ -83,7 +83,7 @@ public class HierarchicalQuery<T, F> extends Query<T, F> { | |||
/** | |||
* Get an Optional of the hierarchical parent object. | |||
* | |||
* | |||
* @see #getParent() | |||
* @return the result of {@link #getParent()} wrapped by an Optional | |||
*/ |
@@ -2115,6 +2115,7 @@ public class Grid<T> extends AbstractListing<T> implements HasComponents, | |||
* the custom data communicator to set | |||
* @see #Grid() | |||
* @see #Grid(PropertySet, DataCommunicator) | |||
* @since 8.1 | |||
*/ | |||
protected Grid(DataCommunicator<T> dataCommunicator) { | |||
this(new PropertySet<T>() { | |||
@@ -2162,6 +2163,7 @@ public class Grid<T> extends AbstractListing<T> implements HasComponents, | |||
* the property set implementation to use, not <code>null</code>. | |||
* @param dataCommunicator | |||
* the data communicator to use, not<code>null</code> | |||
* @since 8.1 | |||
*/ | |||
protected Grid(PropertySet<T> propertySet, | |||
DataCommunicator<T> dataCommunicator) { |
@@ -63,6 +63,7 @@ public interface DataCommunicatorClientRpc extends ClientRpc { | |||
* the destination index of the new row data | |||
* @param count | |||
* the number of rows inserted | |||
* @since 8.1 | |||
*/ | |||
void insertRows(int firstRowIndex, int count); | |||
@@ -74,6 +75,7 @@ public interface DataCommunicatorClientRpc extends ClientRpc { | |||
* @param count | |||
* the number of removed rows, starting from | |||
* <code>firstRowIndex</code> | |||
* @since 8.1 | |||
*/ | |||
void removeRows(int firstRowIndex, int count); | |||
} |
@@ -18,7 +18,7 @@ package com.vaadin.shared.extension.datacommunicator; | |||
/** | |||
* Shared state for HierarchicalDataCommunicator. | |||
* | |||
* @since | |||
* @since 8.1 | |||
*/ | |||
public class HierarchicalDataCommunicatorState extends DataCommunicatorState { | |||