Hinweise zur Migration auf jadice web toolkit 5.7

Wichtiger Hinweis

Diese Anleitung gilt für JWT Version 5.7.0.0 vom 20.09.2018.

Die Hinweise gelten für die Migration von jadice web toolkit 5.6 auf 5.7.

Inhalt

Neue Funktionen und Features

Beibehaltung dokumentbezogener RenderControls ist nun konfigurierbar

Rendercontrols, die sich auf das komplette Dokument beziehen, werden nun beim Dokumentenwechsel standardmäßig verworfen. Sollen diese wie bisher beibehalten werden, muss dies explizit in ClientConfigurationManager.getClientConfiguration().setPreserveRenderControlsOnDocumentChange(true) gesetzt werden. Das zugehörige Ticket ist JWT-2657.

Web-Fonts

Durch Änderungen in der Behandlung von Schriftarten muss der Browser-Cache bei der ersten Verwendung zunächst geleert werden. Wird der Cache nicht geleert, kann es zu Darstellungsfehlern kommen.
Um zu gewährleisten, dass Schriftarten vor der Anzeige eines Dokumentes clientseitig zur Verfügung stehen, wird empfohlen, in der EntryPoint-Implementation der Anwendung in onModuleLoad direkt zu Beginn FontConfig.get() aufzurufen. Dadurch wird sichergestellt, dass die Standard-Fonts ArimoCousine und Tinos rechtzeitig geladen werden. Dabei ist zu beachten, dass zuvor eine ServerConnection erzeugt werden muss, um die Server-Adresse ermitteln zu können. Dieses Verhalten ist beispielsweise im EnterpriseDemoEntryPoint der Enterprise Demo implementiert.

Aktualisierung der jadice document platform

Ab Version 5.7.0.0 verwendet das jadice web toolkit Version 5.5 der jadice document platform. Bei umfangreicher integrationsspezifischer Nutzung der jadice document platform in Serverkomponenten sind dadurch sehr wahrscheinlich Anpassungen erforderlich, detaillierte Informationen auch zu den API-Änderungen in der document platform sind in den Migrationshinweisen der document platform aufgelistet.  

Geänderte Modulstruktur

In Version 5.5 der jadice document platform wurde die Modulstruktur optimiert, um logisch zusammengehörende Funktionalitäten zu bündeln. Durch diese Auftrennung können die einzelnen Funktionalitäten unabhängiger voneinander entwickelt werden. Entsprechend sind auch die Versionsverläufe der verschiedenen Module unterschiedlich. Das Versionsnummernschema der einzelnen Module hat sich auf eine dreistellige Versionsnummer geändert.

Die wichtigsten Änderungen der maven-Koordinaten sind im folgenden Expandable zusammengefasst:


 Ausklappen, um die aktualisierten Koordinaten der wichtigsten Module zu sehen

Die maven-Koordinaten und die aktuelle Version sind jeweils auch über die Suchfunktion in Nexus verfübar


bisherige maven-Koordinatenneue maven-KoordinatenAnmerkungenaktuelle Version
(Stand September 2018)
jadice-core
Bisherige maven-Koordinaten von jadice-core
<dependency>
  <groupId>com.levigo.jadice.documentplatform</groupId>
  <artifactId>jadice-core</artifactId>
  <version>${docp.version}</version>
</dependency>
Neue maven-Koordinaten jadice-core
<dependency>
 <groupId>com.levigo.jadice.documentplatform.core</groupId>
<artifactId>jadice-core</artifactId>
  <version>${jadicecore.version}</version>
</dependency>

Die Kernfunktionalitäten der document platform, wie beispielsweise das Dokument-Modell, sind im neuen Modul jadice-core zusammengefasst.


1.0.9 
jadice-format-*
Bisherige maven-Koordinaten am Beispiel von jadice-format-pdf
<dependency>
  <groupId>com.levigo.jadice.documentplatform</groupId>
  <artifactId>jadice-format-pdf</artifactId>
  <version>${docp.version}</version>
</dependency>
Neue maven-Koordinaten am Beispiel von jadice-format-pdf
<dependency
  <groupId>com.levigo.jadice.documentplatform.core</groupId>
  <artifactId>jadice-format-pdf</artifactId>
  <version>${jadicecore.version}</version>
