Creare un aspetto personalizzato per i campi modulo adattivo

Introduzione

I moduli adattivi sfruttano il framework di aspetto per creare aspetto personalizzato per i campi dei moduli adattivi e fornire un’esperienza utente diversa. Ad esempio, sostituisci i pulsanti di scelta e le caselle di controllo con i pulsanti di attivazione o utilizza i plug-in jQuery personalizzati per limitare gli input degli utenti in campi come numeri di telefono o ID e-mail.

Questo documento spiega come utilizzare un plug-in jQuery per creare queste esperienze alternative per i campi del modulo adattivo. Inoltre, mostra un esempio per creare un aspetto personalizzato per l’aspetto che il componente campo numerico deve avere come passo o cursore numerico.

Analizziamo innanzitutto i termini e i concetti chiave utilizzati in questo articolo.

​AppearanceSi riferisce allo stile, all’aspetto e all’organizzazione di vari elementi di un campo modulo adattivo. In genere include un’etichetta, un’area interattiva per fornire gli input, un’icona della guida e descrizioni brevi e lunghe del campo. La personalizzazione dell'aspetto di cui al presente articolo è applicabile per l'aspetto dell'area di input del campo.

jQuery pluginFornisce un meccanismo standard, basato sul framework dei widget jQuery, per implementare un aspetto alternativo.

​ClientLibUn sistema di librerie lato client AEM elaborazione lato client basato su codice JavaScript e CSS complessi. Per ulteriori informazioni, vedere Uso delle librerie lato client.

​ArchetypeUn toolkit per modelli di progetto Maven definito come modello o modello originale per i progetti Maven. Per ulteriori informazioni, vedere Introduzione agli Archetipi.

User ControlFa riferimento all'elemento principale di un widget che contiene il valore del campo e viene utilizzato dal framework di aspetto per collegare l'interfaccia utente dei widget personalizzati con il modello di modulo adattivo.

Passaggi per creare un aspetto personalizzato

I passaggi da seguire per creare un aspetto personalizzato sono i seguenti:

  1. Crea un progetto: Crea un progetto Maven che genera un pacchetto di contenuti da distribuire in AEM.

  2. Estendi una classe di widget esistente: Estendi una classe di widget esistente e sovrascrivi le classi richieste.

  3. Creare una libreria client: Crea una clientLib: af.customwidget libreria e aggiungi i file JavaScript e CSS richiesti.

  4. Crea e installa il progetto: Crea il progetto Maven e installa il pacchetto di contenuti generato su AEM.

  5. Aggiorna il modulo adattivo: Aggiornare le proprietà dei campi del modulo adattivo per utilizzare l’aspetto personalizzato.

Creare un progetto

Un archetipo maven è un punto di partenza per la creazione di un aspetto personalizzato. I dettagli dell'archetipo da utilizzare sono i seguenti:

  • Archivio: https://repo1.maven.org/maven2/com/adobe/
  • Id Artifact: custom-Appe-Archetype
  • ID gruppo: com.adobe.aemforms
  • Versione: 1.0.4

Esegui il comando seguente per creare un progetto locale basato sull'archetipo:

mvn archetype:generate -DarchetypeRepository=https://repo1.maven.org/maven2/com/adobe/ -DarchetypeGroupId=com.adobe.aemforms -DarchetypeArtifactId=custom-appearance-archetype -DarchetypeVersion=1.0.4

Il comando scarica i plug-in Maven e le informazioni sull’archetipo dall’archivio e genera un progetto basato sulle seguenti informazioni:

  • groupId: ID gruppo utilizzato dal progetto Maven generato
  • artifactId: ID artefatto utilizzato dal progetto Maven generato.
  • versione: Versione per il progetto Maven generato.
  • pacchetto: Pacchetto utilizzato per la struttura del file.
  • artifactName: Nome dell'artefatto del pacchetto AEM generato.
  • packageGroup: Gruppo di pacchetti del pacchetto AEM generato.
  • widgetName: Nome dell'aspetto utilizzato come riferimento.

La struttura del progetto generato è la seguente:

