Plugin-Dokumentation - WidgetXratingPlugin 

Page / - zuletzt bearbeitet von gru am 12.10.2020, 10:15 

WidgetXratingPlugin 
zuletzt bearbeitet von gru
am 12.10.2020, 10:15

Inhaltsverzeichnis
Funktionsbeschreibung
Installation
Konfiguration
Grundeigenschaften
Label
Optionen
Bedingungen
Hilfe
CSS-Klassen
Attribute
Verfügbar wenn
Sonstiges
Druckbild im Word-/PDF-Export
Mögliche CSS-Anpassungen

Plugin-Download
Inhalt [ Verbergen ] 
•	Funktionsbeschreibung
•	Installation
•	Konfiguration
•	Optionen
•	Druckbild im Word-/PDF-Export
•	Mögliche CSS-Anpassungen
 Das Symbol für Widgets vom Typ Bewertung. 
Funktionsbeschreibung
 
Beispiel für ein Bewertungswidget mit Sternen in einem Formular.
Das Plugin stellt ein neues Widget im Designer zur Verfügung, welches es erlaubt, auf einfache Art Bewertungen einzugeben. Das Widget erzeugt eine Kette von links nach rechts anwählbarer Icons entsprechend der im Designer getroffenen Einstellungen bezüglich Iconform, Iconanzahl und Farbe. Die durch das Widget je nach Anzahl der ausgewählten Icons zu übermittelnden Werte können konfiguriert werden. 
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.

Label
Basiseinstellungen für Label 
Über diese Eigenschaft wird das Label eines Elements definiert. Ein Label ist der Text vor, hinter, über oder unter dem Element. Nicht jedes Element besitzt diese Eigenschaft.
 
Bei dem Label kann der Text verändert werden, der an einem Formularfeld erläuternd angezeigt wird.
Name	Beschreibung	
Wert	Wert des Label. Dieser Text wird dann am Element angezeigt.	
Ausrichtung	 Gibt die Position (link, rechts, oben, unten) des Labels an.	
Breite (in px)	Dies ist der Abstand zwischen Labeltext und Element und ist nur für die Ausrichtung "links" relevant.	
Platzhalter	Platzhaltertext für Eingabefelder. Dieser Text verschwindet wenn ein Wert in das Feld eingegeben wird.	
Titel	 Wird beim überfahren des Elements mit der Maus als Tooltip angezeigt (HTML Attribut "title").	
Einheit	Text der hinter einem Element angezeigt wird. Normalerweise wird dies für Einheiten (z.B. EURO) verwendet.	
Breite (in px)	Abstand (rechts) der Einheit vom Element	
Dieses Element hat keine zusätzlichen Einstellungen im Bereich Label.
Optionen
 
Mögliche Konfiguration der zu verwendenen Auswahloptionen eines Bewertungswidgets.
Bewertungswidgets verfügen über einen zusätzlichen Bereich Optionen. Hier können die zu verwendenden Auswahloptionen und die bei der Auswahl einer Option jeweils als Formularwert zu übertragenden Inhalte konfiguriert 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.

Bedingungen
Basiseinstellungen für Bedingungen 
Über die Bedingungen werden Validierungen und Sichtbarkeiten für die Formularelemente festgelegt. Einige Bedingungen sind nur für manche Formularelemente verfügbar, diese sind auch noch einmal in der Hilfe zu den einzelnen Elementen beschrieben.
Steuerbare Eigenschaften
 
