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 21KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528
  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. <!--[if lte IE 6]>
  8. <link rel="stylesheet" type="text/css" href="css/ie.css" />
  9. <![endif]-->
  10. <style type="text/css">
  11. .nested-list ol {
  12. counter-reset: item
  13. }
  14. .nested-list li {
  15. display: block
  16. }
  17. .nested-list li:before {
  18. content: counters(item, ".") ". ";
  19. counter-increment: item
  20. }
  21. </style>
  22. </head>
  23. <body>
  24. <div id="header">
  25. <h1>Vaadin &ndash; thinking of U and I</h1>
  26. <div id="version">
  27. <strong>Version @version@</strong>
  28. </div>
  29. </div>
  30. <!-- /header -->
  31. <div id="content">
  32. <p>Version @version@ built on @builddate@.</p>
  33. <h2 id="tableofcontents">Release Notes for Vaadin Framework
  34. @version@</h2>
  35. <ul>
  36. <li><a href="#overview">Overview of Vaadin
  37. @version@ Release</a></li>
  38. <li><a href="#changelog">Change Log for Vaadin
  39. @version@</a></li>
  40. <li><a href="#enhancements">Enhancements in Vaadin
  41. @version-minor@</a></li>
  42. <li><a href="#incompatible">Incompatible or Behavior-altering Changes in
  43. @version-minor@</a></li>
  44. <li><a href="#knownissues">Known Issues and Limitations</a></li>
  45. <li><a href="#vaadin">Vaadin Installation</a></li>
  46. <li><a href="#package">Package Contents</a></li>
  47. <li><a href="#migrating">Migrating from Vaadin 6</a></li>
  48. <li><a href="#dependencies">Vaadin @version@
  49. dependencies</a></li>
  50. <li><a href="#upgrading">Upgrading to Vaadin
  51. @version-minor@</a></li>
  52. <li><a href="#supportedversions">Supported
  53. Technologies</a></li>
  54. <li><a href="#vaadinontheweb">Vaadin on the Web</a></li>
  55. </ul>
  56. <h2 id="overview">Overview of Vaadin @version@ Release</h2>
  57. <p>
  58. Vaadin @version@ is a
  59. <!-- feature release that includes -->
  60. pre-release for evaluating
  61. a number of new features and bug fixes, as listed in the <a
  62. href="#enhancements">list of enhancements</a> and <a
  63. href="#changelog">change log</a> below.
  64. </p>
  65. <!-- ================================================================ -->
  66. <h3 id="changelog">Change Log for Vaadin @version@</h3>
  67. <p>This release includes the following closed issues:</p>
  68. <table>
  69. @release-notes-tickets@
  70. <tr><td>&nbsp;</td><td></td></tr>
  71. <tr><td class="fv"><span class="vote">Vote</span></td><td colspan="2" class="pad">Enhancements <a href=" https://vaadin.com/support">Vaadin support</a> users have voted for</td></tr>
  72. <tr><td class="bfp"><span class="bfp">Priority</span></td><td colspan="2" class="pad">Defects <a href=" https://vaadin.com/support">Vaadin support</a> users have prioritized</td></tr>
  73. </table>
  74. <br/>
  75. <p>
  76. You can also view the <a
  77. href="http://dev.vaadin.com/query?status=pending-release&status=released&resolution=fixed&milestone=Vaadin+@version@&order=id">list
  78. of the closed issues</a> at the Vaadin developer's site.
  79. </p>
  80. <h2 id="enhancements">Enhancements in Vaadin @version-minor@</h2>
  81. <p>Vaadin @version-minor@ includes many major and minor
  82. enhancements. Below is a list of the most notable changes:</p>
  83. <ul>
  84. <li>New configurable client-server reconnect handling and warning dialogs</li>
  85. <li>Grid line-based editing and unbuffered datasource binding</li>
  86. <li>More fluent Grid scrolling for touch devices</li>
  87. <li>Configurable keyboard, touch and mouse navigation support for Grid editor</li>
  88. <li>Declarative HTML serialization enhancements for Vaadin Designer 1.0</li>
  89. <li>Better handling of closing a window with keyboard shortcuts</li>
  90. <li>Column collapsing events for Table</li>
  91. </ul>
  92. <p>
  93. For enhancements introduced in Vaadin 7.5, see the <a
  94. href="http://vaadin.com/download/release/7.5/7.5.0/release-notes.html">Release
  95. Notes for Vaadin 7.5.0</a>.
  96. </p>
  97. <h3 id="incompatible">Incompatible or Behavior-altering Changes in @version-minor@</h3>
  98. <ul>
  99. <li>Window.setCloseShortcut() is now deprecated. ESCAPE is no longer a hard-coded default, but rather a soft one, and
  100. can be removed. If the close-shortcut attribute of the v-windowelement is present, it must list all close
  101. shortcuts, including ESCAPE, separated by whitespace. Existing, unchanged code should behave as before.
  102. See ticket <a href="https://dev.vaadin.com/ticket/17383">#17383</a> for more information on the reasoning
  103. behind the change.</li>
  104. <li>Grid SelectionModels are now Extensions. This update removes all selection related variables and API from
  105. GridConnector, GridState, GridServerRpc and GridClientRpc</li>
  106. <li>StringToEnumConverter now explicitly supports Enum types with custom toString() implementations.
  107. This may affect applications that relied on the undefined behavior in previous versions.</li>
  108. </ul>
  109. <h3 id="knownissues">Known Issues and Limitations</h3>
  110. <ul>
  111. <li>Vaadin TouchKit versions prior to 4.1.0 do not work with 7.6. Please use version 4.1.0 or above.</li>
  112. <li>Drag'n'drop in a Table doesn't work on touch devices running
  113. Internet Explorer (Windows Phone, Surface)
  114. (<a href="http://dev.vaadin.com/ticket/13737">#13737</a>)
  115. </li>
  116. <li><p>It is currently not possible to specify <tt>font-size</tt>
  117. as <tt>em</tt> or <tt>%</tt>, or layout component sizes
  118. with <tt>em</tt> (<a
  119. href="http://dev.vaadin.com/ticket/10634">#10634</a>).</p><p>This
  120. does not apply to Valo, but using em sizes to size layouts is discouraged,
  121. because it results in fractional component sizes in many cases, which
  122. might cause unwanted 1px gaps between components.</p>
  123. </li>
  124. <li>Up-to-date information about configuration needed for push and compatibility issues are available in
  125. <a href="https://vaadin.com/wiki/-/wiki/Main/Configuring+push+for+your+environment">this wiki page.</a>
  126. <br />
  127. The most prominent limitations are:
  128. <ul>
  129. <li>Push is currently not supported in portals (See <a
  130. href="http://dev.vaadin.com/ticket/11493">#11493</a>)
  131. </li>
  132. <li>>Transport mode WEBSOCKET does not support invalidating the session on Tomcat 7,
  133. nor setting cookies for the session. The new transport mode WEBSOCKET_XHR can be
  134. used to bypass these limitations.
  135. <br />
  136. See tickets <a href="https://dev.vaadin.com/ticket/11808">#11808</a> and
  137. <a href="https://dev.vaadin.com/ticket/11721">#11721</a>
  138. </li>
  139. </ul>
  140. </li>
  141. <li>Google App Engine has some limitations. Please consult Vaadin Wiki:
  142. <a href="https://vaadin.com/wiki/-/wiki/Main/Vaadin+support+for+Google+App+Engine">Vaadin support for Google App Engine</a>
  143. </li>
  144. <li>Grid does not support adding components to cells. Instead light-weight Renderers can be
  145. used to present and edit data.</li>
  146. </ul>
  147. <h2 id="vaadin">Vaadin Installation</h2>
  148. <p>
  149. <b>Vaadin</b> is a Java framework for building modern web
  150. applications that look great, perform well and make you and
  151. your users happy. <b>Vaadin</b> is available under the
  152. Apache License, Version 2.0 (see the
  153. <tt>license.html</tt>
  154. in the Vaadin ZIP or JAR package).
  155. </p>
  156. <p>
  157. The easiest ways to install <b>Vaadin</b> are:
  158. </p>
  159. <ul>
  160. <li><strong>Maven dependecy.</strong>If using Maven, define it as a dependency or use
  161. any of the available archetypes to create a new project. More information at
  162. <a href="https://vaadin.com/maven">https://vaadin.com/maven</a>
  163. </li>
  164. <li><strong>IDE Plugins.</strong>If using Eclipse, use the
  165. <a href="http://vaadin.com/eclipse">Vaadin Plugin for Eclipse</a>, which automatically
  166. downloads the Vaadin libraries. For NetBeans 8.0 and 7.4, use the
  167. <a href="http://plugins.netbeans.org/plugin/50531/vaadin-plug-in-for-netbeans">official Vaadin plugin</a>
  168. that provides Maven based wizards and code completion support for Vaadin development.
  169. </li>
  170. </ul>
  171. <p>
  172. Vaadin Framework is also available as a ZIP package downloadable from <a
  173. href="http://vaadin.com/download">Vaadin Download
  174. page</a>.
  175. </p>
  176. <h3 id="package">Package Contents</h3>
  177. <p>Inside the ZIP installation package you will find:</p>
  178. <ul>
  179. <li>Separate server-side (<tt>vaadin-server</tt>) and
  180. client-side (<tt>vaadin-client</tt>, <tt>vaadin-client-compiler</tt>)
  181. development libraries
  182. </li>
  183. <li>Precompiled widget set (<tt>vaadin-client-compiled</tt>)
  184. for server-side development
  185. </li>
  186. <li>Shared library (<tt>vaadin-shared</tt>) for both
  187. server- and client-side libraries
  188. </li>
  189. <li>Built-in themes (<tt>vaadin-themes</tt>)
  190. </li>
  191. <li>Dependency libraries provided under the <tt>lib/</tt>
  192. folder
  193. </li>
  194. </ul>
  195. <p>
  196. See the
  197. <tt>README.TXT</tt>
  198. in the installation package for detailed information about
  199. the package contents. <a href="http://vaadin.com/book">Book
  200. of Vaadin</a> (for Vaadin 7) gives more detailed
  201. instructions.
  202. </p>
  203. <p>
  204. For server-side development, copy the
  205. <tt>vaadin-server</tt>
  206. ,
  207. <tt>vaadin-client-compiled</tt>
  208. ,
  209. <tt>vaadin-shared</tt>
  210. , and
  211. <tt>vaadin-themes</tt>
  212. from the main folder and the dependencies from the
  213. <tt>lib</tt>
  214. folder to the
  215. <tt>WEB-INF/lib</tt>
  216. folder of your Vaadin project. (The
  217. <tt>vaadin-client-compiled</tt>
  218. is necessary if you do not wish to compile the widget set by
  219. your own, which you need to do if you use almost any add-on
  220. components.)
  221. </p>
  222. <h4 id="package.updates">Updates to the Packaging</h4>
  223. <p>
  224. Since Vaadin 7.2.0, the old vaadin-theme-compiler has been moved into
  225. a separate project and renamed to vaadin-sass-compiler. It is now included
  226. along with the other 3rd party dependencies in the ZIP package.
  227. </p>
  228. <p>
  229. For pure client-side development, you only need the
  230. <tt>vaadin-client</tt>
  231. and
  232. <tt>vaadin-client-compiler</tt>
  233. JARs, which should be put to a non-deployed project library
  234. folder, such as
  235. <tt>lib</tt>
  236. . You also need them if you compile the widget set for any
  237. reason, such as using Vaadin add-ons, or create new
  238. server-side components integrated with client-side widgets.
  239. </p>
  240. <h2 id="migrating">Migrating from Vaadin 6</h2>
  241. <p>
  242. All Vaadin 6 applications need some changes when migrating
  243. to Vaadin 7. The most obvious changes are in the
  244. application/window API and require extending either <b>UI</b>
  245. or <b>UI.LegacyApplication</b> instead of <b>Application</b>.
  246. A detailed list of migration changes are given in the <a
  247. href="https://vaadin.com/wiki/-/wiki/Main/Migrating+from+Vaadin+6+to+Vaadin+7">Vaadin
  248. 7 Migration Guide</a>.
  249. </p>
  250. <p>Any custom client-side widgets need to be ported to use
  251. the new client-server communication API, or the Vaadin 6
  252. compatibility API.</p>
  253. <p>
  254. Vaadin 6 add-ons (ones that contain widgets) do not work in
  255. Vaadin 7 - please check the add-ons in <a
  256. href="http://vaadin.com/directory/">Vaadin Directory</a>
  257. for Vaadin 7 support.
  258. </p>
  259. <h2 id="dependencies">Vaadin @version@ Dependencies</h2>
  260. <p>When using Maven, Ivy, Gradle, or other dependency
  261. management system, all Vaadin dependencies are downloaded
  262. automatically. This is also the case when using the Vaadin
  263. Plugin for Eclipse.</p>
  264. <p>
  265. The Vaadin ZIP installation package includes the
  266. dependencies in the
  267. <tt>lib</tt>
  268. subfolder. These need to be copied to the
  269. <tt>WEB-INF/lib</tt>
  270. folder of the web application that uses Vaadin.
  271. </p>
  272. <p>
  273. The dependencies are listed in the <a href="license.html">Licensing
  274. description</a>. Some are explicit dependencies packaged and
  275. distributed as separate JARs, while some are included inside
  276. other libraries.
  277. </p>
  278. <h3>Bean Validation</h3>
  279. <p>
  280. If you use the bean validation feature in Vaadin 7, you need
  281. a Bean Validation API implementation. You need to install
  282. the implementation JAR in the
  283. <tt>WEB-INF/lib</tt>
  284. directory of the web application that uses validation.
  285. </p>
  286. <h2 id="upgrading">Upgrading to Vaadin @version-minor@</h2>
  287. <p>When upgrading from an earlier Vaadin version, you must:
  288. </p>
  289. <ul>
  290. <li>Recompile your classes using the new Vaadin
  291. version. Binary compatibility is only guaranteed for
  292. maintenance releases of Vaadin.</li>
  293. <li>Unless using the precompiled widget set, recompile
  294. your widget set using the new Vaadin version.</li>
  295. </ul>
  296. <p>Remember also to refresh the project in your IDE to
  297. ensure that the new version of everything is in use.</p>
  298. <p>
  299. By using the "
  300. <tt>?debug</tt>
  301. " URL parameter, you can verify that the version of the
  302. servlet, the theme, and the widget set all match.
  303. </p>
  304. <p>
  305. <b>Eclipse</b> users should always check if there is a new
  306. version of the Eclipse Plug-in available. The Eclipse
  307. Plug-in can be used to update the Vaadin version in the
  308. project (Project properties &raquo; Vaadin).
  309. </p>
  310. <p>
  311. <b>Maven</b> users should update the Vaadin dependency
  312. version in the
  313. <tt>pom.xml</tt>
  314. unless it is defined as
  315. <tt>LATEST</tt>
  316. . You must also ensure that the GWT dependency uses the
  317. correct version and recompile your project and your widget
  318. set.
  319. </p>
  320. <p>
  321. <b>Liferay and other portal</b> users must install the
  322. Vaadin libraries in
  323. <t>ROOT/WEB-INF/lib/</b> in the portal (and remove a
  324. possibly obsolete older <tt>vaadin.jar</tt>). Additionally,
  325. the contents of the <tt>vaadin-client-compiled</tt> and <tt>vaadin-themes</tt>
  326. must be extracted to the <tt>ROOT/html/VAADIN</tt> directory
  327. in the Liferay installation. If your portal uses custom
  328. widgets, you can use <a
  329. href="http://vaadin.com/directory#addon/liferay-control-panel-plugin-for-vaadin:vaadin">
  330. Liferay Control Panel for Vaadin</a> for easy widget set compilation.</t>
  331. </p>
  332. <h2 id="supportedversions">Supported Technologies</h2>
  333. <p>
  334. Vaadin 7 is compatible with <b>Java 6</b> and newer. Vaadin
  335. 7 is especially supported on the following <b>operating
  336. systems</b>:
  337. </p>
  338. <ul>
  339. <li>Windows</li>
  340. <li>Linux</li>
  341. <li>Mac OS X</li>
  342. </ul>
  343. <p>
  344. Vaadin 7 requires <b>Java Servlet API 2.4</b> but also
  345. supports later versions and should work with any Java
  346. application server that conforms to the standard. The
  347. following <b>application servers</b> are supported:
  348. </p>
  349. <ul>
  350. <li>Apache Tomcat 5-8</li>
  351. <li>Apache TomEE 1</li>
  352. <li>Oracle WebLogic Server 10.3-12</li>
  353. <li>IBM WebSphere Application Server 7-8</li>
  354. <li>JBoss Application Server 4-7</li>
  355. <li>Wildfly 8-9</li>
  356. <li>Jetty 5-9</li>
  357. <li>Glassfish 2-4</li>
  358. </ul>
  359. <p>
  360. Vaadin 7 supports the JSR-286 Portlet specification and all
  361. portals that implement the specification should work. The
  362. following <b>portals</b> are supported:
  363. </p>
  364. <ul>
  365. <li>Liferay Portal 5.2-6</li>
  366. <li>GateIn Portal 3</li>
  367. <li>eXo Platform 3</li>
  368. <li>IBM WebSphere Portal 8</li>
  369. </ul>
  370. <p>
  371. Vaadin also supports <b>Google App Engine</b>.
  372. </p>
  373. <p>
  374. Vaadin @version@ supports the following <b>desktop browsers</b>:
  375. </p>
  376. <ul>
  377. <li>Mozilla Firefox 18-40</li>
  378. <li>Mozilla Firefox 17 ESR, 24 ESR, 31 ESR, 38 ESR</li>
  379. <li>Internet Explorer 8-11, Edge</li>
  380. <li>Safari 6-8</li>
  381. <li>Opera 16-31</li>
  382. <li>Google Chrome 23-45</li>
  383. </ul>
  384. <p>
  385. Additionally, Vaadin supports the built-in browsers in the
  386. following <b>mobile operating systems</b>:
  387. </p>
  388. <ul>
  389. <li>iOS 5-8</li>
  390. <li>Android 2.3-5</li>
  391. <li>Windows Phone 8</li>
  392. </ul>
  393. <p>Vaadin SQL Container supports the following databases:</p>
  394. <ul>
  395. <li>HSQLDB</li>
  396. <li>MySQL</li>
  397. <li>MSSQL</li>
  398. <li>Oracle</li>
  399. <li>PostgreSQL</li>
  400. </ul>
  401. <h2 id="vaadinontheweb">Vaadin on the Web</h2>
  402. <ul>
  403. <li><a href="http://vaadin.com">vaadin.com - The
  404. developer portal containing everything you need to
  405. know about Vaadin</a></li>
  406. <li><a href="http://vaadin.com/demo">vaadin.com/demo
  407. - A collection of demos for Vaadin</a></li>
  408. <li><a href="http://vaadin.com/learn">vaadin.com/learn
  409. - Getting started with Vaadin</a></li>
  410. <li><a href="http://vaadin.com/forum">vaadin.com/forum
  411. - Forums for Vaadin related discussions</a></li>
  412. <li><a href="http://vaadin.com/book">vaadin.com/book
  413. - Book of Vaadin - everything you need to know about
  414. Vaadin</a></li>
  415. <li><a href="http://vaadin.com/api">vaadin.com/api
  416. - Online javadocs</a></li>
  417. <li><a href="http://vaadin.com/directory">vaadin.com/directory
  418. - Add-ons for Vaadin</a></li>
  419. <li><a href="http://vaadin.com/pro-tools">vaadin.com/pro-tools
  420. - Commercial tools for Vaadin development</a></li>
  421. <li><a href="http://vaadin.com/support">vaadin.com/support
  422. - Commercial support for Vaadin development </a></li>
  423. <li><a href="http://vaadin.com/services">vaadin.com/services
  424. - Expert services for Vaadin</a></li>
  425. <li><a href="http://vaadin.com/company">vaadin.com/company
  426. - Information about the company behind Vaadin</a></li>
  427. <li><a href="http://dev.vaadin.com">dev.vaadin.com
  428. - Bug tracker</a></li>
  429. <li><a
  430. href="http://dev.vaadin.com/wiki/Vaadin/Development/StartingVaadin7Development">How
  431. to get the source code of Vaadin</a></li>
  432. </ul>
  433. </div>
  434. <!-- /content-->
  435. <div id="footer">
  436. <span class="slogan"><strong>vaadin <em>}></em>
  437. </strong> thinking of U and I<span> <a href="#top">&uarr; Back
  438. to top</a>
  439. </div>
  440. <!-- /footer -->
  441. </body>
  442. </html>
  443. <!-- Keep this comment at the end of the file
  444. Local variables:
  445. mode: xml
  446. sgml-omittag:nil
  447. sgml-shorttag:nil
  448. sgml-namecase-general:nil
  449. sgml-general-insert-case:lower
  450. sgml-minimize-attributes:nil
  451. sgml-always-quote-attributes:t
  452. sgml-indent-step:2
  453. sgml-indent-data:t
  454. sgml-parent-document:nil
  455. sgml-exposed-tags:nil
  456. sgml-local-catalogs:("/etc/sgml/catalog" "/usr/share/xemacs21/xemacs-packages/etc/psgml-dtds/CATALOG")
  457. sgml-local-ecat-files:("ECAT" "~/sgml/ECAT" "/usr/share/sgml/ECAT" "/usr/local/share/sgml/ECAT" "/usr/local/lib/sgml/ECAT")
  458. End:
  459. -->