webPDF 8: Operation Outline - Teil 3: Zum AnnotationSelection Objekt am Beispiel der `hide` Action

Technische Mindestanforderungen​

  • Java-Version: 8
  • webPDF-Version: 8
  • wsclient-Version: 2

Zum AnnotationSelection Objekt​

Fortsetzung von Operation Outline Teil 2.

Um die modifizierten Annotationen anzuwählen, wird ein AnnotationSelection Objekt genutzt. Es können hierfür mehrere Annotationen angewählt werden.

Das Objekt „annotationSelection"​

Verschiedene der hier definierten ActionTypes modifizieren Annotationen des Dokuments. Über ein AnnotationSelection Objekt wird eine solche Annotation ausgewählt. (Hier am Beispiel der hide Action.)

AnnotationSelectionType annotationSelection = new AnnotationSelectionType();

hideAction.getAnnotation().add(annotationSelection);

Am Objekt annotationSelection lassen sich folgende Parameter setzen:

page (Standardwert: „1")​

Die Nummer der Seite, auf der sich die Annotation befindet.

annotationSelection.setPage(2);

index​

Der Index der Annotationen im Annotationsverzeichnis der Seite (alternativ hierzu kann auch der Name der Annotation angegeben werden.)

annotationSelection.setIndex(3);

name​

Der Name der Annotation (alternativ hierzu kann auch der Index der Annotation angegeben werden.)

annotationSelection.setName("annotationName");

executeNamed-ActionType​

Der PDF Standard bietet die Möglichkeit Aktionen vorzubereiten und unter einem bestimmten Namen zu hinterlegen. Diese Aktion erlaubt deren Ausführung.

NamedActionType executeNamed = new NamedActionType();

firstPage.getActions().add(executeNamed);

Folgende Parameter und Unterelemente können für eine executeNamed Action gewählt werden:

namedOperation (Standardwert: „")​

Der Name der Operation, die ausgeführt werden soll. Es können weitere Operationen definiert werden, durch den PDF Standard werden folgende Namen standardmäßig unterstützt:

  • NextPage = Springe auf die nächste Seite.
  • PrevPage = Springe auf die vorhergehende Seite.
  • FirstPage = Springe auf die erste Seite.
  • LastPage = Springe auf die letzte Seite.
executeNamed.setNamedOperation("FirstPage");

submitForm-ActionType​

Übermittelt bei Anwahl des Elements den Inhalt der Formularfelder des Dokuments an eine gegebene URL. (Zu exportierende Formularfelder werden über Field Objekte angewählt.)

SubmitFormActionType submitForm = new SubmitFormActionType();

firstPage.getActions().add(submitForm);

Folgende Parameter und Unterelemente können für eine submitForm Action gewählt werden:

url (Standardwert: „")​

Die URL, an die die Formulardaten übermittelt werden sollen.

submitForm.setUrl("https://www.softvision.de");

exclude (Standardwert: „false")​

Wird dieser Wert auf true gesetzt, dann werden alle Formularfelder außer den gewählten exportiert.

submitForm.setExclude(true);

includeNoValueFields (Standardwert: „false")​

Wird dieser Wert auf true gesetzt, dann werden auch Formularfelder exportiert, deren Werte nicht gesetzt wurden.

submitForm.setIncludeNoValueFields(true);

exportFormat (Standardwert: „false")​

Wird dieser Wert auf true gesetzt und weder submitPDF, noch xfdf aktiviert, dann werden die Formulardaten im HTML Format exportiert - andernfalls werden sie im fdf Format exportiert.

submitForm.setExportFormat(true);

getMethod (Standardwert: „false")​

Dieser Wert ist relevant, wenn exportFormat aktiviert wurde. Wird der Wert auf true gesetzt, so wird das Formular mittels einer HTTP-GET-Methode übermittelt, andernfalls über eine HTTP-POST-Methode.

submitForm.setGetMethod(true);

submitCoordinates (Standardwert: „false")​

Dieser Wert ist relevant, wenn exportFormat aktiviert wurde. Wird der Wert auf true gesetzt, so wird in den exportierten Daten auch die Position des auslösenden Mausklicks übermittelt.

submitForm.setSubmitCoordinates(true);

xfdf (Standardwert: „false")​

Dieser Wert ist relevant, wenn submitPDF nicht aktiviert wurde. Wird der Wert auf true gesetzt, so werden die Formulardaten im XFDF Format übermittelt.

submitForm.setXfdf(true);

includeAppendSaves (Standardwert: „false")​

Dieser Wert ist relevant, wenn die Formulardaten im fdf Format übermittelt werden. In diesem Fall enthält der Export inkrementelle Änderungen an den Formulardaten.

submitForm.setIncludeAppendSaves(true);

includeAnnotations (Standardwert: „false")​

Dieser Wert ist relevant, wenn die Formulardaten im fdf Format übermittelt werden. In diesem Fall enthält der Export auch sämtliche Markup Annotationen des Dokuments.

submitForm.setIncludeAnnotations(true);

submitPDF (Standardwert: „false")​

Wird dieser Wert auf true gesetzt, wird das Formular im pdf Format übermittelt.

submitForm.setSubmitPDF(true);

canonicalFormat (Standardwert: „false")​

Wird dieser Wert auf true gesetzt, werden sämtliche Daten und Uhrzeiten in einem kanonischen Standardformat übermittelt.

submitForm.setCanonicalFormat(true);

excludeNonUserAnnotations (Standardwert: „false")​

Dieser Wert ist relevant, wenn die Formulardaten im fdf Format übermittelt werden. Wird dieser Wert auf true gesetzt, werden sämtliche Annotationen, die nicht vom Nutzer gesetzt wurden, nicht übermittelt.

submitForm.setExcludeNonUserAnnotations(true);

excludeFDFSourceOrTargetFile (Standardwert: „false")​

Dieser Wert ist relevant, wenn die Formulardaten im FDF-Format übermittelt werden. Wird dieser Wert auf true gesetzt, wird die Ziel-URL nicht in den Exportdaten enthalten sein.

submitForm.setExcludeFDFSourceOrTargetFile(true);

embedForm (Standardwert: „false")​

Dieser Wert ist relevant, wenn die Formulardaten im FDF-Format übermittelt werden. Wird dieser Wert auf true gesetzt, werden nicht nur die Formulardaten selbst, sondern das Gesamtdokument mit eingebettetem Formular übermittelt.

submitForm.setEmbedForm(true);

Das „field" Objekt​

Wählt für submitForm und resetForm Aktionen die Formularfelder aus, die übermittelt oder zurückgesetzt werden sollen.

FormFieldSelectionType formField = new FormFieldSelectionType();

submitForm.getField().add(formField);

Folgende Parameter und Unterelemente können für ein field Objekt gewählt werden:

name (Standardwert: „")​

Die Bezeichnung des Formularfeldes, das gewählt werden soll.

formField.setName("formFieldName");

resetForm-ActionType​

Setzt bei Anwahl des Elements den Inhalt der gewählten Formularfelder des Dokuments auf ihre Initialwerte zurück. (Zu ändernde Formularfelder werden über Field Objekte angewählt.)

ResetFormActionType resetForm = new ResetFormActionType();

firstPage.getActions().add(resetForm);

Folgende Parameter und Unterelemente können für eine resetForm Action gewählt werden:

exclude (Standardwert: „false")​

Wird dieser Wert auf true gesetzt, dann werden alle Formularfelder außer den gewählten zurückgesetzt.

resetForm.setExclude(true);

importData-ActionType​

Setzt bei Anwahl des Elements den Inhalt der Formularfelder des Dokuments auf die, im gegebenen Schema definierten, Werte. Zur Wahl der Schema Datei wird ein fileSpecification Objekt genutzt.

ImportDataActionType importData = new ImportDataActionType();

firstPage.getActions().add(importData);

FileSpecificationType fileSpecification = new FileSpecificationType();

importData.setFile(fileSpecification);

executeJavaScript-ActionType​

Führt bei Anwahl des Elements den gegebenen JavaScript Code aus.

JavaScriptActionType executeJS = new JavaScriptActionType();

firstPage.getActions().add(executeJS);

Folgende Parameter und Unterelemente können für eine executeJavaScript Action gewählt werden:

jsAction (Standardwert: „")​

Der auszuführende JavaScript-Code.

executeJS.setJsAction("...");

setOCGState-ActionType​

Ändert bei Anwahl des Elements die Sichtbarkeit der gewählten Ebene.

SetOCGStateActionType setOCGState = new SetOCGStateActionType();

firstPage.getActions().add(setOCGState);

Nächster Blogartikel zur Webservice Operation Outline​

Hier geht es zu webPDF 8: Operation Outline - Teil 4 - Vorstellung weiterer ActionTypes.