In den Bedingungen können Elemente etwa versteckt oder als Mussfelder geschaltet werden, wenn bestimmte Bedingungen erfüllt sind. Zudem kann über den Elementwähler ein Formularelement direkt mit der Maus ausgewählt werden.
Name	Beschreibung	
Versteckt wenn	Wenn die Bedingung erfüllt ist, wird das Formularelement versteckt.	
Sichtbar wenn	Wenn die Bedingung erfüllt ist, wird das Formularelement angezeigt. Diese Option erscheint, wenn das Formularfeld auf versteckt geschalten wurde.	
Gesperrt wenn	Wenn die Bedingung erfüllt ist, wird das Formularelement nicht-editierbar geschaltet.	
Editierbar wenn	Wenn die Bedingung erfüllt ist, wird das Formularelement wieder editierbar geschaltet. Diese Option erscheint, wenn das Formularfeld auf gesperrt geschalten wurde.	
Mussfeld	Ist diese Option aktiviert, muss das Formularfeld zwingend ausgefüllt werden. Wenn diese Option aktiviert ist, werden unter Mussfeld wenn konfigurierte Bedingung ignoriert.	
Mussfeld wenn	Wenn die Bedingung erfüllt ist, wird das Formularelement zu einem Mussfeld.	
Mussfeldgruppe	Nur verfügbar, wenn Mussfeld ausgewählt ist. Legt die Mussfeldgruppe fest, zu der das Element gehören soll. Wenn zwei oder mehr Elemente zu einer Mussfeldgruppe gehören, muss mindestens eines davon einen Wert haben, alle anderen müssen aber nicht ausgefüllt werden.	
Prüfe serverseitig	Wenn diese Option aktiviert ist, werden die abgesendeten Daten auch auf dem Server geprüft. Die Daten werden im Browser geprüft, dennoch ist es technisch möglich, ungültige Formulare abzusenden. Schlägt die serverseitige Validierung fehl, erscheint im Formular die entsprechende Fehlermeldung.	
Bedingungen
 
