Kapitel 2. Allgemeines zu Annotationen

    // URL für das Jadice Profil
    URL profileUrl = JadiceAnnotationReader.class.getResource("/default-annotation-profile.xml");

    // URL für das CM7 Profil
    URL profileUrl = CMAnnotationReader.class.getResource("/cm7-annotation-profile.xml");

    // URL für das CM8 Profil
    URL profileUrl = CMAnnotationReader.class.getResource("/cm8-annotation-profile.xml");

    // URL für das FileNet IS Profil
    URL profileUrl = FNISAnnotationReader.class.getResource("/filenet-is-annotation-profile.xml");

    // URL für das FileNet P8 Profil
    URL profileUrl = FNP8AnnotationReader.class.getResource("/filenet-p8-annotation-profile.xml");

    // URL für das XFDF Profil
    URL profileUrl = XFDFAnnotationReader.class.getResource("/xfdf-annotation-profile.xml");

    // Laden und Setzen des Profils
    AnnotationProfile profile = AnnotationProfile.load(profileUrl);
    AnnotationProfile.setDefaultProfile(profile);
    

Im Profil werden an erster Stelle die Annotationstypen des jeweiligen Formats definiert. Dabei handelt es sich um "Basistypen", die die grundsätzlichen Eigenschaften unterschiedler Typen festlegen. Sie werden beim Laden von Annotationen genutzt, um geladene Annotationseigenschaften mit Hilfe des Profils auf eine Java-Klasse abbilden zu können.

Als nächstes werden die "Templates" (Vorlagen) für die Annotationen definiert. Templates sind spezifische Ausprägungen eines "Basistypes". Damit werden mehrere Arten eines "Basistypes" definierbar. Als Beispiel, blaues und gelbes Rechteck. "Templates" werden bei der Anzeige der Annotationstoolbar und beim Erstellen von Annotationen genutzt.

Abschließend wird der Inhalt der Annotationtoolbar festgelegt. Durch diesen Schritt wird bestimmt, welche Annotationsarten dem Anwender per Toolbar zum Erstellen eines Annotationsobjektes angeboten werden. Dabei definiert die konkrete Zusammenstellung bestimmter "Templates" das Erscheinungsbild Annotationtoolbar. Verwandte "Templates" können dabei auch gruppiert in die Toolbar aufgenommen werden.

Das 'annotation-profile' Element ist das Root-Element des Profils, das 'name' Attribut muss mit einem eindeutigen (idealerweise das Format beschreibenden) Namen belegt werden.

<annotation-profile name="Profile name">

	<!-- ############################################################################### -->
	<!-- ## Base types to match archetype definitions (used in reader class) -->
	<!-- ############################################################################### -->

	<annotation-type name="BaseLine" archetype="BaseLine" class="com.levigo.jadice.annotation.LineAnnotation">
	    ...
	</annotation-type>

	<annotation-type name="BaseArrow" archetype="BaseArrow" class="com.levigo.jadice.annotation.ArrowAnnotation">
        ...
    </annotation-type>

	<annotation-type name="BaseStamp" archetype="BaseStamp" class="com.levigo.jadice.annotation.StampAnnotation">
        ...
    </annotation-type>

    <!-- ############################################################################### -->
	<!-- ## User defined types (used in annotation toolbar) -->
	<!-- ############################################################################### -->

	<annotation-template name="Line" extends="BaseLine">
		<!-- User defined settings -->
	</annotation-template>

	<annotation-template name="Arrow" extends="BaseArrow">
		<!-- User defined settings -->
	</annotation-template>

	<annotation-template name="Stamp01" extends="BaseStamp">
		<!-- User defined settings -->
	</annotation-template>

	<annotation-template name="Stamp02" extends="BaseStamp">
		<!-- User defined settings -->
	</annotation-template>

	<!-- ############################################################################### -->
	<!-- ## Annotation toolbar definition -->
	<!-- ############################################################################### -->

	<type-set name="default">

		<type ref="Line" />
		<type ref="Arrow" />

		<type-set name="Stamp annotations">
			<type ref="Stamp01" />
			<type ref="stamp02" />
		</type-set>

	</type-set>