</dependency>

Die jadice-format Module haben nun die groupId com.levigo.jadice.documentplatform.core

Die Versionsnummerierung der jadice-format-* Module entspricht nun der des jadice-core.

wie jadice-core
jadice-utils
Bisherige maven-Koordinaten der levigo-utils
<dependency>
  <groupId>com.levigo.util</groupId>
  <artifactId>levigo-utils</artifactId>
  <version>${levigoutils.version}</version>
</dependency>
Maven-Koordinaten von jadice-utils
<dependency>
  <groupId>org.jadice.util</groupId>
  <artifactId>jadice-utils</artifactId>
  <version>${jadiceutils.version}</version>
</dependency>

Die levigo-utils sind in den jadice-utils aufgegangen.

Die Versionsnummerierung hat sich geändert.

1.1.3
jadice-annotation
Bisherige maven-Koordinaten von jadice-annotation
<dependency>  <groupId>com.levigo.jadice.documentplatform</groupId>
  <artifactId>jadice-annotation</artifactId>
  <version>${docp.version}</version>
</dependency>
Neue maven-Koordinaten von jadice-annotation
<dependency
  <groupId>com.levigo.jadice.documentplatform.core</groupId>
  <artifactId>jadice-annotation</artifactId>
  <version>${jadicecore.version}</version>
</dependency>

Das jadice-annotation Modul hat nun die groupId com.levigo.jadice.documentplatform.core

Die Versionsnummer des jadice-annotation Moduls entspricht nun der des jadice-core.

wie jadice-core
jadice-printer
Bisherige maven-Koordinaten von jadice-printer
<dependency>
  <groupId>com.levigo.jadice.documentplatform</groupId>
  <artifactId>jadice-printer</artifactId>
  <version>${docp.version}</version>
</dependency>
Neue maven-Koordinaten von jadice-printer
<dependency>
  <groupId>com.levigo.jadice.documentplatform.core</groupId>
  <artifactId>jadice-printer</artifactId>
  <version>${jadicecore.version}</version>
</dependency>

Das jadice-printer Modul hat nun die groupId com.levigo.jadice.documentplatform.core

Die Versionsnummer des jadice-print Moduls entspricht nun der des jadice-core.

wie jadice-core
jadice-reshape
Bisher einzubindende jadice-reshape Module
<dependency>
    <groupId>com.levigo.jadice.documentplatform</groupId>
    <artifactId>jadice-reshape-filter</artifactId>
    <version>${docp.version}</version>
</dependency>
<dependency>
    <groupId>com.levigo.jadice.documentplatform</groupId>
    <artifactId>jadice-reshape-generator</artifactId>
    <version>${docp.version}</version>
</dependency>
<dependency>
    <groupId>com.levigo.jadice.documentplatform</groupId>
    <artifactId>jadice-reshape-settings</artifactId>
    <version>${docp.version}</version>
</dependency>
<dependency>
Neue maven-Koordinaten von jadice-reshape
<dependency>
    <groupId>com.levigo.jadice.documentplatform.core</groupId>
    <artifactId>jadice-reshape-api</artifactId>
    <version>${jadicecore.version}</version>
</dependency>
<dependency>
    <groupId>com.levigo.jadice.documentplatform.core</groupId>
    <artifactId>jadice-reshape-settings</artifactId>
    <version>${jadicecore.version}</version>
</dependency>

Jadice reshape ist nun Teil des jadice core. Die groupId ist com.levigo.jadice.documentplatform.core

Die Versionsnummer des jadice-reshape Moduls entspricht nun der des jadice-core.

wie jadice-core
jadice-generator (alt)
Bisherige maven-Koordinaten von jadice-generator-*
<dependency>
<groupId>com.levigo.jadice.documentplatform</groupId>
    <artifactId>jadice-generator-pdf</artifactId>
    <version>${docp.version}</version>
</dependency>
<dependency>
  <groupId>com.levigo.jadice.documentplatform</groupId>
    <artifactId>jadice-generator-tiff</artifactId>
    <version>${docp.version}</version>
