Plugin-Dokumentation - Widget-Sprachauswahlelement-Plugin

Page / - zuletzt bearbeitet von gru am 03.11.2020, 10:27

Widget-Sprachauswahlelement-Plugin

zuletzt bearbeitet von gru

am 03.11.2020, 10:27

Inhaltsverzeichnis

Funktionsbeschreibung

Installation

Konfiguration

Grundeigenschaften

Darstellung

Optionen

Hilfe

CSS-Klassen

Attribute

Verfügbar wenn

Sonstiges

Word-/PDF-Export

Mögliche CSS-Anpassungen

Das Symbol für Widgets vom Typ Sprachauswahlelement im Xima® Formcycle-Designer.

Plugin-Download

Inhalt [ Verbergen ]

Funktionsbeschreibung

Installation

Konfiguration

Darstellung

Optionen

Word-/PDF-Export

Mögliche CSS-Anpassungen

Funktionsbeschreibung

Beispiel für ein eingefügtes Sprachauswahl-Widget in einem Formular. Die aktuell verwendete Sprache wird fett dargestellt.

Das Plugin stellt ein neues Widget im Designer zur Verfügung, welches es erlaubt, auf einfache Art eine Auswahlleiste für die Formularsprache einzufügen. Das Widget verwendet individuell im Designer zu konfigurierende Einstellungen im Bezug auf die anzuzeigenden Sprachen und die für sie anzuzeigenden Namen.

Durch einen Klick im Widget auf eine Sprache wird das Formular mit bereits eingegebenen Werten in den entsprechenden Sprache neu geladen. Zu beachten ist hier, dass es aufgrund von Sicherheitsbeschränkungen der Browser nicht möglich ist, vom Nutzer ausgewählte Dateien in Upload-Elementen wieder einzutragen.

Installation

Das Plugin kann als Mandant-Plugin oder System-Plugin installiert werden. Eine Anleitung zur Installation von Plugins finden Sie hier.

Konfiguration

An Widgets dieses Typs können die folgenden Eigenschaften konfiguriert werden:

Grundeigenschaften

Basiseinstellungen für Grundeigenschaften

Die Grundeigenschaften Name, Breite und Versteckt stehen jedem Formularelement zur Verfügung.

In diesem Dialogfenster lassen sich grundlegende Eigenschaften wie Name oder Breite einstellen.

Elemente können wiederholt werden, sodass der Nutzer eine beliebige Anzahl an Daten anlegen kann.

Durch Auswahl eines Triggers für die Anzahl an Wiederholungen kann diese automatisch gesetzt werden. In diesem Beispiel wird das Fieldset für die Daten zum Kind wiederholt. Abhängig der gewählten Kinderzahl ist so immer die richtige Menge an Fieldsets sichtbar.

Name	Beschreibung
Element	6.3.0+ Elementtyp des Formularelements. Der Elementtyp kann durch Auswahl eines anderen Elementtyps aus dem Dropdown-Menü geändert werden. Die Elementtypen, in die ein Element umgewandelt werden kann, hängen dabei vom ursprünglichen Typ ab. Container und Fieldsets können nur in den jeweils anderen Elementtyp transformiert werden. Alle anderen Elementtypen können in jeden anderen Typ transformiert werden, außer in Container und Fieldsets.
Name	Name des Elements. Es sind nur Buchstaben und Zahlen erlaubt.
Alias	Ein alternativer Name für das Formularelement, der alle Zeichen enthalten darf.
Breite	Relative Breite des Elements zu anderen Elementen in einer Formularzeile. Sind etwa drei Elemente nebeneinander platziert und haben für die Breite die Werte 10, 10 und 30 so nehmen sie in dieser Reihenfolge 20%, 20% und 60% der gesamten Breite der Formularzeile ein.
Versteckt	Ist hier ein Häkchen gesetzt, so wird das Element versteckt. Um es wieder anzuzeigen, kann die Eigenschaft sichtbar wenn oder eine entsprechende JavaScript-Funktion wie jQuery.fn.visible verwendet werden.
Gesperrt	Der Inhalt des Formularelementes kann nicht editiert werden. Der Inhalt wird auch beim Absenden nicht übertragen. Für Textfelder kann zudem ausgewählt werden, ob der Inhalt beim Absenden übertragen wird oder nicht.
Wiederholen	Ist diese Option aktiviert, so kann der Nutzer eine beliebige Anzahl an Wiederholunge (Kopien) von diesem Formularelement erstellen. Damit ist es etwa möglich, eine oder mehrere E-Mail-Adressen anzugeben. Es ist nicht möglich, wiederholte Elemente zu verschachteln: Ist ein Fieldset oder Container wiederholt, so kann kein Element darin mehr wiederholt werden.
Min. wdh.	Mindestzahl an Wiederholungen, die vorhanden sein müssen. Eine wiederholtes Formularelement ist nicht löschbar, wenn dadurch diese Mindestzahl unterschritten werden würde. Die hier eingestellte Anzahl ist zudem auch anfangs sichtbare Anzahl an Wiederholungen (beim Aufrufs des Formulars).
Max. wdh.	Höchstzahl an Wiederholungen, die erlaubt ist. Es kann keine weitere Kopie von einem Formularelement erzeugt werden, wenn dadurch diese Höchstzahl überschritten werden würde.
Element wdh.	Falls hier ein Element ausgewählt ist, bestimmt der Wert des ausgewählten Elements (Trigger-Element) die Anzahl an Wiederholungen. Beispiel: Es wird ein Auswahlelement oder Eingabefeld für die Anzahl der Kinder angelegt. Ein Fieldset, wo die Daten zu einem Kind eingegeben werden, wird wiederholt. Die Anzahl der Wiederholungen wird aus dem Auswahlelement bzw. Eingabefeld genommen. Damit ist immer für jedes Kind ein Fieldset vorhanden.
Knöpfe verstecken	6.2.0+ Nur verfügbar, falls unter Element wdh. ein Element ausgewählt ist. Mit dieser Option können die Plus- und Minusknöpfe zum Hinzufügen und Entfernen von Elementwiederholungen ausgeblendet werden. Dies ist dann sinnvoll, wenn die Anzahl der Wiederholungen nur über das ausgewählte Trigger-Element festgelegt werden soll.