</annotation-profile>

Annotationseigenschaften, die im zugehörigen Annotation Profile für ein spezifischen Annotationtyp definiert wurden, werden beim Erstellen eines neuen Annotationsobjekts gesetzt. Damit ist es möglich verschiedene Ausprägungen von gewünschte Annotationen vorzudefinieren. Die vorgegebenen Eigenschaften müssen dabei zwingend von der im 'annotation-type' Element angegebenen Annotationsklasse und dem zugrundeliegenden Annotationsformat unterstützt werden.

Technisch werden dabei die Eigenschaften via Code-Reflection auf das Annotationsobjekt angewendet. Der Name der zu setzenden Eigenschaft wird vom entsprechenden Methodenname abgeleitet, z.B. für die Eigenschaft 'linePainted' muss das Annotationsobjekt die Methode 'setLinePainted(boolean)' zur Verfügung stellen.

Eine Übersicht der Methoden kann der Javadoc-Beschreibung der Annotationsklassen entnommen werden. Bei den hier aufgeführten Beispielen werden die Attribute mit dem Element 'fixed' (fester Wert) definiert. Es gibt noch weitere Ausprägungen von Elementen, die aber nur im Zusammenhang mit Editordefinitionen Sinn machen. Hierzu mehr im Abschnitt„Attribut-Definition mit Editor“. Eigenschaftstypen basieren auf einfachen Basistypen:

Beispiele:

Komplexe Eigenschaftsdefinitionen, z.B. Vektorpfade, Bilder, Datumsformate usw. müssen über eine AnnotationCustomizer-Implementation gesetzt werden. Siehe dazu den Abschnitt„AnnotationCustomizer-Klassen“).

Die Customizer-Klassen können dazu verwendet werden um eine Annotation nach deren Anlegen zu konfigurieren. Customizer-Klassen werden in Annotation-Type und Annotation-Template Elementen definiert, dabei ist auch die Angabe mehrerer Customizer möglich.

Während des Anlegens einer Annotation wird diese anhand der Definition im Annotationsprofil erstellt. Bevor die Annotation abschließend ins AnnotationPageSegment hinzugefügt wird, werden zuvor alle AnnotationCustomizer-Implementationen in der konfigurierten definierter Reihenfolge ausgeführt.

Um ein Anwendungsbeispiel zu nennen, der AnnotationCustomizer kann verwendet werden, um eine komplexe Polygonannotation anzulegen (hier Hakenannotation):

AnnotationCustomizer-Implementation

package customizers;

import java.awt.geom.GeneralPath;
import java.awt.geom.Point2D;

import com.levigo.jadice.annotation.Annotation;
import com.levigo.jadice.annotation.AnnotationCustomizer;
import com.levigo.jadice.annotation.PathAnnotation;

public class TickAnnotationCustomizer implements AnnotationCustomizer {

  @Override
  public void customize(Annotation a) {
    final PathAnnotation annotation = (PathAnnotation) a;

    // Position holen
    final Point2D point = new Point2D.Double(annotation.getBounds().getX(), annotation.getBounds().getY());

    final double xOff = point.getX();
    final double yOff = point.getY();

    final GeneralPath path = new GeneralPath();

    path.moveTo(xOff, yOff + 2000);
    path.lineTo(xOff + 1000, yOff + 3000);
    path.lineTo(xOff + 3000, yOff);

    annotation.setPath(path);
  }

}

Definition im Profil

<annotation-type name="Tick" extends="BasePen">
	<wrangler
		class="com.levigo.jadice.swing.internal.annotation.wranglers.FreehandAnnotationWrangler">
		<property name="creationMode">SINGLE_CLICK</property>
	</wrangler>
	<customizer class="customizers.TickAnnotationCustomizer"/>
</annotation-type>