</dependency>
Neue maven-Koordinaten in jadice reshape
<dependency>
    <groupId>com.levigo.jadice.documentplatform.core</groupId>
    <artifactId>jadice-reshape-pdf</artifactId>
    <version>${jadicecore.version}</version>
</dependency>
<dependency>
    <groupId>com.levigo.jadice.documentplatform.core</groupId>
    <artifactId>jadice-reshape-tiff</artifactId>
    <version>${jadicecore.version}</version>
</dependency>

Das jadice-generators-Modul wurde in jadice-reshape-* umbenannt und in jadice-reshape-modules integriert

Die Versionsnummer des jadice-reshape Moduls entspricht nun der des jadice-core.

wie jadice-core


Unterstützung von log4j2

Die neuen jadice-utils unterstützen nun log4j2. Über die folgende Dependency kann das log4j2-Modul eingebunden werden:

 <dependency>
    <groupId>org.jadice.util</groupId>
    <artifactId>logging-log4j2</artifactId>
    <version>${jadiceutils.version}</version>
 </dependency>

API-Änderungen und Umbenennungen von Klassen und Packages

altneuAnmerkungsiehe JIRA-Ticket

com.levigo.util.*

com.jadice.web.util.*

Die Packages der jadice web toolkit utils wurden konsistent benannt.

Auch die *.gwt.xml-Dateien wurden entsprechend verschoben. Referenzen auf diese müssen angepasst werden.

JWT-677
com.levigo.util.*org.jadice.util.*Die Packages der restlichen levigo utils wurden im Rahmen der Veröffentlichung der jadice document platform 5.5 verschoben. Die import-Statements im jadice web toolkit wurden entsprechend angepasst.JWT-677

com.jadice.web.util.icon.client.iconfont.JWTIconFont.DOWN

com.jadice.web.util.icon.client.iconfont.JWTIconFont.UP

com.jadice.web.util.icon.client.iconfont.JWTIconFont.DOWN_A

com.jadice.web.util.icon.client.iconfont.JWTIconFont.UP_A

Es wurde eine zweite Variante an Down und Up Arrows hinzugefügt (welche im Thumbnail Tool verwendet werden). Aus diesem Grund wurden die bestehenden Icons umbenannt.

Für eine vollständige Übersicht über den Icon Font siehe: http://webtoolkit.jadice.com/showcase/index.html?connection=longpoll#!DefaultIconFont

JWT-2350
com.levigo.jadice.document.creator.*com.levigo.jadice.document.contentscreator.*

Das Package com.levigo.jadice.document.creator wurde entfernt. Die Funktionalität wird nun von den Klassen im Package com.levigo.jadice.document.contentscreator abgedeckt.

Hilfen zur Anwendung der neuen API gibt es in der jadice knowledge base in den Artikeln Wasserzeichen und Kopfzeilen im jadice web toolkit und Wasserzeichen und Kopfzeilen mit dem ContentsCreatorPageSegment

-

Änderungen im Annotationsprofil

altneuAnmerkungsiehe JIRA-Ticket

<wrangler toolkit="swing"
class="com.levigo.jadice.swing.internal.annotation.wranglers.*" />

<editor toolkit="swing"
class="com.levigo.jadice.swing.internal.annotation.editors.*" />

-

Mit der Integration der neuen jadice document platform bzw. deren core-Modul wurden die Dependencies auf die Swing-Module der jadice document platform entfernt.

Demzufolge müssen alle Swing-Dependencies aus den Annotationsprofilen entfernt werden. (Achtung: dies betrifft nur die Wrangler und Editoren, nicht aber die Renderer, welche auch das toolkit="swing" definieren)

JWT-677
<property name="lineWrap">CHARACTER</property><property name="lineWrap">CHARACTER_CR</property>

Die als deprecated markierten LineWrap Modi CHARACTER und WORD wurden entfernt. Stattdessen sollten die LineWrap Modi CHARACTER_CR und WORD_CR verwendet werden.

Renderer-Definitionen, bei denen diese Modi verwendet werden, müssen angepasst werden.

JWT-2355

<property name="lineWrap">WORD</property><property name="lineWrap">WORD_CR</property>