Alias

Jedes Formular sendet Daten nach dem Prinzip Elementname Wert. Diese Elementnamen können über die Platzhalterersetzung in Aktionen und Templates verwendet werden. In einigen Fällen kann es vorkommen, dass diese Namen nicht für die Weiterverarbeitung verwendet werden können. Das kann z.B. auftreten, wenn für die Weiterverarbeitung spezielle Zeichen verwendet werden müssen, die im Formulardesigner nicht zulässig sind. Für diesen Fall besteht die Möglichkeit, einen Alias zu vergeben.

Wurde ein Alias vergeben, wird nun statt dem Namen des Formularelements der Alias für die Verarbeitung in den Aktionen und bei der Platzhalterersetzung verwendet.

Dieses Element hat keine zusätzlichen Einstellungen im Bereich Grundeigenschaften.

Darstellung

In diesem Bereich kann für Sprachauswahl-Widgets nur die Positionierung des Inhalts relativ zur Seite eingetragen werden.

Optionen

Mögliche Konfiguration der zu verwendenen Auswahloptionen eines Sprachauswahl-Widgets.

Sprachauswahl-Widgets verfügen über einen zusätzlichen Bereich Optionen. Hier können die in der Sprachauswahl sichtbaren Sprachen und die für die jeweilige Sprache anzuzeigenden Namen festgelegt werden.

Für jede anzuzeigende Sprache ist eine Zeile mit dem sichtbaren Beschreibungstext und dem Kürzel der Sprache einzugeben (z.B. en für Englisch). Optional können in der Spalte Titel die Title-Attribute festgelegt werden.

Neben der Konfiguration der Optionen direkt am Widget ist es zudem möglich, eine CSV-Datenquelle zu verwenden. Diese kann im Auswahlelement Datenquelle selektiert werden.

Hilfe

Basiseinstellungen für Hilfe

Hier kann der Hilfetext geändert werden, der als Tooltip am Formularfeld erscheint.

Der Hilfetext wird angezeigt, wenn die Maus sich über dem Icon Bereich befindet.

Diese Eigenschaft ermöglicht es, einen Hilfetextes zu einem Formularelement hinzuzufügen. Der Hilfetext erscheint, wenn mit der Maus über das Hilfe-Icons gefahren wird. Wenn unter Hilfe ein Text eingetragen ist, wird das Hilfe-Icon neben dem Element angezeigt. Wird Hilfetext wieder gelöscht, wird auch das Hilfe-Icon an dem Element wieder entfernt.

Dieses Element hat keine zusätzlichen Einstellungen im Bereich Hilfe.

CSS-Klassen

Basiseinstellungen für CSS-Klassen

Auswahl von CSS-Klassen im Designer.

Die Eigenschaft ermöglicht es dem ausgewählten Element eine oder mehrere CSS-Klassen zuzuordnen. Die in der Liste dargestellten CSS-Klassen werden aus dem CSS-Bereich und aus dem gewählten CSS-Theme ausgelesen. Nach Auswahl einer CSS-Klasse wird diese sofort angewandt, alle Änderungen des Designs sind also sofort links in der Formularvorschau einsehbar. Im unteren Teil des Eigenschaftenfensters kann nach vorhandenen CSS-Klassen gefiltert werden.

Dieses Element hat keine zusätzlichen Einstellungen im Bereich CSS-Klassen.

Attribute

Basiseinstellungen für Attribute

Es sollten keine eigenen HTML-Attribute mit beliebigen Namen mehr benutzt werden. In HTML5 gibt es sogenannte data-Attribute, die stattdessen genutzt werden können. Diese beginnen mit der Vorsilbe data-. Beispielsweise ist data-price als Attributname in Ordnung, nicht aber price.

