Module FormcycleDE

Index

Modules

Interfaces

Type aliases

Type aliases

AppointmentPickerInstanceReference

AppointmentPickerInstanceReference: string | object | Node | ArrayLike<Node> | Iterable<Node>

Reference to an existing appointment picker. This can be one of the following:

  • string: A CSS selector for a DOM element, see the case Node below.
  • {by: "id", id: "..."} - The ID of an existing appointment picker instance.
  • {@link Node}: A DOM element referencing an appointment picker. Can be either any container element that contains an appointment picker; the appointment picker element itself; or one of the elements in the sub tree of the appointment picker element.
  • array of {@link Node}s: A array of DOM elements referencing an appointment picker, see the case Node above.
  • iterable of {@link Node}s: A list of DOM elements referencing an appointment picker, see the case Node above.

Note that a reference may resolve to more than one appointment picker. The behavior in this case depends on where the reference is used.

AppointmentPickerLockState

AppointmentPickerLockState: "enabled" | "disabled" | "read-only"

Indicates whether an appointment picker is enabled or not enabled, and in what way.

  • enabled: The picker can be edited.
  • disabled: The picker cannot be edited, values are discarded.
  • read-only: The picker cannot be edited, values are sent when the form is submitted.

AppointmentPickerStateReference

AppointmentPickerStateReference: AppointmentPickerInstanceReference | object

Reference to an existing appointment picker state. This is similar to AppointmentPickerInstanceReference, but also allows for a snapshot from an appointment picker to be specified. You can take a snapshot of an appointment picker's state at any time, and e.g. load it into other appointment pickers.

In addition to values allowed by AppointmentPickerInstanceReference, may also be one of the following:

  • {by: "snapshot", token: "..."} - The token of an existing snapshot. Snapshot tokens can be created via the API function saveSnapshot.

ChangeDisplayMode

ChangeDisplayMode: "open" | "close" | "toggle"

How to change the display mode, for the message changeDisplay.

  • open: Opens the picker when not already opened.
  • close: Closes the picker when not already closed.
  • toggle: Opens the picker when closed and closes it when opened.

ChangeLockMode

ChangeLockMode: "enable" | "disable" | "setReadOnly"

How to change the lock mode, for the message changeLock.

  • enable: Enables the picker and makes it editable.
  • disable: Disabled the picker and makes it non-editable.
  • setReadOnly: Sets the picker to read-only and makes it non-editable.

FormRequestType

FormRequestType: "provide" | "preview" | "process" | "print" | "review" | "publish" | "workflow" | "image" | "form" | "reviewplain" | "copy" | "forward" | "alias" | "aliascopy" | "verify"

Mögliche Werte für die Request-Typen in Formularen. Sie geben an, wie ein Formular aufgerufen wurde. Auf diese Eigenschaft wird über XFC_METADATA.requestType zugegriffen. Einige dieser Werte sind nur für die interne Verwendung bestimmt und sollten nicht verwendet werden.

  • provide: Initiales Öffnen eines Formulars. Es gibt noch keinen Vorgang zum Formular.
  • preview: Vorschau des Formulars, also wenn das Formular im Vorschaumodus des Designers geöffnet wird.
  • print: Drucken des Formulars. Das Formular wird durch den Server geöffnet, um etwa ein PDF-Dokument oder ein Bild zu erzeugen.
  • process: Verarbeitung des Formulars. Ist gesetzt, wenn das Formular abgesendet wird.
  • review: Wiederanzeige des Formulars im Posteingang. Es gibt nun einen Vorgang zum Formular.

FormUrlType

FormUrlType: "attachment" | "context" | "dataquery_db" | "dataquery_ldap" | "datasource_csv" | "datasource_db" | "datasource_json" | "datasource_xml" | "keepalive" | "plugin" | "previewAction" | "submitAction"

