You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

release-notes.html 19KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html>
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  5. <title>Vaadin Framework @version@</title>
  6. <link rel="stylesheet" type="text/css" href="css/styles.css" />
  7. <style type="text/css">
  8. .nested-list ol {
  9. counter-reset: item
  10. }
  11. .nested-list li {
  12. display: block
  13. }
  14. .nested-list li:before {
  15. content: counters(item, ".") ". ";
  16. counter-increment: item
  17. }
  18. </style>
  19. </head>
  20. <body>
  21. <div id="header">
  22. <h1>Vaadin &ndash; Fight For Simplicity</h1>
  23. <div id="version">
  24. <strong>Version @version@</strong>
  25. </div>
  26. </div>
  27. <!-- /header -->
  28. <div id="content">
  29. <p>Version @version@ built on @builddate@.</p>
  30. <h2 id="tableofcontents">Release Notes for Vaadin Framework
  31. @version@</h2>
  32. <ul>
  33. <li><a href="#overview">Overview of Vaadin Framework
  34. @version@ release</a></li>
  35. <li><a href="#changelog">Change Log for Vaadin Framework
  36. @version@</a></li>
  37. <li><a href="#enhancements">Enhancements in Vaadin Framework
  38. @version-minor@</a></li>
  39. <li><a href="#incompatible">Incompatible or Behavior-altering Changes in
  40. @version-minor@</a></li>
  41. <li><a href="#knownissues">Known Issues and Limitations</a></li>
  42. <li><a href="#starting">Getting started with Vaadin Framework</a></li>
  43. <li><a href="#package">Package Contents</a></li>
  44. <li><a href="#migrating">Migrating from Vaadin 7.7</a></li>
  45. <li><a href="#dependencies">Vaadin Framework @version@
  46. dependencies</a></li>
  47. <li><a href="#supportedversions">Supported
  48. Technologies</a></li>
  49. <li><a href="#vaadinontheweb">Vaadin Framework on the Web</a></li>
  50. </ul>
  51. <h2 id="overview">Overview of Vaadin Framework @version@ Release</h2>
  52. <p>
  53. Vaadin Framework @version@ is a
  54. <!-- maintenance release that includes a number of bug fixes, as listed in the <a href="#changelog">change log</a> below. -->
  55. <!-- feature release that includes -->
  56. pre-release for evaluating
  57. a number of new features and bug fixes, as listed in the <a
  58. href="#enhancements">list of enhancements</a> and <a
  59. href="#changelog">change log</a> below.
  60. The API in this alpha version is not considered final and may change based on your feedback.
  61. </p>
  62. <!-- ================================================================ -->
  63. <h3 id="changelog">Change Log for Vaadin Framework @version@</h3>
  64. <!-- @release-notes-changelog@ -->
  65. <p>
  66. You can find the full list of all changes <a
  67. href="https://github.com/vaadin/framework/releases/tag/@version@">in
  68. GitHub</a>.
  69. </p>
  70. <h2 id="enhancements">Enhancements in Vaadin Framework @version-minor@</h2>
  71. <p>Vaadin Framework @version-minor@ includes many major and minor
  72. enhancements. Below is a list of the most notable changes:</p>
  73. <ul>
  74. <li></li>
  75. </ul>
  76. </p>
  77. <p>
  78. For enhancements introduced in Vaadin Framework 8.11, see the <a
  79. href="http://vaadin.com/download/release/8.11/8.11.0/release-notes.html">Release
  80. Notes for Vaadin Framework 8.11.0</a>.
  81. For migrating from previous framework versions, see <a href="#incompatible">the list of incompatible changes</a> and <a href="#migrating">how to migrate
  82. to Vaadin Framework 8</a>.
  83. </p>
  84. <h2 id="incompatible">Incompatible or Behavior-altering Changes in @version-minor@</h2>
  85. <ul>
  86. <li></li>
  87. </ul>
  88. <h2>For incompatible or behavior-altering changes in 8.11, please see <a href="https://vaadin.com/download/release/8.11/8.11.0/release-notes.html#incompatible">8.11 release notes</a></h2>
  89. <h3 id="knownissues">Known Issues and Limitations</h3>
  90. <ul>
  91. <li><tt>@PushStateNavigation</tt> can cause browser to load resources from wrong URLs
  92. (<a href="https://github.com/vaadin/framework/issues/10329">#10329</a>)
  93. </li>
  94. <li>Drag'n'drop in a Table doesn't work on touch devices running
  95. Internet Explorer (Windows Phone, Surface)
  96. (<a href="https://github.com/vaadin/framework/issues/5170">#5170</a>)
  97. </li>
  98. <li>Payload based drop criteria do not work on IE11 - use criteria scripts if IE11 support of drop validation is required</li>
  99. <li>Specifying layout sizes using <tt>em</tt> is currently discouraged, because it results in fractional
  100. components sizes in many cases, which might cause unwanted 1px gaps between components.
  101. </li>
  102. <li>Up-to-date information about configuration needed for push and compatibility issues are available in
  103. <a href="https://vaadin.com/wiki/-/wiki/Main/Configuring+push+for+your+environment">this wiki page.</a>
  104. <br />
  105. The most prominent limitations are:
  106. <ul>
  107. <li>Push is currently not supported in portals (See <a
  108. href="https://github.com/vaadin/framework/issues/3741">#3741</a>)
  109. </li>
  110. <li>Transport mode WEBSOCKET does not support invalidating the session on Tomcat 7,
  111. nor setting cookies for the session. The new transport mode WEBSOCKET_XHR can be
  112. used to bypass these limitations.
  113. <br />
  114. See tickets <a href="https://github.com/vaadin/framework/issues/3911">#3911</a> and
  115. <a href="https://github.com/vaadin/framework/issues/3861">#3861</a>
  116. </li>
  117. </ul>
  118. </li>
  119. <li>The Maven GWT compilation for <tt>Vaadin7WidgetSet</tt> requires at least 1G of memory, when using the <tt>vaadin-client-compatibility</tt> package. If compiled inside Eclipse, possibly even more.</li>
  120. </ul>
  121. <h2 id="starting">Getting started with Vaadin Framework</h2>
  122. <p>
  123. <b>Vaadin Framework</b> is a Java framework for building modern web
  124. applications that look great, perform well and make you and
  125. your users happy. <b>The Framework</b> is available under the
  126. Apache License, Version 2.0 (see the
  127. <tt>license.html</tt>
  128. in the Vaadin Framework ZIP package).
  129. </p>
  130. <p>
  131. The easiest ways to start using <b>Vaadin Framework</b> are:
  132. </p>
  133. <ul>
  134. <li><strong>Maven dependency.</strong>If using Maven, define it as a dependency or use
  135. any of the available archetypes to create a new project. More information at
  136. <a href="https://vaadin.com/maven">https://vaadin.com/maven</a>
  137. </li>
  138. <li><strong>IDE Plugins.</strong>If using Eclipse, use the
  139. <a href="http://vaadin.com/eclipse">Vaadin Plugin for Eclipse</a>, which automatically
  140. downloads the Framework libraries. For NetBeans 8.0 and 7.4, use the
  141. <a href="http://plugins.netbeans.org/plugin/50531/vaadin-plug-in-for-netbeans">official Vaadin plugin</a>
  142. that provides Maven based wizards and code completion support for Vaadin Framework based development.
  143. </li>
  144. </ul>
  145. <p>
  146. Vaadin Framework is also available as a ZIP package downloadable from <a
  147. href="http://vaadin.com/download">Vaadin Download
  148. page</a>.
  149. </p>
  150. <h3 id="package">Package Contents</h3>
  151. <p>Inside the ZIP installation package you will find:</p>
  152. <ul>
  153. <li>Separate server-side (<tt>vaadin-server</tt>) and
  154. client-side (<tt>vaadin-client</tt>, <tt>vaadin-client-compiler</tt>)
  155. development libraries
  156. </li>
  157. <li>Precompiled widget set (<tt>vaadin-client-compiled</tt>)
  158. for server-side development
  159. </li>
  160. <li>Shared library (<tt>vaadin-shared</tt>) for both
  161. server- and client-side libraries
  162. </li>
  163. <li>Valo theme (the only inbuilt theme) (<tt>vaadin-themes</tt>)
  164. </li>
  165. <li>Dependency libraries provided under the <tt>lib/</tt>
  166. folder
  167. </li>
  168. <li>Vaadin 7 compatible classes for server-side (<tt>vaadin-compatibility-server</tt>,
  169. <tt>vaadin-compatibility-shared</tt>), client-side (<tt>vaadin-compatibility-client</tt>) and themes (<tt>vaadin-compatibility-themes</tt>)
  170. </li>
  171. </ul>
  172. <p>
  173. See the
  174. <tt>README.TXT</tt>
  175. in the installation package for detailed information about
  176. the package contents.
  177. </p>
  178. <p>
  179. For server-side development, copy the
  180. <tt>vaadin-server</tt>
  181. ,
  182. <tt>vaadin-client-compiled</tt>
  183. ,
  184. <tt>vaadin-shared</tt>
  185. , and
  186. <tt>vaadin-themes</tt>
  187. from the main folder and the dependencies from the
  188. <tt>lib</tt>
  189. folder to the
  190. <tt>WEB-INF/lib</tt>
  191. folder of your Vaadin project. (The
  192. <tt>vaadin-client-compiled</tt>
  193. is necessary if you do not wish to compile the widget set by
  194. your own, which you need to do if you use almost any add-on
  195. components.)
  196. </p>
  197. <h2 id="migrating">Migrating from Vaadin Framework 7.7</h2>
  198. <p>
  199. Most Vaadin Framework 7 applications need some changes when migrating
  200. to Vaadin Framework 8. In addition to updating dependencies, all references to
  201. Framework 7 style data binding and components using it need to be
  202. updated either to use new Framework 8 style data binding or to use the
  203. compatibility versions in separate packages.
  204. </p>
  205. <p>
  206. Vaadin Framework 7 compatible versions of the old data binding API and
  207. components (with the exception of Form) are available in the package
  208. com.vaadin.v7 in modules vaadin-compatibility-server,
  209. vaadin-compatibility-shared etc. that can be used instead of
  210. vaadin-server, vaadin-shared etc. The package
  211. vaadin-compatibility-client-compiled contains the widgetset
  212. <tt>com.vaadin.v7.Vaadin7WidgetSet</tt> which can be used instead of
  213. <tt>DefaultWidgetSet</tt>. Please note that the rename to com.vaadin.v7
  214. has only been applied to classes that are only relevant for the
  215. compatibility modules. Some classes have also been renamed while still
  216. being part of the non-compatibility modules.
  217. </p>
  218. <p>
  219. All applications using either <tt>Reindeer</tt>, <tt>Runo</tt>, <tt>Chameleon</tt> or <tt>Base</tt> theme must include the <tt>vaadin-compatibility-themes</tt> package.
  220. </p>
  221. <p>
  222. There is a <a href="https://github.com/vaadin/framework8-migration-tool/">
  223. migration tool</a> which helps with some of the migration steps.
  224. </p>
  225. <p>
  226. Some Vaadin Framework 7 add-ons do not work in version 8 - please check the add-ons in <a
  227. href="http://vaadin.com/directory/">Vaadin Directory</a>
  228. for Framework version 8 support.
  229. </p>
  230. <h3 id="upgrading">Common Upgrade Steps</h3>
  231. <p>Always when upgrading from an earlier Vaadin Framework version, you
  232. must:</p>
  233. <ul>
  234. <li>Recompile your classes using the new Framework
  235. version. Binary compatibility is only guaranteed for
  236. maintenance releases of Framework.</li>
  237. <li>Unless using the precompiled widget set, recompile
  238. your widget set using the new Framework version.</li>
  239. </ul>
  240. <p>Remember also to refresh the project in your IDE to
  241. ensure that the new version of everything is in use.</p>
  242. <p>
  243. By using the "
  244. <tt>?debug</tt>
  245. " URL parameter, you can verify that the version of the
  246. servlet, the theme, and the widget set all match.
  247. </p>
  248. <p>
  249. <b>Eclipse</b> users should always check if there is a new
  250. version of the Eclipse Plug-in available.
  251. </p>
  252. <p>
  253. <b>Maven</b> users should update the Vaadin Framework dependency
  254. version in the
  255. <tt>pom.xml</tt>
  256. .
  257. </p>
  258. <h2 id="dependencies">Vaadin Framework @version@ Dependencies</h2>
  259. <p>When using Maven, Ivy, Gradle, or other dependency
  260. management system, all Framework dependencies are downloaded
  261. automatically. This is also the case when using the Vaadin
  262. Plugin for Eclipse.</p>
  263. <p>
  264. The Vaadin Framework ZIP installation package includes the
  265. dependencies in the
  266. <tt>lib</tt>
  267. subfolder. These need to be copied to the
  268. <tt>WEB-INF/lib</tt>
  269. folder of the web application that uses Vaadin Framework.
  270. </p>
  271. <p>
  272. The dependencies are listed in the <a href="license.html">Licensing
  273. description</a>. Some are explicit dependencies packaged and
  274. distributed as separate JARs, while some are included inside
  275. other libraries.
  276. </p>
  277. <h3>Bean Validation</h3>
  278. <p>
  279. If you use the bean validation feature, you need
  280. a Bean Validation API implementation. You need to install
  281. the implementation JAR in the
  282. <tt>WEB-INF/lib</tt>
  283. directory of the web application that uses validation.
  284. </p>
  285. <h2 id="supportedversions">Supported Technologies</h2>
  286. <p>
  287. The server-side Vaadin Framework 8 is compatible with <b>Java 8 and 11</b>. Note, that the client-side Java code, compiled using GWT to be run as JS on the browser side, only supports language features up to Java 9 and a subset of JDK libraries.
  288. Vaadin Framework 8 is developed and tested with Oracle JDK, but other
  289. compliant Java distributions should work as well. More about Java support in <a href="https://vaadin.com/faq">
  290. FAQ</a>. Vaadin Framework
  291. 8 is especially supported on the following <b>operating
  292. systems</b>:
  293. </p>
  294. <ul>
  295. <li>Windows</li>
  296. <li>Linux</li>
  297. <li>Mac OS X</li>
  298. </ul>
  299. <p>
  300. Vaadin Framework 8 requires <b>Java Servlet API 3.0</b> but also
  301. supports later versions and should work with any Java
  302. application server that conforms to the standard. The
  303. following <b>application servers</b> are supported:
  304. </p>
  305. <ul id="supportedservers">
  306. <li>Apache Tomcat 7-9</li>
  307. <li>Apache TomEE 1.7 and 7.0</li>
  308. <li>Oracle WebLogic Server 12.2</li>
  309. <li>IBM WebSphere Application Server 9</li>
  310. <li>JBoss EAP 6</li>
  311. <li>Wildfly 8-13</li>
  312. <li>Jetty 8-9</li>
  313. <li>Glassfish 4</li>
  314. <li>Payara Server 164</li>
  315. </ul>
  316. <p>
  317. Vaadin Framework 8 supports the JSR-286 Portlet specification and all
  318. portals that implement the specification should work provided
  319. they support Java 8 and Servlet 3.0. The following <b>portals</b>
  320. are supported:
  321. </p>
  322. <ul>
  323. <li>Liferay Portal 6.2</li>
  324. <li>Liferay Portal 7.0</li>
  325. </ul>
  326. <p>
  327. Vaadin Framework @version@ supports the following <b>desktop browsers</b>:
  328. </p>
  329. <ul>
  330. <li>Mozilla Firefox 54+</li>
  331. <li>Mozilla Firefox ESR 52+</li>
  332. <li>Internet Explorer 11, Edge (latest version)</li>
  333. <li>Safari 9+</li>
  334. <li>Google Chrome 59+</li>
  335. </ul>
  336. <p>
  337. Additionally, Vaadin Framework supports the built-in browsers in the
  338. following <b>mobile operating systems</b>:
  339. </p>
  340. <ul>
  341. <li>iOS 9+</li>
  342. <li>Android 4+ with Chrome 42+</li>
  343. </ul>
  344. <h2 id="vaadinontheweb">Vaadin on the Web</h2>
  345. <ul>
  346. <li><a href="https://vaadin.com">vaadin.com - The
  347. developer portal containing everything you need to
  348. know about Vaadin</a></li>
  349. <li><a href="https://vaadin.com/framework/demos">vaadin.com/framework/demos
  350. - A collection of demos for Vaadin Framework</a></li>
  351. <li><a href="https://vaadin.com/docs/v8/framework/tutorial.html">vaadin.com/docs/v8/framework/tutorial.html
  352. - Getting started with Vaadin Framework</a></li>
  353. <li><a href="https://vaadin.com/forum">vaadin.com/forum
  354. - Forums for Vaadin Framework related discussions</a></li>
  355. <li><a href="https://vaadin.com/docs/v8/">vaadin.com/docs/v8
  356. - Vaadin Docs - complete reference manual for all Vaadin products</a></li>
  357. <li><a href="https://vaadin.com/api">vaadin.com/api
  358. - Online javadocs</a></li>
  359. <li><a href="https://vaadin.com/directory">vaadin.com/directory
  360. - Add-ons for Vaadin Framework</a></li>
  361. <!--TODO change to something reasonable or remove
  362. <li><a href="http://vaadin.com/pro-tools">vaadin.com/pro-tools
  363. - Commercial tools for Vaadin Framework</a></li>
  364. -->
  365. <li><a href="https://vaadin.com/support">vaadin.com/support
  366. - Commercial support for Vaadin Framework</a></li>
  367. <li><a href="https://vaadin.com/consulting">vaadin.com/consulting
  368. - Expert services for Vaadin Framework users</a></li>
  369. <li><a href="https://vaadin.com/company">vaadin.com/company
  370. - Information about the company behind Vaadin Framework</a></li>
  371. <li><a href="https://vaadin.com/contribute">vaadin.com/contribute - Contribution quide</a></li>
  372. <li><a href="https://github.com/vaadin/framework/issues">github.com/vaadin/framework - Github repository</a></li>
  373. </ul>
  374. </div>
  375. <!-- /content-->
  376. <div id="footer">
  377. <span class="slogan"><strong>vaadin <em>}></em>
  378. </strong> Fight For Simplicity</span> <a href="#top">&uarr; Back
  379. to top</a>
  380. </div>
  381. <!-- /footer -->
  382. </body>
  383. </html>
  384. <!-- Keep this comment at the end of the file
  385. Local variables:
  386. mode: xml
  387. sgml-omittag:nil
  388. sgml-shorttag:nil
  389. sgml-namecase-general:nil
  390. sgml-general-insert-case:lower
  391. sgml-minimize-attributes:nil
  392. sgml-always-quote-attributes:t
  393. sgml-indent-step:2
  394. sgml-indent-data:t
  395. sgml-parent-document:nil
  396. sgml-exposed-tags:nil
  397. sgml-local-catalogs:("/etc/sgml/catalog" "/usr/share/xemacs21/xemacs-packages/etc/psgml-dtds/CATALOG")
  398. sgml-local-ecat-files:("ECAT" "~/sgml/ECAT" "/usr/share/sgml/ECAT" "/usr/local/share/sgml/ECAT" "/usr/local/lib/sgml/ECAT")
  399. End:
  400. -->