Im Bereich Attribute können einem Formularelement HTML-Attribute hinzugefügt werden, auf diese dann später wieder im Skriptbereich per Javascript zugegriffen werden kann. Neben eigenen Attributen können auch bestehende HTML-Attribute überschrieben werden, etwa das Attribut type für Input-Elemente.

In diesem Bereich können beliebige HTML-Attribute vergeben werden. Dies eignet sich für fortgeschrittene Anwendungen.

Die eingegebenen Attribute werden als HTML-Attribute an dem jeweiligen Element hinterlegt.

Hinzufügen eines Attributs

Um ein HTML-Attribut hinzuzufügen, tragen Sie einfach in der Spalte Attribut den Namen des HTML-Attributs und in die Spalte Wert den gewünschten Wert ein. Nach der Eingabe wird automatisch eine neue Zeile für weitere Attribute eingefügt.

Löschen eines Attributs

Ein vorhandenes Attribut wird über das Icon links gelöscht.

Zugriff auf Data-Attribute mittels JavaScript

Um an einem Element zusätzliche Daten zu hinterlegen, gibt es die sogenannten Data-Attribute. Diese sollten im Namen keine Großbuchstaben enthalten, zudem sollten Wörter durch Bindestriche getrennt werden. Etwa data-serial-version ein guter Attributname, dataSerialVersion hingegen nicht. Beim Zugriff mittels JavaScript werden die Bindestriche entfernt und die Anfangsbuchstaben der Wörter in Großbuchstaben umgewandelt.

Angenommen, am Element tfSerialVer wurde für das Attribut data-serial-version wurde der 1aFXc gesetzt. Dann geschieht der Zugriff über JavaScript wie folgt:

const serialVersion = $("[name='tfSerialVer']").data("serialVersion");
console.log("Serial version ist:" , serialVersion);

Dieses Element hat keine zusätzlichen Einstellungen im Bereich Attribute.

Verfügbar wenn

Basiseinstellungen für Verfügbar wenn

Über die Eigenschaft Verfügbar wenn kann geregelt werden, wann Formularelemente angezeigt werden sollen.

In diesem Dialogfenster wird eingestellt, wann Formularelemente verfügbar sein sollen.

Wird nur ein Status oder nur eine Benutzergruppe gewählt, wird dieses Element nur angezeigt, wenn sich der Vorgang in diesem Status befindet bzw. der angemeldete Benutzer dieser Gruppe angehört. Zudem gibt es für jeden Status und jede Benutzergruppe auch die Möglichkeit, dass Element nur dann anzuzeigen, wenn das Formular nicht in diesem Status ist oder nicht von einem Benutzer dieser Benutzergruppe geöffnet wird. Beispielsweise kann damit ein Formularelement nur dann angezeigt werden, wenn es keinen Status hat, wodurch es nur für Benutzer sichtbar ist, jedoch nicht für Postfachbearbeiter.

Wird sowohl ein Status als auch eine Benutzergruppe ausgewählt, wird dieses Element nur angezeigt, wenn sich der Vorgang sowohl in diesem Status befindet und auch der angemeldete Benutzer dieser Gruppe angehört.

Im Gegensatz zu versteckten Elementen werden nicht verfügbare Elemente erst gar nicht in das Formular gerendert, sind also nicht im DOM vorhanden. Dies ist zu bedenken, wenn über jQuery darauf zugegriffen werden soll. Es sollte vorher geprüft werden, ob das Element vorhanden ist.

Die Auswahl kein Status bedeutet, dass das Formular nur aufgerufen und noch nie abgesendet wurde. Befindet sich das abgesandte Formular in einem Status, wird das Element nicht mehr angezeigt. Gleiches gilt für die Benutzergruppe keine Gruppe.

Dieses Element hat keine zusätzlichen Einstellungen im Bereich Verfügbar wenn.

Sonstiges

Basiseinstellungen für Sonstiges

Das Dialogfenster für sonstige Eigenschaften.

Im Bereich Sonstiges können Bemerkungen zu einem Feld hinzugefügt werden. Diese sind nur im Xima® Formcycle-Designer sichtbar und erscheinen nicht im fertigen Formular.

Dieses Element hat keine zusätzlichen Einstellungen im Bereich Sonstiges.

Word-/PDF-Export

Standardmäßig ist das Widget so konfiguriert, dass es nicht im Word-/PDF-Export auftaucht. Es ist auch nicht sinnvoll, an dieser Einstellung etwas zu ändern, da das Element in einem exportierten Formular keine Funktion hat.

Mögliche CSS-Anpassungen

Um das Aussehen des Widgets zu individualisieren, können per CSS Anpassungen vorgenommen werden.

Zum Beispiel kann das standardmäßig Unterstreichen der Spracheauswahlen entfernent werden:

.XItem.XLanguageSwich {
text-decoration: none;
}

Die Farbe der aktiven Sprache kann wie folgt verändert werden:

.XItem.XLanguageSwich.XLanguageSwichActive {
color: red;
}