─<artifactId>

 └───src

     └───main

         └───content

             └───jcr_root

                 └───etc

                     └───clientlibs

                         └───custom

                             └───<widgetName>

                                 ├───common [client library - af.customwidgets which encapsulates below clientLibs]

                                 ├───integration [client library - af.customwidgets.<widgetName>_widget which contains template files for integrating a third-party plugin with Adaptive Forms]

                                 │   ├───css

                                 │   └───javascript

                                 └───jqueryplugin [client library - af.customwidgets.<widgetName>_plugin which holds the third-party plugins and related dependencies]

                                     ├───css

                                     └───javascript

Estendere una classe di widget esistente

Una volta creato il modello di progetto, apporta le seguenti modifiche, a seconda delle necessità:

  1. Includi la dipendenza del plug-in di terze parti nel progetto.

    1. Posiziona i plug-in jQuery di terze parti o personalizzati nella cartella jqueryplugin/javascript e i file CSS correlati nella cartella jqueryplugin/css . Per ulteriori dettagli, consulta i file JS e CSS nella cartella jqueryplugin/javascript and jqueryplugin/css .

    2. Modifica i file js.txt e css.txt in modo da includere eventuali file JavaScript e CSS aggiuntivi del plug-in jQuery.

  2. Integra il plug-in di terze parti con il framework per abilitare l’interazione tra il framework di aspetto personalizzato e il plug-in jQuery. Il nuovo widget funzionerà solo dopo aver esteso o sostituito le seguenti funzioni.

Funzione Descrizione
render La funzione di rendering restituisce l'oggetto jQuery per l'elemento HTML predefinito del widget. L’elemento HTML predefinito deve essere di tipo focalizzabile. Ad esempio, <a>, <input> e <li>. L’elemento restituito viene utilizzato come $userControl. Se il $userControl specifica il vincolo di cui sopra, le funzioni della classe AbstractWidget funzionano come previsto, altrimenti alcune delle API comuni (attivazione, clic) richiedono modifiche.
getEventMap Restituisce una mappa per convertire gli eventi HTML in eventi XFA.
{ blur: XFA_EXIT_EVENT, }
Questo esempio mostra che blur è un evento HTML ed XFA_EXIT_EVENT è l’evento XFA corrispondente.
getOptionsMap Restituisce una mappa che fornisce dettagli sull'azione da eseguire in caso di modifica di un'opzione. Le chiavi sono le opzioni fornite al widget e i valori sono funzioni che vengono chiamate ogni volta che viene rilevata una modifica nell'opzione. Il widget fornisce gestori per tutte le opzioni comuni (ad eccezione di value e displayValue).
getCommitValue Il framework dei widget jQuery carica la funzione ogni volta che il valore del widget jQuery viene salvato nel modello XFA (ad esempio, in caso di uscita da un campo di testo). L'implementazione deve restituire il valore salvato nel widget. Al gestore viene fornito il nuovo valore per l’opzione .
showValue Per impostazione predefinita, in XFA all’evento enter viene visualizzato il valore rawValue del campo. Questa funzione viene chiamata per mostrare l’ rawValue all’utente.
showDisplayValue Per impostazione predefinita, in XFA all'evento di uscita viene visualizzato il simbolo formattedValue del campo . Questa funzione viene chiamata per mostrare l’ formattedValue all’utente.
  1. Se necessario, aggiorna il file JavaScript nella cartella integration/javascript .

    • Sostituisci il testo __widgetName__ con il nome effettivo del widget.

    • Estendi il widget da una classe di widget preconfigurata adatta. Nella maggior parte dei casi, si tratta della classe di widget corrispondente al widget esistente che viene sostituito. Il nome della classe padre viene utilizzato in più posizioni, pertanto si consiglia di cercare tutte le istanze della stringa xfaWidget.textField nel file e sostituirle con la classe padre effettiva utilizzata.

    • Estendi il metodo render per fornire un’interfaccia utente alternativa. È la posizione da cui verrà richiamato il plug-in jQuery per aggiornare l’interfaccia utente o il comportamento di interazione. Il metodo render deve restituire un elemento di controllo utente.

    • Estendi il metodo getOptionsMap per sostituire qualsiasi impostazione di opzione interessata a causa di una modifica nel widget. La funzione restituisce una mappatura che fornisce dettagli sull'azione da eseguire in caso di modifica di un'opzione. Le chiavi sono le opzioni fornite al widget e i valori sono le funzioni chiamate ogni volta che viene rilevata una modifica nell'opzione.

    • Il metodo getEventMap mappa gli eventi attivati dal widget, con gli eventi richiesti dal modello di modulo adattivo. Il valore predefinito mappa gli eventi HTML standard per il widget predefinito e deve essere aggiornato se viene attivato un evento alternativo.

    • I valori showDisplayValue e showValue applicano la clausola di visualizzazione e modifica dell'immagine e possono essere ignorati per avere un comportamento alternativo.

    • Il metodo getCommitValue viene chiamato dal framework dei moduli adattivi quando si verifica l'evento commit. In genere si tratta dell’evento exit , ad eccezione degli elementi a discesa, pulsante di scelta e casella di controllo in cui si verifica al momento della modifica). Per ulteriori informazioni, consulta Espressioni Forms adattive.

    • Il file modello fornisce un esempio di implementazione per vari metodi. Rimuovere i metodi da non estendere.

