diff options
author | Leif Ă…strand <leif@vaadin.com> | 2015-05-12 10:50:45 +0300 |
---|---|---|
committer | Teppo Kurki <teppo.kurki@vaadin.com> | 2015-05-12 11:02:15 +0000 |
commit | 22271249251894dfc7cfbebad6b4d2faf4c0313e (patch) | |
tree | 31892d24366c14da9e1f6767b35bd4f51f80e95e | |
parent | c30438b27d474e5f47d7f58045b77bbcb606ff7a (diff) | |
download | vaadin-framework-22271249251894dfc7cfbebad6b4d2faf4c0313e.tar.gz vaadin-framework-22271249251894dfc7cfbebad6b4d2faf4c0313e.zip |
Add missing @since for 7.5
Change-Id: Id8f78c9ef7670c5413d3b7d28eef732dd1b7512d
13 files changed, 66 insertions, 7 deletions
diff --git a/client/src/com/vaadin/client/connectors/GridConnector.java b/client/src/com/vaadin/client/connectors/GridConnector.java index d31baaa665..d3fa678c3e 100644 --- a/client/src/com/vaadin/client/connectors/GridConnector.java +++ b/client/src/com/vaadin/client/connectors/GridConnector.java @@ -1415,6 +1415,13 @@ public class GridConnector extends AbstractHasComponentsConnector implements || lazyDetailsScrollAdjuster.isWorkPending(); } + /** + * Gets the listener used by this connector for tracking when row detail + * visibility changes. + * + * @since 7.5.0 + * @return the used details listener + */ public DetailsListener getDetailsListener() { return detailsListener; } diff --git a/client/src/com/vaadin/client/widgets/Escalator.java b/client/src/com/vaadin/client/widgets/Escalator.java index 7c18df3c7d..16d1a9f5c2 100644 --- a/client/src/com/vaadin/client/widgets/Escalator.java +++ b/client/src/com/vaadin/client/widgets/Escalator.java @@ -1354,6 +1354,8 @@ public class Escalator extends Widget implements RequiresResize, * Any extra content, such as spacers for the body, should not be * included in this count. * + * @since 7.5.0 + * * @return the actual DOM count of rows */ public abstract int getDomRowCount(); @@ -1755,6 +1757,8 @@ public class Escalator extends Widget implements RequiresResize, * In practice, this applies for all header and footer rows. For body * rows, it applies for all rows except spacer rows. * + * @since 7.5.0 + * * @param tr * the row element to check for if it is or has elements that * can be frozen @@ -2118,6 +2122,8 @@ public class Escalator extends Widget implements RequiresResize, * Note that {@link Escalator#getBody() the body} will calculate its * height, while the others will return a precomputed value. * + * @since 7.5.0 + * * @return the height of this table section */ protected abstract double getHeightOfSection(); diff --git a/client/src/com/vaadin/client/widgets/Grid.java b/client/src/com/vaadin/client/widgets/Grid.java index c20bdb0bd4..51f44edd8a 100644 --- a/client/src/com/vaadin/client/widgets/Grid.java +++ b/client/src/com/vaadin/client/widgets/Grid.java @@ -216,6 +216,8 @@ public class Grid<T> extends ResizeComposite implements /** * Abstract base class for Grid header and footer sections. * + * @since 7.5.0 + * * @param <ROWTYPE> * the type of the rows in the section */ diff --git a/server/src/com/vaadin/data/RpcDataProviderExtension.java b/server/src/com/vaadin/data/RpcDataProviderExtension.java index e645ec60f7..cc1fbcf5e3 100644 --- a/server/src/com/vaadin/data/RpcDataProviderExtension.java +++ b/server/src/com/vaadin/data/RpcDataProviderExtension.java @@ -50,6 +50,7 @@ import com.vaadin.server.KeyMapper; import com.vaadin.shared.data.DataProviderRpc; import com.vaadin.shared.data.DataRequestRpc; import com.vaadin.shared.ui.grid.DetailsConnectorChange; +import com.vaadin.shared.ui.grid.GridClientRpc; import com.vaadin.shared.ui.grid.GridState; import com.vaadin.shared.ui.grid.Range; import com.vaadin.shared.util.SharedUtil; @@ -135,6 +136,15 @@ public class RpcDataProviderExtension extends AbstractExtension { return String.valueOf(rollingIndex++); } + /** + * Gets the key for a given item id. Creates a new key mapping if no + * existing mapping was found for the given item id. + * + * @since 7.5.0 + * @param itemId + * the item id to get the key for + * @return the key for the given item id + */ public String getKey(Object itemId) { String key = itemIdToKey.get(itemId); if (key == null) { @@ -1428,6 +1438,11 @@ public class RpcDataProviderExtension extends AbstractExtension { return visibleDetails.contains(itemId); } + /** + * Refreshes all visible detail sections. + * + * @since 7.5.0 + */ public void refreshDetails() { for (Object itemId : ImmutableSet.copyOf(visibleDetails)) { detailComponentManager.refresh(itemId); @@ -1443,7 +1458,12 @@ public class RpcDataProviderExtension extends AbstractExtension { return container.indexOfId(itemId); } - /** Gets the detail component manager for this data provider */ + /** + * Gets the detail component manager for this data provider + * + * @since 7.5.0 + * @return the detail component manager + * */ public DetailComponentManager getDetailComponentManager() { return detailComponentManager; } diff --git a/server/src/com/vaadin/data/util/converter/StringToCollectionConverter.java b/server/src/com/vaadin/data/util/converter/StringToCollectionConverter.java index a84a3575f7..495bed74f8 100644 --- a/server/src/com/vaadin/data/util/converter/StringToCollectionConverter.java +++ b/server/src/com/vaadin/data/util/converter/StringToCollectionConverter.java @@ -34,6 +34,8 @@ import java.util.Locale; * {@link String} for token types. Other constructors allow to configure * delimiter and token types. * + * @since 7.5.0 + * * @author Vaadin Ltd */ public class StringToCollectionConverter implements diff --git a/server/src/com/vaadin/ui/AbstractSingleComponentContainer.java b/server/src/com/vaadin/ui/AbstractSingleComponentContainer.java index 767ae66515..0854ffe9c2 100644 --- a/server/src/com/vaadin/ui/AbstractSingleComponentContainer.java +++ b/server/src/com/vaadin/ui/AbstractSingleComponentContainer.java @@ -298,7 +298,9 @@ public abstract class AbstractSingleComponentContainer extends * contains multiple child elements, a DesignException is thrown. This * method should be overridden by subclasses whose design may contain * non-content child elements. - * + * + * @since 7.5.0 + * * @param children * the child elements of the design that is being read * @param context diff --git a/server/src/com/vaadin/ui/CustomLayout.java b/server/src/com/vaadin/ui/CustomLayout.java index ceb47e1e7a..d64f70e95e 100644 --- a/server/src/com/vaadin/ui/CustomLayout.java +++ b/server/src/com/vaadin/ui/CustomLayout.java @@ -74,6 +74,8 @@ public class CustomLayout extends AbstractLayout implements LegacyComponent { * for setting the appropriate fields. Either * {@link #setTemplateName(String)}, that makes layout fetch the template * from theme, or {@link #setTemplateContents(String)}. + * + * @since 7.5.0 */ public CustomLayout() { setWidth(100, Unit.PERCENTAGE); diff --git a/server/src/com/vaadin/ui/DragAndDropWrapper.java b/server/src/com/vaadin/ui/DragAndDropWrapper.java index b813973861..ba912f15dc 100644 --- a/server/src/com/vaadin/ui/DragAndDropWrapper.java +++ b/server/src/com/vaadin/ui/DragAndDropWrapper.java @@ -191,6 +191,8 @@ public class DragAndDropWrapper extends CustomComponent implements DropTarget, /** * This is an internal constructor. Use * {@link DragAndDropWrapper#DragAndDropWrapper(Component)} instead. + * + * @since 7.5.0 */ @Deprecated public DragAndDropWrapper() { diff --git a/server/src/com/vaadin/ui/Grid.java b/server/src/com/vaadin/ui/Grid.java index ac5efad5e4..5cc1a6752e 100644 --- a/server/src/com/vaadin/ui/Grid.java +++ b/server/src/com/vaadin/ui/Grid.java @@ -3175,14 +3175,16 @@ public class Grid extends AbstractComponent implements SelectionNotifier, return getState().hidable; } - /* + /** * Writes the design attributes for this column into given element. * * @since 7.5.0 * - * @param design Element to write attributes into + * @param design + * Element to write attributes into * - * @param designContext the design context + * @param designContext + * the design context */ protected void writeDesign(Element design, DesignContext designContext) { Attributes attributes = design.attributes(); @@ -4303,6 +4305,8 @@ public class Grid extends AbstractComponent implements SelectionNotifier, * added for any property id in propertyIds that has no corresponding column * in this Grid. * + * @since 7.5.0 + * * @param propertyIds * properties in the desired column order */ diff --git a/server/src/com/vaadin/ui/PopupView.java b/server/src/com/vaadin/ui/PopupView.java index 12034cb56c..73c93b29f3 100644 --- a/server/src/com/vaadin/ui/PopupView.java +++ b/server/src/com/vaadin/ui/PopupView.java @@ -69,6 +69,8 @@ public class PopupView extends AbstractComponent implements HasComponents { /** * This is an internal constructor. Use * {@link PopupView#PopupView(String, Component)}Â instead. + * + * @since 7.5.0 */ @Deprecated public PopupView() { @@ -106,6 +108,8 @@ public class PopupView extends AbstractComponent implements HasComponents { /** * Creates a Content from given text representation and popup content. * + * @since 7.5.0 + * * @param minimizedValue * text representation when popup is hidden * @param popupContent diff --git a/server/src/com/vaadin/ui/declarative/DesignContext.java b/server/src/com/vaadin/ui/declarative/DesignContext.java index d6cb970ce8..0d68c22ea0 100644 --- a/server/src/com/vaadin/ui/declarative/DesignContext.java +++ b/server/src/com/vaadin/ui/declarative/DesignContext.java @@ -171,6 +171,8 @@ public class DesignContext implements Serializable { * component was mapped to some string s different from localId, the mapping * from s to component is removed. * + * @since 7.5.0 + * * @param component * The component whose local id is to be set. * @param localId @@ -186,7 +188,9 @@ public class DesignContext implements Serializable { } /** - * Returns the local id for a component + * Returns the local id for a component. + * + * @since 7.5.0 * * @param component * The component whose local id to get. diff --git a/shared/src/com/vaadin/shared/ui/MarginInfo.java b/shared/src/com/vaadin/shared/ui/MarginInfo.java index d15fa0a281..7119ce2f90 100644 --- a/shared/src/com/vaadin/shared/ui/MarginInfo.java +++ b/shared/src/com/vaadin/shared/ui/MarginInfo.java @@ -115,6 +115,8 @@ public class MarginInfo implements Serializable { /** * Checks if this MarginInfo object has margins on all edges enabled. * + * @since 7.5.0 + * * @return true if all edges have margins enabled */ public boolean hasAll() { diff --git a/shared/src/com/vaadin/shared/ui/grid/GridState.java b/shared/src/com/vaadin/shared/ui/grid/GridState.java index e039f70988..c23c931683 100644 --- a/shared/src/com/vaadin/shared/ui/grid/GridState.java +++ b/shared/src/com/vaadin/shared/ui/grid/GridState.java @@ -103,7 +103,9 @@ public class GridState extends AbstractComponentState { public static final String JSONKEY_CELLSTYLES = "cs"; /** - * The key that tells whether details are visible for the row + * The key that tells whether details are visible for the row. + * + * @since 7.5.0 * * @see com.vaadin.ui.Grid#setDetailsGenerator(com.vaadin.ui.Grid.DetailsGenerator) * @see com.vaadin.ui.Grid#setDetailsVisible(Object, boolean) |