AEM 6.4 a atteint la fin de la prise en charge étendue et cette documentation n’est plus mise à jour. Pour plus d’informations, voir notre période de support technique. Rechercher les versions prises en charge here.
Vous pouvez utiliser l’API Form Bridge pour ouvrir un canal de communication entre les formulaires HTML5 XFA et vos applications. L’API Form Bridge fournit une API de connexion pour créer la connexion.
L’API de connexion accepte un gestionnaire en tant qu’argument. Une fois la connexion créée entre le formulaire HTML5 basé sur XFA et Form Bridge, la poignée est appelée.
Vous pouvez utiliser l’exemple de code suivant pour créer la connexion.
// Example showing how to connect to FormBridge
window.addEventListener("FormBridgeInitialized",
function(event) {
var fb = event.detail.formBridge;
fb.connect(function() {
//use form bridge functions
})
})
Assurez-vous d’avoir créé la connexion avant d’ajouter le fichier formruntime.jsp.
getBridgeVersion()
Renvoie le numéro de version de la bibliothèque de script
isConnected() : permet de vérifier que l’état du formulaire a été initialisé.
Input : aucune
Output : valeur true si l’état du formulaire XFA a été initialisé.
Errors : aucune
connect(handler, context) : se connecte à FormBridge et exécute la fonction une fois la connexion établie et l’état du formulaire initialisé.
Entrée:
Sortie: Aucun
Erreur: Aucun
getDataXML(options) : renvoie les données actuelles du formulaire au format XML.
Entrée:
options : objet JavaScript contenant les propriétés suivantes :
Output : aucune
Error : aucune
registerConfig(configName, config) : enregistre les configurations propres à l’utilisateur/au portail avec FormBridge. Ces configurations remplacent les configurations par défaut. Les configurations prises en charge sont spécifiées dans la section config .
Entrée:
configName : nom de la configuration à remplacer.
widgetConfig : permet à l’utilisateur de remplacer les widgets par défaut par des widgets personnalisés, dans le formulaire. La configuration est remplacée comme suit :
formBridge.registerConfig("widgetConfig":{/*configuration*/})
pagingConfig : permet à l’utilisateur de remplacer le comportement par défaut du rendu de la première page uniquement. La configuration est remplacée comme suit :
window.formBridge.registerConfig("pagingConfig":{pagingDisabled: <true | false>, shrinkPageDisabled: <true | false> }).
LoggingConfig : permet à l’utilisateur de remplacer le niveau de journalisation, de désactiver la journalisation d’une catégorie ou d’afficher ou non la console de journaux ou l’envoi au serveur. La configuration peut être remplacée comme suit :
formBridge.registerConfig{
"LoggerConfig" : {
{
"on":`<true *| *false>`,
"category":`<array of categories>`,
"level":`<level of categories>`, "
type":`<"console"/"server"/"both">`
}
}
SubmitServiceProxyConfig : permet aux utilisateurs d’enregistrer les soumissions et les services proxy de journal.
window.formBridge.registerConfig("submitServiceProxyConfig",
{
"submitServiceProxy" : "`<submitServiceProxy>`",
"logServiceProxy": "`<logServiceProxy>`",
"submitUrl" : "`<submitUrl>`"
});
config : valeur de la configuration
Output : objet contenant la valeur d’origine de la configuration dans la propriété data.
Error : aucune
hideFields(fieldArray) : masque les champs dont les expressions SOM sont fournies dans le tableau fieldArray. Définit la propriété presence des champs spécifiés sur invisible
Entrée:
Output : aucune
Error : aucune
showFields(fieldArray) : affiche les champs dont les expressions Som sont fournies dans le tableau fieldArray. Définit la propriété presence des champs fournis sur visible
Entrée:
Output : aucune
Error : aucune
hideSubmitButtons() : masque tous les boutons d’envoi dans le formulaire.
getFormState() : renvoie le JSON représentant l’état du formulaire.
Input : aucune
Output : objet contenant le JSON représentant l’état actuel du formulaire dans la propriété data.
Error : aucune
restoreFormState(options) : restaure l’état du formulaire à partir de l’état JSON fourni dans l’objet options. L’état est appliqué et les gestionnaires de succès ou d’erreur sont appelés une fois l’opération terminée.
Entrée:
Options : objet JavaScript contenant les propriétés suivantes :
Output : aucune
Error : aucune
setFocus (som) : met le focus sur le champ spécifié dans l’expression Som.
setFieldValue (som, value) : définit la valeur des champs pour les expressions SOM données.
Entrée:
Output : aucune
Error : renvoie une exception si une expression SOM est incorrecte.
getFieldValue (som) : renvoie la valeur des champs des expressions SOM données.
Input : tableau contenant les expressions SOM des champs dont la valeur doit être récupérée.
Output : objet contenant le résultat sous forme de tableau dans la propriété data.
Error : aucune
var a = formBridge.getFieldValue(“xfa.form.form1.Subform1.TextField”);
if(a.errors) {
var err;
while((err = a.getNextMessage()) != null)
alert(a.message)
} else {
alert(a.data[0])
}
getFieldProperties(som, property) : permet de récupérer la liste des valeurs de la propriété donnée des champs spécifiés par les expressions SOM.
Entrée:
Sortie : Objet contenant le résultat sous forme de tableau dans *data *property
Error : aucune
setFieldProperties(som, property, values) : permet de définir la valeur de la propriété donnée pour tous les champs spécifiés par les expressions SOM.
Entrée:
Output : aucune
Error : aucune
// Example 1: FormBridge.restoreFormState
function loadFormState() {
var suc = function(obj) {
//success
}
var err = function(obj) {
while(var t = obj.getNextMessage()) {
$("#errorDiv").append("<div>"+t.message+"</div>");
}
}
var _formState = // load form state from storage
formBridge.restoreFormState({success:suc,error:err,formState:_formState}); // not passing a context means that this will be formBridge itself. Validation errors will be checked.
}
//--------------------------------------------------------------------------------------------------
//Example 2: FormBridge.submitForm
function SubmitForm() {
var suc = function(obj) {
var data = obj.data;
// submit the data to a url;
}
var err = function(obj) {
while(var t = obj.getNextMessage()) {
$("#errorDiv").append("<div>"+t.message+"</div>");
}
}
formBridge.submitForm({success:suc,error:err}); // not passing a context means that this will be formBridge itself. Validation errors will be checked.
}