]> source.dussan.org Git - vaadin-framework.git/commitdiff
Updated migration related documentation (#8602) 8.0.0
authorPekka Hyvönen <pekka@vaadin.com>
Fri, 17 Feb 2017 14:01:55 +0000 (16:01 +0200)
committerHenri Sara <henri.sara@gmail.com>
Fri, 17 Feb 2017 14:36:16 +0000 (16:36 +0200)
* Updated migration related documentation

More detailed information on compatibility components.
Mention vaadin:upgrade8 target in migration guide.

Fixes #8581

29 files changed:
compatibility-server/src/main/java/com/vaadin/v7/ui/Calendar.java
compatibility-server/src/main/java/com/vaadin/v7/ui/CheckBox.java
compatibility-server/src/main/java/com/vaadin/v7/ui/ColorPicker.java
compatibility-server/src/main/java/com/vaadin/v7/ui/ColorPickerArea.java
compatibility-server/src/main/java/com/vaadin/v7/ui/ComboBox.java
compatibility-server/src/main/java/com/vaadin/v7/ui/CustomField.java
compatibility-server/src/main/java/com/vaadin/v7/ui/DefaultFieldFactory.java
compatibility-server/src/main/java/com/vaadin/v7/ui/Grid.java
compatibility-server/src/main/java/com/vaadin/v7/ui/HorizontalLayout.java
compatibility-server/src/main/java/com/vaadin/v7/ui/InlineDateField.java
compatibility-server/src/main/java/com/vaadin/v7/ui/Label.java
compatibility-server/src/main/java/com/vaadin/v7/ui/ListSelect.java
compatibility-server/src/main/java/com/vaadin/v7/ui/NativeSelect.java
compatibility-server/src/main/java/com/vaadin/v7/ui/OptionGroup.java
compatibility-server/src/main/java/com/vaadin/v7/ui/PasswordField.java
compatibility-server/src/main/java/com/vaadin/v7/ui/PopupDateField.java
compatibility-server/src/main/java/com/vaadin/v7/ui/ProgressBar.java
compatibility-server/src/main/java/com/vaadin/v7/ui/RichTextArea.java
compatibility-server/src/main/java/com/vaadin/v7/ui/Slider.java
compatibility-server/src/main/java/com/vaadin/v7/ui/Table.java
compatibility-server/src/main/java/com/vaadin/v7/ui/TableFieldFactory.java
compatibility-server/src/main/java/com/vaadin/v7/ui/TextArea.java
compatibility-server/src/main/java/com/vaadin/v7/ui/TextField.java
compatibility-server/src/main/java/com/vaadin/v7/ui/Tree.java
compatibility-server/src/main/java/com/vaadin/v7/ui/TreeTable.java
compatibility-server/src/main/java/com/vaadin/v7/ui/TwinColSelect.java
compatibility-server/src/main/java/com/vaadin/v7/ui/Upload.java
compatibility-server/src/main/java/com/vaadin/v7/ui/VerticalLayout.java
documentation/migration/migrating-to-vaadin8.asciidoc

index d347028895ca05cd0c43b5b946d7003ce5ffa744..bf3089e5314ba435bce40d29b24ef58dca2751c2 100644 (file)
@@ -116,6 +116,8 @@ import com.vaadin.v7.ui.components.calendar.handler.BasicWeekClickHandler;
  *
  * @since 7.1
  * @author Vaadin Ltd.
+ *
+ * @deprecated As of 8.0, no replacement available.
  */
 @SuppressWarnings("serial")
 @Deprecated
@@ -1003,7 +1005,7 @@ public class Calendar extends AbstractLegacyComponent
     /**
      * Sets sort order for events. By default sort order is
      * {@link EventSortOrder#DURATION_DESC}.
-     * 
+     *
      * @param order
      *            sort strategy for events
      */
@@ -1018,7 +1020,7 @@ public class Calendar extends AbstractLegacyComponent
 
     /**
      * Returns sort order for events.
-     * 
+     *
      * @return currently active sort strategy
      */
     public EventSortOrder getEventSortOrder() {
index a75815d9df52612fe465a0cde9d29ecbaa07731b..9aabd6293e41c39589256567a620d0750dc3a79c 100644 (file)
@@ -33,6 +33,12 @@ import com.vaadin.v7.data.Property;
 import com.vaadin.v7.shared.ui.checkbox.CheckBoxServerRpc;
 import com.vaadin.v7.shared.ui.checkbox.CheckBoxState;
 
+/**
+ * @author Vaadin Ltd
+ *
+ * @deprecated As of 8.0 replaced by {@link com.vaadin.ui.CheckBox} based on the
+ *             new data binding API
+ */
 @Deprecated
 public class CheckBox extends AbstractField<Boolean> {
 
index 5f6c857c2e1d7367a5c5c3aa432f0c3432d31ce5..5a90b9864e0fbc9b5762d7b1d9caef3717a66ae8 100644 (file)
@@ -22,9 +22,11 @@ import com.vaadin.v7.shared.ui.colorpicker.Color;
  * component.
  *
  * @since 7.0.0
- *
  * @see ColorPickerArea
+ * @author Vaadin Ltd
  *
+ * @deprecated As of 8.0 replaced by {@link com.vaadin.ui.ColorPicker} based on
+ *             new data binding API
  */
 @Deprecated
 public class ColorPicker extends AbstractColorPicker {
index 06166196d924d6213f5dedee349558e36b0ff2eb..5518f087b1153cad5bfbf430f7a822cca30388c7 100644 (file)
@@ -21,9 +21,11 @@ import com.vaadin.v7.shared.ui.colorpicker.Color;
  * A class that defines area-like implementation for a color picker component.
  *
  * @since 7.0.0
- *
  * @see ColorPicker
+ * @author Vaadin Ltd
  *
+ * @deprecated As of 8.0 replaced by {@link com.vaadin.ui.ColorPickerArea} based
+ *             on new data binding API
  */
 @Deprecated
 public class ColorPickerArea extends AbstractColorPicker {
index 0ecfa9657fb8c9ecf343ee1d3ee06c20d8699672..f6a9d32d6b04f5b8f56183b78c99aae732103060 100644 (file)
@@ -45,6 +45,10 @@ import com.vaadin.v7.shared.ui.combobox.FilteringMode;
  * on newItemsAllowed and change filtering mode (and also turn it off), but you
  * can not turn on multi-select mode.
  *
+ * @author Vaadin Ltd
+ *
+ * @deprecated As of 8.0 replaced by {@link com.vaadin.ui.ComboBox} based on the
+ *             new data binding API
  */
 @SuppressWarnings("serial")
 @Deprecated
index c2e6c3f40fc7c9043a2ae9c1c77a57703b5f7f41..e9b7e504f9ae16bf68a0c1d39b920714b9bf5ae2 100644 (file)
@@ -44,6 +44,10 @@ import com.vaadin.v7.data.Property;
  *            field value type
  *
  * @since 7.0
+ * @author Vaadin Ltd
+ *
+ * @deprecated As of 8.0 replaced by a {@link com.vaadin.ui.CustomField} based
+ *             on new data binding API
  */
 @Deprecated
 public abstract class CustomField<T> extends AbstractField<T>
index 93ea91a9bbd79670acc6dfdefc5e0a9929f6909f..4b60679c419c3a2a124f254cea9e8d02a22bee31 100644 (file)
@@ -1,12 +1,12 @@
 /*
  * Copyright 2000-2016 Vaadin Ltd.
- * 
+ *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not
  * use this file except in compliance with the License. You may obtain a copy of
  * the License at
- * 
+ *
  * http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
@@ -27,11 +27,12 @@ import com.vaadin.v7.data.Property;
  * This class contains a basic implementation for both {@link FormFieldFactory}
  * and {@link TableFieldFactory}. The class is singleton, use {@link #get()}
  * method to get reference to the instance.
- * 
+ *
  * <p>
  * There are also some static helper methods available for custom built field
  * factories.
  * 
+ * @deprecated Removed feature in 8.0
  */
 @Deprecated
 public class DefaultFieldFactory
@@ -41,7 +42,7 @@ public class DefaultFieldFactory
 
     /**
      * Singleton method to get an instance of DefaultFieldFactory.
-     * 
+     *
      * @return an instance of DefaultFieldFactory
      */
     public static DefaultFieldFactory get() {
@@ -74,7 +75,7 @@ public class DefaultFieldFactory
     /**
      * If name follows method naming conventions, convert the name to spaced
      * upper case text. For example, convert "firstName" to "First Name"
-     * 
+     *
      * @param propertyId
      * @return the formatted caption string
      */
@@ -93,7 +94,7 @@ public class DefaultFieldFactory
      * <b>Item</b>: {@link Form}. <br/>
      * <b>default field type</b>: {@link LegacyTextField}.
      * <p>
-     * 
+     *
      * @param type
      *            the type of the property
      * @return the most suitable generic {@link LegacyField} for given type
index 18e47883cef9b95d6b0f0d0d77d6369dd1c91c6e..cabba91d31fafe11357516095adc853810559d97 100644 (file)
@@ -192,6 +192,9 @@ import elemental.json.JsonValue;
  *
  * @since 7.4
  * @author Vaadin Ltd
+ *
+ * @deprecated As of 8.0 replaced by {@link com.vaadin.ui.Grid} based on the new
+ *             data binding API
  */
 @Deprecated
 public class Grid extends AbstractComponent
index 02dd385666b7368d0b183e02f557c30d48b4f02e..de5ae3ab384a6d1d84da966cd27abcc03278a013 100644 (file)
@@ -30,7 +30,9 @@ import com.vaadin.ui.Component;
  *
  * @author Vaadin Ltd.
  * @since 5.3
- * @deprecated use com.vaadin.ui.HorizontalLayout (with different defaults)
+ *
+ * @deprecated Replaced in 8.0 with {@link com.vaadin.ui.HorizontalLayout} with
+ *             spacing on by default
  */
 @Deprecated
 public class HorizontalLayout extends com.vaadin.ui.HorizontalLayout {
index 7c4e7e1721ab91ad829d6c6fa0bb9d1466a791be..84d9437740774b06616e628b3f235d4e69f5faf4 100644 (file)
@@ -18,6 +18,7 @@ package com.vaadin.v7.ui;
 
 import java.util.Date;
 
+import com.vaadin.ui.InlineDateTimeField;
 import com.vaadin.v7.data.Property;
 
 /**
@@ -30,6 +31,9 @@ import com.vaadin.v7.data.Property;
  * @see PopupDateField
  * @author Vaadin Ltd.
  * @since 5.0
+ *
+ * @deprecated As of 8.0, replaced by {@link com.vaadin.ui.InlineDateField} and
+ *             {@link InlineDateTimeField} based on LocalDate
  */
 @Deprecated
 public class InlineDateField extends DateField {
index 559df2487527f94dbc6acd16d4eda9ccc081d38e..6b7f86be20ca0efc10990598dc209583fe8f15a0 100644 (file)
@@ -53,6 +53,9 @@ import com.vaadin.v7.shared.ui.label.LabelState;
  *
  * @author Vaadin Ltd.
  * @since 3.0
+ *
+ * @deprecated As of 8.0, replaced by {@link com.vaadin.ui.Label} that removes
+ *             data binding support
  */
 @SuppressWarnings("serial")
 @Deprecated
index 1e776c4878179aab9efb90c2364eb5fe68882ad6..b5ae1cd396c5db2cd9f7fb6df0508f65e648a3ea 100644 (file)
@@ -25,6 +25,9 @@ import com.vaadin.v7.data.Container;
 /**
  * This is a simple list select without, for instance, support for new items,
  * lazyloading, and other advanced features.
+ *
+ * @deprecated As of 8.0 replaced by {@link com.vaadin.ui.ListSelect} based on
+ *             the new data binding API
  */
 @SuppressWarnings("serial")
 @Deprecated
index a782956867b8f7683559c4f9e4bfc20fff2e1937..42f270619c8257ea817c0beace5190fb1237d9ba 100644 (file)
@@ -31,6 +31,9 @@ import com.vaadin.v7.event.FieldEvents;
  * multiselect, new items, lazyloading, and other advanced features. Sometimes
  * "native" select without all the bells-and-whistles of the ComboBox is a
  * better choice.
+ *
+ * @deprecated As of 8.0 replaced by {@link com.vaadin.ui.NativeSelect} based on
+ *             the new data binding API
  */
 @SuppressWarnings("serial")
 @Deprecated
index 5a64b5a5ca381add5bfcaa024e5e668d26a96254..667149d0e980d7779727a13310dba9d6478a0091 100644 (file)
@@ -41,10 +41,11 @@ import com.vaadin.v7.shared.ui.optiongroup.OptionGroupState;
 /**
  * Configures select to be used as an option group.
  *
- * @deprecated As of 8.0, use {@link RadioButtonGroup} or {@link CheckBoxGroup}
- *             instead
+ * @author Vaadin Ltd
+ *
+ * @deprecated As of 8.0, use {@link RadioButtonGroup} for single select or
+ *             {@link CheckBoxGroup} for multiselect instead
  */
-@SuppressWarnings("serial")
 @Deprecated
 public class OptionGroup extends AbstractSelect
         implements FieldEvents.BlurNotifier, FieldEvents.FocusNotifier {
index cf00f64b8bca074c79e7e05d83e87ad0c2778e33..65dc1f8cda05daf2131100d2fe20a253d31f45b8 100644 (file)
@@ -25,6 +25,9 @@ import com.vaadin.v7.data.Property;
 /**
  * A field that is used to enter secret text information like passwords. The
  * entered text is not displayed on the screen.
+ *
+ * @deprecated As of 8.0 replaced by {@link com.vaadin.ui.PasswordField} based
+ *             on the new data binding API
  */
 @Deprecated
 public class PasswordField extends AbstractTextField {
index 317fc30f45701e493366fd45be4c34d2f15688e4..52de405477a828e606aa8de475df6ecd322fabc4 100644 (file)
@@ -20,6 +20,7 @@ import java.util.Date;
 
 import com.vaadin.server.PaintException;
 import com.vaadin.server.PaintTarget;
+import com.vaadin.ui.DateTimeField;
 import com.vaadin.v7.data.Property;
 import com.vaadin.v7.shared.ui.datefield.PopupDateFieldState;
 
@@ -33,6 +34,9 @@ import com.vaadin.v7.shared.ui.datefield.PopupDateFieldState;
  * @see InlineDateField
  * @author Vaadin Ltd.
  * @since 5.0
+ *
+ * @deprecated As of 8.0, use {@link com.vaadin.ui.DateField} or
+ *             {@link DateTimeField} instead.
  */
 @Deprecated
 public class PopupDateField extends DateField {
index 12b02865771fa0093574551fbc40a0d0cd785354..b23cf99097adcdc2336ef867e9bdb69d093f1a0a 100644 (file)
@@ -33,6 +33,9 @@ import com.vaadin.v7.shared.ui.progressindicator.ProgressBarState;
  *
  * @since 7.1
  * @author Vaadin Ltd
+ *
+ * @deprecated As of 8.0 replaced by {@link com.vaadin.ui.ProgressBar} based on
+ *             the new data binding API
  */
 @Deprecated
 public class ProgressBar extends AbstractField<Float>
index ca638a98da79e7d66bb741937f1efc1839a9a765..3b6d4f7b5a539db2d750a7e3ef9f8186b43b70e5 100644 (file)
@@ -33,6 +33,9 @@ import com.vaadin.v7.shared.ui.textarea.RichTextAreaState;
  * Note, that using {@link TextField#setMaxLength(int)} method in
  * {@link RichTextArea} may produce unexpected results as formatting is counted
  * into length of field.
+ *
+ * @deprecated As of 8.0 replaced by {@link com.vaadin.ui.RichTextArea} based on
+ *             the new data binding API
  */
 @Deprecated
 public class RichTextArea extends AbstractField<String>
index a898773f7c13544c12dc017850c787adde67ef60..9777677e4c9a520d91251a472f5d2f89eb3cb86e 100644 (file)
@@ -31,6 +31,9 @@ import com.vaadin.v7.shared.ui.slider.SliderState;;
  * A component for selecting a numerical value within a range.
  *
  * @author Vaadin Ltd.
+ *
+ * @deprecated As of 8.0 replaced by {@link com.vaadin.ui.Slider} based on the
+ *             new data binding API
  */
 @Deprecated
 public class Slider extends AbstractField<Double> {
index ab5dcd62f06ac30a6fe1f4e129c6ca01a51fe106..0636768e2d29060335d62e5c32072e6136b7ebe1 100644 (file)
@@ -101,6 +101,8 @@ import com.vaadin.v7.shared.ui.table.TableState;
  *
  * @author Vaadin Ltd.
  * @since 3.0
+ *
+ * @deprecated As of 8.0, use Grid instead
  */
 @Deprecated
 @SuppressWarnings({ "deprecation" })
index 676f2f6366e80240a7cd6947052df7626e76bee7..8bdec4ca66a126cde94cf2267b4bda6620f7723d 100644 (file)
@@ -32,6 +32,8 @@ import com.vaadin.v7.data.Container;
  * @author Vaadin Ltd.
  * @since 6.0
  * @see FormFieldFactory
+ *
+ * @deprecated As of 8.0, Table is replaced by Grid
  */
 @Deprecated
 public interface TableFieldFactory extends Serializable {
index c635c0835c592479e2abdea85efd2ba8739b1222..84139030df1b4a9c17eb64a3eddde404193d3a28 100644 (file)
@@ -25,6 +25,9 @@ import com.vaadin.v7.shared.ui.textarea.TextAreaState;
 
 /**
  * A text field that supports multi line editing.
+ *
+ * @deprecated As of 8.0 replaced by {@link com.vaadin.ui.TextArea} based on the
+ *             new data binding API
  */
 @Deprecated
 public class TextArea extends AbstractTextField {
index d7f9d07b0bf6e981064035a4b0755b63a49d209b..48bd2b77a521449204623cbb6046d9b1b831c81c 100644 (file)
@@ -40,6 +40,9 @@ import com.vaadin.v7.data.Property;
  *
  * @author Vaadin Ltd.
  * @since 3.0
+ *
+ * @deprecated As of 8.0 replaced by {@link com.vaadin.ui.TextField} based on
+ *             the new data binding API
  */
 @SuppressWarnings("serial")
 @Deprecated
index dd0549f7b76dd368d31d5ada85bc364c41832b71..bb019e1b03dba54fab067a9c8342ed7471bb4b05 100644 (file)
@@ -74,6 +74,8 @@ import com.vaadin.v7.shared.ui.tree.TreeState;
  *
  * @author Vaadin Ltd.
  * @since 3.0
+ *
+ * @deprecated As of 8.0. Replacement planned for 8.1
  */
 @SuppressWarnings({ "serial", "deprecation" })
 @Deprecated
index e5b18472e8dc207898410e2eda58ed4cabfd3ce4..df471d597389d9b9ee5d9c92afee4429eb1b677f 100644 (file)
@@ -66,6 +66,8 @@ import com.vaadin.v7.ui.Tree.ExpandListener;
  * standard Hierarchical implementations. Developer must however note that
  * {@link Collapsible} containers can not be shared among several users as they
  * share UI state in the container.
+ *
+ * @deprecated As of 8.0. Replacement planned for 8.1
  */
 @SuppressWarnings({ "serial" })
 @Deprecated
index 50d9e60bb6719c3e2b076b113740bc41958baf30..d1ddaa4f0823070d4df458aed8b18183fbe2321d 100644 (file)
@@ -27,6 +27,9 @@ import com.vaadin.v7.shared.ui.twincolselect.TwinColSelectState;
 /**
  * Multiselect component with two lists: left side for available items and right
  * side for selected items.
+ *
+ * @deprecated As of 8.0 replaced by {@link com.vaadin.ui.TwinColSelect} based
+ *             on the new data binding API
  */
 @SuppressWarnings("serial")
 @Deprecated
index 20348c206f522732ae6c21be0ecd04c7725ed344..a1f987b55e1fd3fa25fbbaf77c3af6b7d8c72e46 100644 (file)
@@ -73,6 +73,9 @@ import com.vaadin.v7.shared.ui.upload.UploadState;
  *
  * @author Vaadin Ltd.
  * @since 3.0
+ *
+ * @deprecated As of 8.0 replaced by {@link com.vaadin.ui.Upload} that is by
+ *             default in immediate mode.
  */
 @SuppressWarnings("serial")
 @Deprecated
index 3d56dc58278504ed4a2b6e659d1979f47d95d0aa..cb5fea11787ddf0418b4f3e0fb5e45ad72fd33c2 100644 (file)
@@ -31,7 +31,9 @@ import com.vaadin.ui.Component;
  *
  * @author Vaadin Ltd.
  * @since 5.3
- * @deprecated use com.vaadin.ui.VerticalLayout (with different defaults)
+ *
+ * @deprecated Replaced in 8.0 with {@link com.vaadin.ui.VerticalLayout} with
+ *             margin and spacing on by default
  */
 @Deprecated
 public class VerticalLayout extends com.vaadin.ui.VerticalLayout {
index b39bc8ec1a52dcafa4f49b24be3b82f1e22e4378..0a351240ab413752c5e234bafb76a264ca48c49c 100644 (file)
@@ -3,7 +3,6 @@ title: Migrating to Framework 8
 order: 1
 layout: page
 ---
-// TODO: Fix release note links to point to 8.0.0
 [[migration]]
 == Migration from Framework 7 to Framework 8
 
@@ -17,7 +16,7 @@ This is primarily to get an existing Framework 7 project up and running with Fra
 
 The very first step in migration is to ensure that your project is configured to use Framework 8 dependencies, as well as include any of the desired compatibility packages needed in your migration.
 Also note that Framework 8 requires JDK 8 for development.
-For deployment configurations, refer to the list of supported technologies in the release notes, available at link:https://vaadin.com/download/prerelease/8.0/8.0.0/8.0.0.beta1/release-notes.html#supportedversions[].
+For deployment configurations, refer to the list of supported technologies in the release notes, available at link:https://vaadin.com/download/release/8.0/8.0.0/release-notes.html#supportedversions[].
 
 ==== Updating Maven Dependencies
 
@@ -76,6 +75,12 @@ For add-on developers, the same steps outlined in this guide can also be applied
 Once your project's dependencies have been updated for Framework 8 migration there are a few steps to begin using the compatibility versions of the old APIs, namely changing of imports and ensuring that your widgetset is correctly set up.
 Optionally, if you are using Vaadin Designer or declarative files otherwise, the tag names for compatibility components need to be updated.
 
+==== The Migration Tool
+
+To ease the migration process, the vaadin maven plugin has a target `vaadin:upgrade8` which updates all
+imports in java files and prefixes in design files to point to the versions in the compatibility packages.
+This migration tool is available separately at link:https://github.com/vaadin/framework8-migration-tool[].
+
 ==== Changing Imports
 
 The only change to classes in the compatibility packages is the change in their classpath. All compatibility classes can be found under `com.vaadin.v7.*`.
@@ -89,6 +94,9 @@ Typically, widgetset recompilation will handle this automatically for you, excep
 * Your project defines a custom widgetset, in which case you need to make sure `Vaadin7WidgetSet` is inherited
 * An UI in your project defines its widgetset with the annotation `@WidgetSet("com.vaadin.DefaultWidgetSet")`, which should be changed to `@WidgetSet("com.vaadin.v7.Vaadin7WidgetSet")`
 
+IMPORTANT: The widgetset compilation for `Vaadin7WidgetSet` requires at least 1G of memory. To ensure this, add
+`<extraJvmArgs>-Xmx1G</extraJvmArgs>` to the vaadin-maven-plugin configuration in your `pom.xml` file.
+
 ==== Using Compatibility Components In Declarative Files
 
 Using components from the compatibility packages in your declarative files only requires you to change the prefix from `vaadin-` or alternatively `v-` to `vaadin7-`.
@@ -106,10 +114,6 @@ to its compatibility equivalent, `com.vaadin.v7.ui.TextField`, would simply be a
 
 in the corresponding design html file.
 
-==== The Migration Tool
-
-To ease the process of the initial changing of imports and prefixes in design files, a tool for automatically applying these changes to a project is available at link:https://github.com/vaadin/framework8-migration-tool[].
-Please refer to the README available in the repository for up to date instructions on how to run the tool on your project.
 
 === Next Steps