Werte für die Arten von URLs in formcycle. Die folgenden Arten von URLs gibt es derzeit:

  • attachment: Basis-URL zum Zugreifen auf angehängte Dateien, die mittels Upload-Elementen hochgeladen wurden.
  • context: Der aktuelle Kontextpfad der Anwendung, etwa /formcycle.
  • dataquery_db: Basis-URL zum Zugreifen auf in formcycle konfigurierte Datenbankabfragen.
  • dataquery_ldap: Basis-URL zum Zugreifen auf in formcycle konfigurierte LDAP-Abfragen.
  • datasource_csv: Basis-URL zum Zugreifen auf in formcycle konfigurierte CSV-Datenquellen.
  • datasource_db: (deprecated) Es sollte nun dataquery_db genutzt werden.
  • datasource_json: Basis-URL zum Zugreifen auf in formcycle konfigurierte JSON-Datenquellen.
  • datasource_xml: Basis-URL zum Zugreifen auf in formcycle konfigurierte XML-Datenquellen.
  • keepalive: URL, um die aktuelle Sitzung aufrecht zu erhalten. Eine Art von ping.
  • plugin: URL zum Ausführen von Servlet-Plugins.
  • previewAction: URL zum Erstellen einer Formularvorschau. Solch ein Formular kann nicht abgesendet werden.
  • submitAction: URL, an welche die Formulardaten gesendet werden.

FormVruleType

FormVruleType: "posinteger" | "plzDE" | "posmoney" | "integer" | "url" | "posmoneyOptionalComma" | "number" | "money" | "ipv4" | "phone" | "onlyLetterNumber" | "time" | "onlyLetterSp" | "email" | "dateDE" | "text" | "regexp"

Standardmäßig vordefinierte Datentypen für Texteingabefelder.

  • dateDE: Erlaubt nur Datumsangaben nach dem deutschen Format (TT.MM.JJJJ), z.B. 22.05.1990.
  • email: Erlaubt nur gültige (internationale) E-Mail-Adressen, z.B. james@john.org or θσερ@εχαμπλε.ψομ.
  • integer: Erlaubt nur Ganzzahlen, also Zahlen ohne Komma, z.B. 3, 0 oder -21.
  • ipv4: Erlaubt nur gültige IP4-Adressen, z.B. 127.0.0.1 oder 10.42.42.13.
  • money: Erlaubt nur gültige Geldbeträge, also Zahlen mit genau zwei Nachkommastellen, z.B. 2,00, -3,95, 0,00 oder 897345,38.
  • number: Erlaubt nur Zahlen, mit oder ohne Komma. Z.B: 0.03, -99.2 oder 42.
  • onlyLetterNumber: Erlaubt nur Buchstaben, Zahlen und Leerzeichen.
  • onlyLetterSp: Erlaubt nur Buchstaben und Leerzeichen.
  • phone: Erlaubt nur gültige Telefonnummern, z.B. 0234995483 oder +49 351 4459654.
  • plzDE: Erlaubt nur gültige deutsche Postleitzahlen, also genau fünf Ziffern, z.B. 02349. Prüft nicht, ob es solch eine Postleitzahl tatsächlich in Deutschland gibt.
  • posinteger: Erlaubt nur positive Ganzzahlen, z.B. 0, 3 oder 123.
  • posmoney : Erlaubt nur gültige, positive Geldbeträge mit genau zwei Nachkommastellen, z.B. 0,00 oder 2,34.
  • posmoneyOptionalComma: Erlaubt nur gültige, positive Geldbeträge, mit oder ohne Nachkommastellen, z.B. 0,00, 0, 3,4 oder 3.
  • regexp: Erlaubt es dem Formularersteller, einen eigenen regulären Ausdruck füri die Validierung einzugeben.
  • text: Wendet keine Einschränkungen an und erlaubt jede Eingabe.
  • time: Erlaubt nur gültige Zeitangaben in dem Format hh:mm, z.B. 22:05 or 03:42.
  • url: Erlaubt nur gültige URLs, welche das Protokoll enthalten müssen, z.B. http://example.com oder https://www.james.org.

Json

Json: null | boolean | number | string | JsonArray | JsonObject

Alle Datentypen, die gültiges JSON darstellen.

JsonArray

JsonArray: Json[]

Alle Felder, die gültige JSON-Felder darstellen

JsonObject

JsonObject: object