Creare una libreria client

Il progetto di esempio generato dall’archetipo Maven crea automaticamente le librerie client richieste e le racchiude in una libreria client con una categoria af.customwidgets. I file JavaScript e CSS disponibili in af.customwidgets vengono inclusi automaticamente in fase di runtime.

Creare e installare

Per creare il progetto, esegui il seguente comando sulla shell per generare un pacchetto CRX che deve essere installato sul server AEM.

mvn clean install

NOTA

Il progetto maven si riferisce a un archivio remoto all’interno del file POM. Questo è solo a scopo di riferimento e, secondo gli standard Maven, le informazioni dell’archivio vengono acquisite nel file settings.xml.

Aggiornare il modulo adattivo

Per applicare l’aspetto personalizzato a un campo modulo adattivo:

  1. Apri il modulo adattivo in modalità di modifica.
  2. Apri la finestra di dialogo Proprietà per il campo in cui desideri applicare l’aspetto personalizzato.
  3. Nella scheda Stile , aggiorna la proprietà CSS class per aggiungere il nome dell’aspetto nel formato widget_<widgetName>. Ad esempio: widget_numericstepper

Esempio: Creare un aspetto personalizzato  

Vediamo ora un esempio per creare un aspetto personalizzato in modo che un campo numerico venga visualizzato come un passo o un cursore numerico. Esegui i seguenti passaggi:

  1. Esegui il comando seguente per creare un progetto locale basato su archetipo Maven:

    mvn archetype:generate -DarchetypeRepository=https://repo1.maven.org/maven2/com/adobe/ -DarchetypeGroupId=com.adobe.aemforms -DarchetypeArtifactId=custom-appearance-archetype -DarchetypeVersion=1.0.4

    Viene richiesto di specificare i valori per i seguenti parametri.
    I valori utilizzati in questo esempio sono in grassetto.

    Define value for property 'groupId': com.adobe.afwidgets

    Define value for property 'artifactId': customWidgets

    Define value for property 'version': 1.0.1-SNAPSHOT

    Define value for property 'package': com.adobe.afwidgets

    Define value for property 'artifactName': customWidgets

    Define value for property 'packageGroup': adobe/customWidgets

    Define value for property 'widgetName': numericStepper

  2. Passa alla directory customWidgets (valore specificato per la proprietà artifactID ) ed esegui il comando seguente per generare un progetto Eclipse:

    mvn eclipse:eclipse

  3. Apri lo strumento Eclipse ed effettua le seguenti operazioni per importare il progetto Eclipse:

    1. Seleziona File > Importa > Progetti esistenti in Workspace.

    2. Sfoglia e seleziona la cartella in cui è stato eseguito il comando archetype:generate.

    3. Fare clic su Fine.

      eclipse-screenshot

  4. Seleziona il widget da utilizzare per l'aspetto personalizzato. Questo esempio utilizza il seguente widget passo numerico:

    https://www.jqueryscript.net/form/User-Friendly-Number-Input-Spinner-with-jQuery-Bootstrap.html

    Nel progetto Eclipse, controlla il codice plug-in nel file plugin.js per assicurarti che corrisponda ai requisiti per l’aspetto. In questo esempio, l'aspetto soddisfa i seguenti requisiti:

    • Il passo numerico deve estendersi da - $.xfaWidget.numericInput.

    • Il metodo set value del widget imposta il valore dopo che lo stato attivo è sul campo. È un requisito obbligatorio per un widget modulo adattivo.

    • Per richiamare il metodo bootstrapNumber è necessario ignorare il metodo render.

    • Non esiste alcuna dipendenza aggiuntiva per il plug-in che non sia il codice sorgente principale del plug-in.

    • L’esempio non esegue alcuno stile sullo stepper, pertanto non è necessario alcun CSS aggiuntivo.

    • L'oggetto $userControl deve essere disponibile per il metodo render . Si tratta di un campo del tipo text che viene clonato con il codice del plug-in.

    • I pulsanti + e - devono essere disattivati quando il campo è disabilitato.

  5. Sostituisci il contenuto del bootstrap-number-input.js (plugin jQuery) con il contenuto del file numericStepper-plugin.js.

  6. Nel file numericStepper-widget.js, aggiungi il seguente codice per sostituire il metodo di rendering per richiamare il plug-in e restituire l'oggetto $userControl :

    render : function() {
         var control = $.xfaWidget.numericInput.prototype.render.apply(this, arguments);
         var $control = $(control);
         var controlObject;
         try{
             if($control){
             $control.bootstrapNumber();
             var id = $control.attr("id");
             controlObject = $("#"+id);
             }
         }catch (exc){
              console.log(exc);
         }
         return controlObject;
    }
    
  7. Nel file numericStepper-widget.js , sovrascrivi la proprietà getOptionsMap per ignorare l’opzione di accesso e nascondi i pulsanti + e - in modalità disabilitata.

    getOptionsMap: function(){
        var parentOptionsMap = $.xfaWidget.numericInput.prototype.getOptionsMap.apply(this,arguments),
    
        newMap = $.extend({},parentOptionsMap,
    
         {
    
               "access": function(val) {
               switch(val) {
                  case "open" :
                    this.$userControl.removeAttr("readOnly");
                    this.$userControl.removeAttr("aria-readonly");
                    this.$userControl.removeAttr("disabled");
                    this.$userControl.removeAttr("aria-disabled");
                    this.$userControl.parent().find(".input-group-btn button").prop('disabled',false);
                    break;
                  case "nonInteractive" :
                  case "protected" :
                    this.$userControl.attr("disabled", "disabled");
                    this.$userControl.attr("aria-disabled", "true");
                    this.$userControl.parent().find(".input-group-btn button").prop('disabled',true);
                    break;
                 case "readOnly" :
                    this.$userControl.attr("readOnly", "readOnly");
                    this.$userControl.attr("aria-readonly", "true");
                    this.$userControl.parent().find(".input-group-btn button").prop('disabled',true);
                    break;
                default :
                    this.$userControl.removeAttr("disabled");
                    this.$userControl.removeAttr("aria-disabled");
                    this.$userControl.parent().find(".input-group-btn button").prop('disabled',false);
                    break;
              }
           },
       });
       return newMap;
     }
    
  8. Salva le modifiche, accedi alla cartella contenente il file pom.xml ed esegui il seguente comando Maven per creare il progetto:

    mvn clean install

  9. Installa il pacchetto utilizzando AEM Gestione pacchetti.

  10. Apri il modulo adattivo in modalità di modifica in cui desideri applicare l’aspetto personalizzato ed effettua le seguenti operazioni:

    1. Fare clic con il pulsante destro del mouse sul campo in cui si desidera applicare l'aspetto e fare clic su Modifica per aprire la finestra di dialogo Modifica componente.

    2. Nella scheda Stile , aggiorna la proprietà Classe CSS per aggiungere widget_numericStepper.

Il nuovo aspetto appena creato è ora disponibile per l’uso.

In questa pagina