Bei Bedingungen, die auf den Wert eines Auswahlelements zugreifen, wird der Wert genommen, wie er in der Spalte Werte eingetragen ist.
Bei allen Eigenschaften kann für die Bedingung ein Formularelement ausgewählt werden, welches dann geprüft wird.
In der Auswahlliste stehen alle Elemente Namen zur Verfügung. Nach der Auswahl eines Elements öffnet sich eine weitere Auswahlliste mit folgenden Optionen:
•	einen Wert hat
•	keinen Wert hat
•	gleich
•	ungleich
•	kleiner
•	kleiner gleich
•	größer
•	größer gleich
•	zwischen
•	regulärer Ausdruck
Durch Klick auf das Auswahlsymbol rechts neben der Auswahlleiste kann mit der Maus direkt ein Formularelement ausgewählt werden. Bei großen Formularen kann die Auswahlliste sehr lang werden und man findet das gesuchte Elemente nur langsam.
Wird der Wert eines Auswahlelements (Checkbox, Radiobutton oder Liste) geprüft, wird von der ausgewählten Option der Wert für die Prüfung verwendet, der am Formularelement in den Eigenschaften unter Werte in der Spalte Wert eingestellt ist. 
Bedingung	Beschreibung	
einen Wert hat / keinen Wert hat 	Das Element wird versteckt, wenn das ausgewählte Element einen (keinen) Wert hat.
Einen Wert haben bedeutet dabei folgendes.
•	Bei einer Checkbox wird das Element versteckt, wenn sie aktiviert wurde.
•	Bei einem Auswahlelement wird das Element versteckt, wenn ein anderer Wert als Bitte auswählen gewählt wurde. Ist eine als Drop-Down-Auswahlliste dargestellte Auswahl kein Mussfeld, ist standardmäßig immer die erste Option ausgewählt. Handelt es sich bei der Drop-Down-Auswahlliste um ein Mussfeld, ist standardmäßig keine Option ausgewählt und es erscheint der Text Bitte auswählen.
•	Bei einem Textfeld wird das Element versteckt, wenn das Eingabefeld nicht leer ist.	
gleich	Es erscheint ein weiteres Eingabefeld zur Eingabe des zu prüfenden Wertes. Das Element wird nur versteckt, wenn der Wert des ausgewählten Elements den gleichen Wert hat.	
ungleich	Es erscheint ein weiteres Eingabefeld zur Eingabe des zu prüfenden Wertes. Das Element wird nur versteckt, wenn der Wert des ausgewählten Elements nicht den gleichen Wert hat.	
kleiner / kleiner gleich	Es erscheint ein weiteres Eingabefeld zur Eingabe des zu prüfenden Wertes. Das Element wird nur versteckt, wenn der Wert des ausgewählten Elements kleiner bzw. kleiner gleich dem eingegebenen Wert ist.	
größer / größer gleich	Es erscheint ein weiteres Eingabefeld zur Eingabe des zu prüfenden Wertes. Das Element wird nur versteckt, wenn der Wert des ausgewählten Elements größer bzw. größer gleich dem eingegebenen Wert ist.	
zwischen	Es erscheint ein weiteres Eingabefeld zur Eingabe des zu prüfenden Wertes. Das Element wird nur versteckt, wenn der Wert des ausgewählten Elements zwischen dem eingegebenen Wert ist. Das Interval wird als zwei mit einem Strich (-) getrennte Zahlen eingegeben, z.B. 2-10. Negative Zahlen müssen in Klammern gesetzt werden, z.B. (-10)-(-5).	
regulärer Ausdruck	Es erscheint ein weiteres Eingabefeld zur Eingabe des regulären Ausdruck. Das Element wird nur versteckt, wenn der Wert des ausgewählten Elements auf den regulären Ausdruck passt. Zu beachten ist, dass hier ausschließlich der Reguläre Ausdruck eingetragen werden muss. Das bedeutet, dass zum Beispiel der Ausdruck nicht von / umschlossen wird, wie in manchen Notation üblich ist. Für eine Prüfung auf exakt 7 Ziffern müsste also nur ^\d{7}$ verwendet werden.	
Automatisch leeren oder zurücksetzen
Bei den Eigenschaften Versteckt wenn und Gesperrt wenn kann zusätzlich noch ausgewählt werden, ob das Formularelement geleert oder zurückgesetzt (reset) werden soll, wenn es durch die Bedingung versteckt beziehungsweise gesperrt wird. Leeren bezieht sich dabei auf das Löschen des Werts. Beim Zurücksetzen wird der Wert des Formularelements auf den ursprünglichen Wert zurückgesetzt, den es beim Öffnen des Formulars hatte. Wird das Formular neu geöffnet, ist das der Wert, wie er im Xima® Formcycle-Designer eingestellt ist. Wird ein abgesendetes Formular im Posteingang geöffnet, ist der Initialwert der zuletzt abgesendete Wert.
Dies kann zum Beispiel für die Eingabe einer Adresse verwendet werden, wo zwischen einer Adresse und einem Postfach ausgewählt werden kann. Ist Postfach ausgewählt, dann ist das Eingabefeld für die Adresse nicht sichtbar und wird geleert. Beim Absenden des Formulars werden so nur die Postfachdaten und nicht die Adressdaten mitgesendet.
Beim Leeren oder Zurücksetzen von Formularelementen, die andere Formularelemente enthalten, werden alle Unterelemente geleert oder zurückgesetzt. Dies betrifft die Elemente Seite, Container, und Fieldset.
Dieses Element hat keine zusätzlichen Einstellungen im Bereich Bedingungen.

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.
Druckbild im Word-/PDF-Export
 
Darstellung eines Bewertungswidgets im Word-/PDF-Export.
Wenn das Formular per Word-/PDF-Export exportiert wird, wird in den erzeugten Dokumenten anstelle des konfigurierten Aussehens eine Auswahl mit den unter Optionen konfigurierten Auswahloptionen erstellt.
Mögliche CSS-Anpassungen
Um Icons oder Farben individuell zu setzen, können per CSS Anpassungen vorgenommen werden. 
Zum Beispiel das verwendete Logo für das Dritte Icon des Widgets mit dem technischen Namen rate1 setzen:
[xn=rate1] .idx3 I::before{
   content: "\e906";
}
Die Farbe für das 6. Icon des Widgets mit dem technischen Namen rate2 setzen, wenn es aktiv ist oder sich der Mauszeiger über diesem Logo befindet:
[xn=rate2] .idx6.hover I,
[xn=rate2] .idx6.active I{
   color: #55C937;
}