Alle Objekte, die gültige JSON-Objekte darstellen.

Type declaration

  • [key: string]: Json

LegacyFileStore

LegacyFileStore: Partial<Record<string, LegacyFileStoreItem>>

Legacy-Modell für den Dateispeicher mit allen Binärdateien aus Upload-Elementen. Der Schlüssel ist die ID des Formularelements, z. B. xi-tf-1.

deprecated

Legacy, wird durch ein besseres Modell ersetzt werden.

LegacyFormField

LegacyFormField: Partial<Record<string, string | number | false | true | number[] | LegacyFormFieldSaveData>>

Legacy-Modell mit gespeicherten Daten des Formularfeldes und den Metadaten des Formularfeldes.

Der Schlüssel kann einer der folgenden sein

  • Der fortlaufende Wiederholungsindex, beginnend bei 0, mit einem vorangestellten Unterstrich, z. B. _0 oder _1. Dann ist der Wert der entsprechende Wert des Formularfeldes, der je nach Art des Formularelements ein String, ein Array, ein Objekt usw. sein kann.
  • Eine der Eigenschaften von LegacyFormFieldMeta.
deprecated

Legacy, wird durch ein besseres Modell ersetzt werden.

LegacyFormFieldSaveData

LegacyFormFieldSaveData: SingleOrArrayLike<undefined | string | number | Record<string, unknown>>

Mögliche Typen für die gespeicherten Daten eines Formularfeldes.

deprecated

Legacy, wird durch ein besseres Modell ersetzt werden.

LegacyFormSaveData

LegacyFormSaveData: Partial<Record<string, object | LegacyFormField | string[]>>

Legacy-Modell, das die in ein Formular eingegebenen Daten darstellt, einschließlich der Werte von sich wiederholenden Formularfeldern sowie von Bildern.

Der Schlüssel kann einer der folgenden sein:

  • Der Name eines wiederholten Formularfeldes mit dem Präfix _dyn_size, z. B. tf1_dyn_size. Dann ist der Wert ein Array mit den Wiederholungs-IDs, z. B. ["0", "1", "2"].
  • Die ID des Formularfeldes, z. B. "xi-tf-1". Der Wert ist ein Objekt mit den Metadaten und Werten für jedes Formularfeld.
  • Eine der Eigenschaften von LegacyFormSaveDataBase.
deprecated

Legacy, wird durch ein besseres Modell ersetzt werden.

LocalDateRange

LocalDateRange: keyof [fromInclusive, LocalDate | undefined, toInclusive, LocalDate | undefined]

Represents a range of LocalDate, comprised of a lower and an upper bound.

When a lower or upper end point exists, it is a closed end point, i.e. the end point is part of the range.

When a lower or upper bound is undefined, it is an open end point with -Infinity or +Infinity as the value, respectively.

The lower bound should not be greater than the upper bound. If it is, the range is considered empty.

If you need an open range, simply change the lower or upper bound. This is always possible since LocalDate is a discrete domain.

OnSubmitCallback

OnSubmitCallback: function

Eine benutzerdefinierte Callback-Funktion für das Absenden des Formulars, die über XUtil.onSubmit registriert werden kann.

$.xutil.onSubmit(() => doSomething())

Type declaration

SingleOrArrayLike

SingleOrArrayLike: T | ArrayLike<T>

Repräsentiert einen einzelnen Wert oder ein Feld von solchen Werten.

TElementSpecifier

TElementSpecifier: undefined | null | TElement | TElement[] | NodeList & NodeListOf<TElement> | HTMLCollection & HTMLCollectionOf<TElement> | string | JQuery<TElement>

Union of types that can be interpreted as referencing to one or multiple (DOM) elements.

  • undefined and null are represent a missing element.
  • TElement is the element itself.
  • TElement[] is an array of elements.
  • NodeListOf<TElement> is a list of elements, returned by querySelectorAll.
  • HTMLCollectionOf<TElement> is a collection of elements, returned by getElementsByClassName.
  • string is a CSS selector for the element(s).
  • JQuery is a JQuery wrapper with the element(s).
returns

A union type with various different types corresponding to an element.