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.

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596
  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 in
  45. @version-minor@</a></li>
  46. <li><a href="#limitations">Limitations in
  47. @version-minor@</a></li>
  48. <li><a href="#vaadin">Vaadin Installation</a></li>
  49. <li><a href="#package">Package Contents</a></li>
  50. <li><a href="#migrating">Migrating from Vaadin 6 to
  51. Vaadin 7</a></li>
  52. <li><a href="#dependencies">Vaadin @version@
  53. dependencies</a></li>
  54. <li><a href="#upgrading">Upgrading to Vaadin
  55. @version-minor@</a></li>
  56. <li><a href="#supportedversions">Supported
  57. technologies</a></li>
  58. <li><a href="#vaadinontheweb">Vaadin on the Web</a></li>
  59. </ul>
  60. <h2 id="overview">Overview of Vaadin @version@ Release</h2>
  61. <p>
  62. Vaadin @version@ is a minor release that includes a
  63. number of new features and bug fixes, as listed in the <a
  64. href="#enhancements">list of enhancements</a> and <a
  65. href="#changelog">change log</a> below.
  66. </p>
  67. <!-- ================================================================ -->
  68. <h3 id="changelog">Change log for Vaadin @version@</h3>
  69. <p>This release includes the following closed issues:</p>
  70. <table>
  71. @release-notes-tickets@
  72. <tr><td>&nbsp;</td><td></td></tr>
  73. <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>
  74. <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>
  75. </table>
  76. <br/>
  77. <p>
  78. You can also view the <a
  79. href="http://dev.vaadin.com/query?status=closed&resolution=fixed&milestone=Vaadin+@version@&order=id">list
  80. of the closed issues</a> at the Vaadin developer's site.
  81. </p>
  82. <h2 id="enhancements">Enhancements in Vaadin @version-minor@</h2>
  83. <p>The @version-minor@ includes many major and minor
  84. enhancements. Below is a list of the most notable changes:</p>
  85. <ul>
  86. <li>Valo is a brand new built-in theme for Vaadin. It leverages
  87. the Sass CSS preprocessor heavily,
  88. providing a variety of ways to customize the look and feel of your theme.
  89. See <a href="https://vaadin.com/wiki/-/wiki/Main/Valo+theme+-+Getting+started">the Valo theme tutorial</a> or <a href="https://vaadin.com/book/-/page/themes.valo.html">the Valo theme section</a> in Book of Vaadin for information on how to get started.</li>
  90. </ul>
  91. <p>
  92. For enhancements introduced in Vaadin 7.2, see the <a
  93. href="http://vaadin.com/download/release/7.2/7.2.0/release-notes.html">Release
  94. Notes for Vaadin 7.2.0</a>.
  95. </p>
  96. <h3 id="incompatible">Incompatible or behavior-altering changes in @version-minor@</h3>
  97. <ul>
  98. <li>
  99. <p>The shadow of all overlays (VOverlay) are now implemented with CSS box-shadow in all browsers except Internet Explorer 8 (<a href="http://dev.vaadin.com/ticket/9303">#9303</a>).
  100. In IE8 the old image-based implementation is still used.
  101. </p><p>
  102. The image-based shadow implementation is also deprecated, so if you have any custom shadow implementations in your themes or add-ons,
  103. please update them accordingly to use CSS box-shadow instead.
  104. </p><p>
  105. Note that the CSS-based implementation is visually not 100% identical to the old implementation. This should not cause issues except
  106. if you are using screenshot-based TestBench tests or similar visual regression tests.
  107. </p>
  108. </li>
  109. <li>The theme for the debug window is now implemented using a GWT client bundle and is no longer included in the standard theme.</li>
  110. <li>Reverted to use JSON.org implementation of the JSON library instead of the Android implementation that was used in Vaadin 7.2.
  111. See <a href="licenses/the-json-license.txt">the-json-license.txt</a> for information about its license.</li>
  112. </ul>
  113. <h3 id="knownissues">Known issues</h3>
  114. <ul>
  115. <li>Drag'n'drop in a Table doesn't work on touch devices running
  116. Internet Explorer (Windows Phone, Surface)
  117. (<a href="http://dev.vaadin.com/ticket/13737">#13737</a>)
  118. </li>
  119. </ul>
  120. <h3 id="limitations">Limitations</h3>
  121. <ul>
  122. <li><p>It is currently not possible to specify <tt>font-size</tt>
  123. as <tt>em</tt> or <tt>%</tt>, or layout component sizes
  124. with <tt>em</tt> (<a
  125. href="http://dev.vaadin.com/ticket/10634">#10634</a>).</p><p>This
  126. does not apply to Valo, but using em sizes to size layouts is discouraged,
  127. because it results in fractional component sizes in many cases, which
  128. might cause unwanted 1px gaps between components.</p>
  129. </li>
  130. <li>Push is currently not supported in portals (See <a
  131. href="http://dev.vaadin.com/ticket/11493">#11493</a>)
  132. </li>
  133. <li>HTTP session can not be invalidated while using
  134. push over websockets on Tomcat 7 (<a href="http://dev.vaadin.com/ticket/11721">#11721</a>)
  135. </li>
  136. <li>Cookies are not available while using websockets (<a
  137. href="http://dev.vaadin.com/ticket/11808">#11808</a>)
  138. </li>
  139. <li>Not all proxies are compatible with websockets or streaming.
  140. Use long polling to avoid these problems.</li>
  141. </ul>
  142. <h2 id="vaadin">Vaadin Installation</h2>
  143. <p>
  144. <b>Vaadin</b> is a Java framework for building modern web
  145. applications that look great, perform well and make you and
  146. your users happy. <b>Vaadin</b> is available under the
  147. Apache License, Version 2.0 (see the
  148. <tt>license.html</tt>
  149. in the Vaadin ZIP or JAR package).
  150. </p>
  151. <p>
  152. The easiest ways to install <b>Vaadin</b> are:
  153. </p>
  154. <ul>
  155. <li>If using Maven, define it as a dependency or use
  156. any of the available archetypes (only <tt>vaadin-application</tt>
  157. is available for Vaadin 7 at the time of this release)
  158. to create a new project
  159. </li>
  160. <li>If using Eclipse, use the Vaadin Plugin for
  161. Eclipse, which automatically downloads the Vaadin
  162. libraries.
  163. </li>
  164. </ul>
  165. <p>
  166. It is also available as a ZIP package downloadable from <a
  167. href="http://vaadin.com/download">Vaadin Download
  168. page</a>.
  169. </p>
  170. <h3 id="package">Package Contents</h3>
  171. <p>Inside the ZIP installation package you will find:</p>
  172. <ul>
  173. <li>Separate server-side (<tt>vaadin-server</tt>) and
  174. client-side (<tt>vaadin-client</tt>, <tt>vaadin-client-compiler</tt>)
  175. development libraries
  176. </li>
  177. <li>Precompiled widget set (<tt>vaadin-client-compiled</tt>)
  178. for server-side development
  179. </li>
  180. <li>Shared library (<tt>vaadin-shared</tt>) for both
  181. server- and client-side libraries
  182. </li>
  183. <li>Built-in themes (<tt>vaadin-themes</tt>)
  184. </li>
  185. <li>Dependency libraries provided under the <tt>lib/</tt>
  186. folder
  187. </li>
  188. </ul>
  189. <p>
  190. See the
  191. <tt>README.TXT</tt>
  192. in the installation package for detailed information about
  193. the package contents. <a href="http://vaadin.com/book">Book
  194. of Vaadin</a> (for Vaadin 7) gives more detailed
  195. instructions.
  196. </p>
  197. <p>
  198. For server-side development, copy the
  199. <tt>vaadin-server</tt>
  200. ,
  201. <tt>vaadin-client-compiled</tt>
  202. ,
  203. <tt>vaadin-shared</tt>
  204. , and
  205. <tt>vaadin-themes</tt>
  206. from the main folder and the dependencies from the
  207. <tt>lib</tt>
  208. folder to the
  209. <tt>WEB-INF/lib</tt>
  210. folder of your Vaadin project. (The
  211. <tt>vaadin-client-compiled</tt>
  212. is necessary if you do not wish to compile the widget set by
  213. your own, which you need to do if you use almost any add-on
  214. components.)
  215. </p>
  216. <h4 id="package.updates">Updates to the Packaging</h4>
  217. <p>
  218. Since Vaadin 7.2.0, the old vaadin-theme-compiler has been moved into
  219. a separate project and renamed to vaadin-sass-compiler. It is now included
  220. along with the other 3rd party dependencies in the ZIP package.
  221. </p>
  222. <p>
  223. For pure client-side development, you only need the
  224. <tt>vaadin-client</tt>
  225. and
  226. <tt>vaadin-client-compiler</tt>
  227. JARs, which should be put to a non-deployed project library
  228. folder, such as
  229. <tt>lib</tt>
  230. . You also need them if you compile the widget set for any
  231. reason, such as using Vaadin add-ons, or create new
  232. server-side components integrated with client-side widgets.
  233. </p>
  234. <h2 id="migrating">Migrating from Vaadin 6</h2>
  235. <p>
  236. All Vaadin 6 applications need some changes when migrating
  237. to Vaadin 7. The most obvious changes are in the
  238. application/window API and require extending either <b>UI</b>
  239. or <b>UI.LegacyApplication</b> instead of <b>Application</b>.
  240. A detailed list of migration changes are given in the <a
  241. href="https://vaadin.com/wiki/-/wiki/Main/Migrating+from+Vaadin+6+to+Vaadin+7">Vaadin
  242. 7 Migration Guide</a>.
  243. </p>
  244. <p>Any custom client-side widgets need to be ported to use
  245. the new client-server communication API, or the Vaadin 6
  246. compatibility API.</p>
  247. <p>
  248. Vaadin 6 add-ons (ones that contain widgets) do not work in
  249. Vaadin 7 - please check the add-ons in <a
  250. href="http://vaadin.com/directory/">Vaadin Directory</a>
  251. for Vaadin 7 support.
  252. </p>
  253. <h2 id="dependencies">Vaadin @version@ Dependencies</h2>
  254. <p>When using Maven, Ivy, Gradle, or other dependency
  255. management system, all Vaadin dependencies are downloaded
  256. automatically. This is also the case when using the Vaadin
  257. Plugin for Eclipse.</p>
  258. <p>
  259. The Vaadin ZIP installation package includes the
  260. dependencies in the
  261. <tt>lib</tt>
  262. subfolder. These need to be copied to the
  263. <tt>WEB-INF/lib</tt>
  264. folder of the web application that uses Vaadin.
  265. </p>
  266. <p>
  267. The dependencies are listed in the <a href="license.html">Licensing
  268. description</a>. Some are explicit dependencies packaged and
  269. distributed as separate JARs, while some are included inside
  270. other libraries.
  271. </p>
  272. <h3>Bean Validation</h3>
  273. <p>
  274. If you use the bean validation feature in Vaadin 7, you need
  275. a Bean Validation API implementation. You need to install
  276. the implementation JAR in the
  277. <tt>WEB-INF/lib</tt>
  278. directory of the web application that uses validation.
  279. </p>
  280. <h2 id="upgrading">Upgrading from Vaadin 7.1 to Vaadin @version-minor@</h2>
  281. <p>When upgrading from an earlier Vaadin version, you must:
  282. </p>
  283. <ul>
  284. <li>Recompile your classes using the new Vaadin
  285. version. Binary compatibility is only guaranteed for
  286. maintenance releases of Vaadin.</li>
  287. <li>Unless using the precompiled widget set, recompile
  288. your widget set using the new Vaadin version.</li>
  289. </ul>
  290. <p>Remember also to refresh the project in your IDE to
  291. ensure that the new version of everything is in use.</p>
  292. <p>
  293. By using the "
  294. <tt>?debug</tt>
  295. " URL parameter, you can verify that the version of the
  296. servlet, the theme, and the widget set all match.
  297. </p>
  298. <p>
  299. <b>Eclipse</b> users should always check if there is a new
  300. version of the Eclipse Plug-in available. The Eclipse
  301. Plug-in can be used to update the Vaadin version in the
  302. project (Project properties &raquo; Vaadin).
  303. </p>
  304. <p>
  305. <b>Maven</b> users should update the Vaadin dependency
  306. version in the
  307. <tt>pom.xml</tt>
  308. unless it is defined as
  309. <tt>LATEST</tt>
  310. . You must also ensure that the GWT dependency uses the
  311. correct version and recompile your project and your widget
  312. set.
  313. </p>
  314. <p>
  315. <b>Liferay and other portal</b> users must install the
  316. Vaadin libraries in
  317. <t>ROOT/WEB-INF/lib/</b> in the portal (and remove a
  318. possibly obsolete older <tt>vaadin.jar</tt>). Additionally,
  319. the contents of the <tt>vaadin-client-compiled</tt> and <tt>vaadin-themes</tt>
  320. must be extracted to the <tt>ROOT/html/VAADIN</tt> directory
  321. in the Liferay installation. If your portal uses custom
  322. widgets, you can use <a
  323. href="http://vaadin.com/directory#addon/liferay-control-panel-plugin-for-vaadin:vaadin">
  324. Liferay Control Panel for Vaadin</a> for easy widget set compilation.</t>
  325. </p>
  326. <h2 id="gae">
  327. Notes and Limitations for Google App Engine
  328. </h4>
  329. </h2>
  330. <p>The following instructions and limitations apply when you
  331. run a Vaadin application under the Google App Engine.</p>
  332. <ul>
  333. <li>
  334. <p>
  335. Applications must use <b>GAEVaadinServlet</b>
  336. instead of <b>VaadinServlet</b> in
  337. <tt>web.xml</tt>
  338. .
  339. </p>
  340. </li>
  341. <li>
  342. <p>
  343. Session support must be enabled in
  344. <tt>appengine-web.xml</tt>
  345. :
  346. </p> <pre> &lt;sessions-enabled&gt;true&lt;/sessions-enabled&gt;</pre>
  347. </li>
  348. <li>
  349. <p>Avoid using the session for storage, usual App
  350. Engine limitations apply (no synchronization, that
  351. is, unreliable).</p>
  352. </li>
  353. <li>
  354. <p>
  355. Vaadin uses memcache for mutex, the key is of the
  356. form
  357. <tt>_vmutex&lt;sessionid&gt;</tt>
  358. .
  359. </p>
  360. </li>
  361. <li>
  362. <p>
  363. The Vaadin <b>VaadinSession</b> class is serialized
  364. separately into memcache and datastore; the memcache
  365. key is
  366. <tt>_vac&lt;sessionid&gt;</tt>
  367. and the datastore entity kind is
  368. <tt>_vac</tt>
  369. with identifiers of the type
  370. <tt>_vac&lt;sessionid&gt;</tt>
  371. .
  372. </p>
  373. </li>
  374. <li>
  375. <p>
  376. DO NOT update application state when serving an <b>ConnectorResource</b>
  377. (such as <b>ClassResource</b>.<i>getStream()</i>).
  378. </p>
  379. </li>
  380. <li>
  381. <p>The application remains locked during uploads - a
  382. progress bar is not possible</p>
  383. </li>
  384. </ul>
  385. <p>
  386. For other known problems, see open tickets at developer site
  387. <a href="http://dev.vaadin.com/">dev.vaadin.com</a>.
  388. </p>
  389. <h2 id="supportedversions">Supported Technologies</h2>
  390. <p>
  391. Vaadin 7 is compatible with <b>Java 6</b> and newer. Vaadin
  392. 7 is especially supported on the following <b>operating
  393. systems</b>:
  394. </p>
  395. <ul>
  396. <li>Windows</li>
  397. <li>Linux</li>
  398. <li>Mac OS X</li>
  399. </ul>
  400. <p>
  401. Vaadin 7 requires <b>Java Servlet API 2.4</b> but also
  402. supports later versions and should work with any Java
  403. application server that conforms to the standard. The
  404. following <b>application servers</b> are supported:
  405. </p>
  406. <ul>
  407. <li>Apache Tomcat 5-8</li>
  408. <li>Apache TomEE 1</li>
  409. <li>Oracle WebLogic Server 10.3-12</li>
  410. <li>IBM WebSphere Application Server 7-8</li>
  411. <li>JBoss Application Server 4-7</li>
  412. <li>Wildfly 8</li>
  413. <li>Jetty 5-9</li>
  414. <li>Glassfish 2-4</li>
  415. </ul>
  416. <p>
  417. Vaadin 7 supports the JSR-286 Portlet specification and all
  418. portals that implement the specification should work. The
  419. following <b>portals</b> are supported:
  420. </p>
  421. <ul>
  422. <li>Liferay Portal 5.2-6</li>
  423. <li>GateIn Portal 3</li>
  424. <li>eXo Platform 3</li>
  425. <li>IBM WebSphere Portal 8</li>
  426. </ul>
  427. <p>
  428. Vaadin also supports <b>Google App Engine</b>.
  429. </p>
  430. <p>
  431. Vaadin @version@ supports the following <b>desktop browsers</b>:
  432. </p>
  433. <ul>
  434. <li>Mozilla Firefox 18-29</li>
  435. <li>Mozilla Firefox 17 ESR, 24 ESR</li>
  436. <li>Internet Explorer 8-11</li>
  437. <li>Safari 6-7</li>
  438. <li>Opera 12, 16-20</li>
  439. <li>Google Chrome 23-34</li>
  440. </ul>
  441. <p>
  442. Additionally, Vaadin supports the built-in browsers in the
  443. following <b>mobile operating systems</b>:
  444. </p>
  445. <ul>
  446. <li>iOS 5-7</li>
  447. <li>Android 2.3-4</li>
  448. <li>Windows Phone 8</li>
  449. </ul>
  450. <p>Vaadin SQL Container supports the following databases:</p>
  451. <ul>
  452. <li>HSQLDB</li>
  453. <li>MySQL</li>
  454. <li>MSSQL</li>
  455. <li>Oracle</li>
  456. <li>PostgreSQL</li>
  457. </ul>
  458. <h2 id="vaadinontheweb">Vaadin on the Web</h2>
  459. <ul>
  460. <li><a href="http://vaadin.com">vaadin.com - The
  461. developer portal containing everything you need to
  462. know about Vaadin</a></li>
  463. <li><a href="http://vaadin.com/demo">vaadin.com/demo
  464. - A collection of demos for Vaadin</a></li>
  465. <li><a href="http://vaadin.com/learn">vaadin.com/learn
  466. - Getting started with Vaadin</a></li>
  467. <li><a href="http://vaadin.com/forum">vaadin.com/forum
  468. - Forums for Vaadin related discussions</a></li>
  469. <li><a href="http://vaadin.com/book">vaadin.com/book
  470. - Book of Vaadin - everything you need to know about
  471. Vaadin</a></li>
  472. <li><a href="http://vaadin.com/api">vaadin.com/api
  473. - Online javadocs</a></li>
  474. <li><a href="http://vaadin.com/directory">vaadin.com/directory
  475. - Add-ons for Vaadin</a></li>
  476. <li><a href="http://vaadin.com/pro-tools">vaadin.com/pro-tools
  477. - Commercial tools for Vaadin development</a></li>
  478. <li><a href="http://vaadin.com/support">vaadin.com/support
  479. - Commercial support for Vaadin development </a></li>
  480. <li><a href="http://vaadin.com/services">vaadin.com/services
  481. - Expert services for Vaadin</a></li>
  482. <li><a href="http://vaadin.com/company">vaadin.com/company
  483. - Information about the company behind Vaadin</a></li>
  484. <li><a href="http://dev.vaadin.com">dev.vaadin.com
  485. - Bug tracker</a></li>
  486. <li><a
  487. href="http://dev.vaadin.com/wiki/Vaadin/Development/StartingVaadin7Development">How
  488. to get the source code of Vaadin</a></li>
  489. </ul>
  490. </div>
  491. <!-- /content-->
  492. <div id="footer">
  493. <span class="slogan"><strong>vaadin <em>}></em>
  494. </strong> thinking of U and I<span> <a href="#top">&uarr; Back
  495. to top</a>
  496. </div>
  497. <!-- /footer -->
  498. </body>
  499. </html>
  500. <!-- Keep this comment at the end of the file
  501. Local variables:
  502. mode: xml
  503. sgml-omittag:nil
  504. sgml-shorttag:nil
  505. sgml-namecase-general:nil
  506. sgml-general-insert-case:lower
  507. sgml-minimize-attributes:nil
  508. sgml-always-quote-attributes:t
  509. sgml-indent-step:2
  510. sgml-indent-data:t
  511. sgml-parent-document:nil
  512. sgml-exposed-tags:nil
  513. sgml-local-catalogs:("/etc/sgml/catalog" "/usr/share/xemacs21/xemacs-packages/etc/psgml-dtds/CATALOG")
  514. sgml-local-ecat-files:("ECAT" "~/sgml/ECAT" "/usr/share/sgml/ECAT" "/usr/local/share/sgml/ECAT" "/usr/local/lib/sgml/ECAT")
  515. End:
  516. -->