Criar aparências personalizadas para campos de formulário adaptáveis

Introdução

Os formulários adaptáveis usam a estrutura de aparência para ajudar você a criar aparências personalizadas para campos de formulários adaptáveis e fornecer uma experiência de usuário diferente. Por exemplo, substitua botões de opção e caixas de seleção por botões de alternância ou use plug-ins jQuery personalizados para restringir as entradas de usuários em campos como números de telefone ou ID de email.

Este documento explica como usar um plug-in jQuery para criar essas experiências alternativas para campos de formulário adaptáveis. Além disso, mostra um exemplo para criar uma aparência personalizada para que o componente de campo numérico apareça como um passo ou controle deslizante numérico.

Vamos primeiro analisar os termos e conceitos principais usados neste artigo.

​AparênciaRefere-se ao estilo, aparência e comportamento e à organização de vários elementos de um campo de formulário adaptável. Geralmente inclui um rótulo, uma área interativa para fornecer entradas, um ícone de ajuda e descrições curtas e longas do campo. A personalização da aparência discutida neste artigo é aplicável para a aparência da área de entrada do campo.

jQuery pluginFornece um mecanismo padrão, com base na estrutura do widget jQuery, para implementar uma aparência alternativa.

​ClientLibUm sistema de bibliotecas do lado do cliente em AEM processamento do lado do cliente impulsionado por códigos JavaScript e CSS complexos. Para obter mais informações, consulte Usar bibliotecas do lado do cliente.

​ArchetypeUm kit de ferramentas de modelo de projeto Maven definido como um padrão ou modelo original para projetos Maven. Para obter mais informações, consulte Introdução aos arquétipos.

​Controle de usuário: refere-se ao elemento principal em um widget que contém o valor do campo e é usado pela estrutura de aparência para vincular a interface do usuário de widget personalizada ao modelo de formulário adaptável.

Etapas para criar uma aparência personalizada

As etapas, em um alto nível, para criar uma aparência personalizada são as seguintes:

  1. Criar um projeto: Crie um projeto Maven que gera um pacote de conteúdo para implantar no AEM.

  2. Estender uma classe de widget existente: Estender uma classe de widget existente e substituir as classes necessárias.

  3. Criar uma biblioteca do cliente: Crie uma clientLib: af.customwidget biblioteca e adicione os arquivos JavaScript e CSS necessários.

  4. Crie e instale o projeto: Crie o projeto Maven e instale o pacote de conteúdo gerado no AEM.

  5. Atualize o formulário adaptável: Atualize as propriedades dos campos de formulário adaptáveis para usar a aparência personalizada.

Criar um projeto

Um arquétipo maven é um ponto de partida para a criação de uma aparência personalizada. Os detalhes do arquétipo a ser usado são os seguintes:

  • Repositório: https://repo1.maven.org/maven2/com/adobe/
  • Id Do Artefato: custom-appearance-archetype
  • ID do grupo: com.adobe.aemforms
  • Versão: 1.0.4

Execute o seguinte comando para criar um projeto local com base no arquétipo:

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

O comando baixa os plug-ins e as informações do arquétipo do Maven do repositório e gera um projeto com base nas seguintes informações:

  • groupId: ID de grupo usada pelo projeto Maven gerado
  • artifactId: ID de artefato usada pelo projeto Maven gerado.
  • versão: Versão do projeto Maven gerado.
  • pacote: Pacote usado para a estrutura do arquivo.
  • artifactName: Nome do artefato do pacote de AEM gerado.
  • packageGroup: Grupo de pacotes do pacote de AEM gerado.
  • widgetName: Nome de aparência usado para referência.

O projeto gerado tem a seguinte estrutura:

─<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

Estender uma classe de widget existente

Depois que o modelo do projeto for criado, faça as seguintes alterações, conforme necessário:

  1. Inclua a dependência de plug-in de terceiros no projeto.

    1. Coloque os plug-ins jQuery de terceiros ou personalizados na pasta jqueryplugin/javascript e os arquivos CSS relacionados na pasta jqueryplugin/css. Para obter mais detalhes, consulte os arquivos JS e CSS na pasta jqueryplugin/javascript and jqueryplugin/css .

    2. Modifique os arquivos js.txt e css.txt para incluir qualquer arquivo JavaScript e CSS adicional do plug-in jQuery.

  2. Integre o plug-in de terceiros à estrutura para permitir a interação entre a estrutura de aparência personalizada e o plug-in jQuery. O novo widget será funcional somente após estender ou substituir as seguintes funções.

Função Descrição
render A função de renderização retorna o objeto jQuery para o elemento HTML padrão do widget. O elemento HTML padrão deve ser do tipo focalizável. Por exemplo, <a>, <input> e <li>. O elemento retornado é usado como $userControl. Se $userControl especificar a restrição acima, as funções da classe AbstractWidget funcionam conforme esperado, caso contrário, algumas das APIs comuns (foco, clique) exigirão alterações.
getEventMap Retorna um mapa para converter eventos HTML em eventos XFA.
{ blur: XFA_EXIT_EVENT, }
Este exemplo mostra que blur é um evento HTML e XFA_EXIT_EVENT é o evento XFA correspondente.
getOptionsMap Retorna um mapa que fornece detalhes sobre a ação a ser executada na alteração de uma opção. As chaves são as opções fornecidas para o widget e os valores são funções que são chamadas sempre que uma alteração na opção é detectada. O widget fornece manipuladores para todas as opções comuns (exceto value e displayValue).
getCommitValue A estrutura do widget jQuery carrega a função sempre que o valor do widget jQuery é salvo no modelo XFA (por exemplo, no evento exit de um campo de texto). A implementação deve retornar o valor salvo no widget. O manipulador é fornecido com o novo valor para a opção .
showValue Por padrão, no XFA no evento enter , o rawValue do campo é exibido. Essa função é chamada para mostrar o rawValue para o usuário.
showDisplayValue Por padrão, no evento XFA on exit , o formattedValue do campo é exibido. Essa função é chamada para mostrar o formattedValue para o usuário.
  1. Atualize o arquivo JavaScript na pasta integration/javascript , conforme necessário.

    • Substitua o texto __widgetName__ pelo nome real do widget.

    • Estenda o widget a partir de uma classe de widget pronta para uso adequada. Na maioria dos casos, é a classe de widget correspondente ao widget existente que está sendo substituído. O nome da classe pai é usado em vários locais, portanto, é recomendável procurar todas as instâncias da cadeia de caracteres xfaWidget.textField no arquivo e substituí-las pela classe pai real usada.

    • Estenda o método render para fornecer uma interface de usuário alternativa. É o local de onde o plug-in jQuery será chamado para atualizar a interface do usuário ou o comportamento de interação. O método render deve retornar um elemento de controle de usuário.

    • Estenda o método getOptionsMap para substituir qualquer configuração de opção afetada devido a uma alteração no widget. A função retorna um mapeamento que fornece detalhes para a ação ser executada na alteração de uma opção. As chaves são as opções fornecidas para o widget e os valores são as funções chamadas sempre que uma alteração na opção é detectada.

    • O método getEventMap mapeia eventos acionados pelo widget, com os eventos exigidos pelo modelo de formulário adaptável. O valor padrão mapeia eventos HTML padrão para o widget padrão e precisa ser atualizado se um evento alternativo for acionado.

    • As showDisplayValue e showValue aplicam a cláusula de exibição e edição de imagem e podem ser substituídas para ter um comportamento alternativo.

    • O método getCommitValue é chamado pela estrutura de formulários adaptáveis quando o evento commitocorre. Geralmente, é o evento exit, exceto para os elementos suspensos, de botão de opção e de caixa de seleção, onde ocorre durante a mudança). Para obter mais informações, consulte Adaptive Forms Expressions.

    • O arquivo de modelo fornece a implementação de exemplo para vários métodos. Remova os métodos que não devem ser estendidos.

Criar uma biblioteca do cliente

O projeto de amostra gerado pelo arquétipo Maven cria automaticamente as bibliotecas do cliente necessárias e as envolve em uma biblioteca do cliente com uma categoria af.customwidgets. Os arquivos JavaScript e CSS disponíveis no af.customwidgets são incluídos automaticamente no tempo de execução.

Criar e instalar

Para criar o projeto, execute o seguinte comando no shell para gerar um pacote CRX que precise ser instalado no servidor AEM.

mvn clean install

OBSERVAÇÃO

O projeto maven se refere a um repositório remoto dentro do arquivo POM. Isso é apenas para fins de referência e, de acordo com os padrões Maven, as informações do repositório são capturadas no arquivo settings.xml.

Atualizar o formulário adaptável

Para aplicar a aparência personalizada a um campo de formulário adaptável:

  1. Abra o formulário adaptável no modo de edição.
  2. Abra a caixa de diálogo Propriedade do campo no qual deseja aplicar a aparência personalizada.
  3. Na guia Estilo, atualize a propriedade CSS class para adicionar o nome da aparência no formato widget_<widgetName>. Por exemplo: widget_numericstep

Exemplo: Criar uma aparência personalizada  

Agora vamos observar um exemplo para criar uma aparência personalizada para que um campo numérico apareça como um passo ou controle deslizante numérico. Execute as seguintes etapas:

  1. Execute o seguinte comando para criar um projeto local com base no arquétipo Maven:

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

    Ele solicita que você especifique valores para os seguintes parâmetros.
    Os valores usados nessa amostra são realçados em negrito.

    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. Navegue até o diretório customWidgets (valor especificado para a propriedade artifactID) e execute o seguinte comando para gerar um projeto Eclipse:

    mvn eclipse:eclipse

  3. Abra a ferramenta Eclipse e faça o seguinte para importar o projeto Eclipse:

    1. Selecione File > Import > Existing Projects into Workspace.

    2. Procure e selecione a pasta onde você executou o comando archetype:generate.

    3. Clique em Concluir.

      captura de tela do eclipse

  4. Selecione o widget a ser usado para a aparência personalizada. Este exemplo usa o seguinte widget de etapa numérica:

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

    No projeto Eclipse, revise o código do plug-in no arquivo plugin.js para garantir que ele corresponda aos requisitos para a aparência. Nesta amostra, a aparência cumpre os seguintes requisitos:

    • O passo numérico deve se estender de - $.xfaWidget.numericInput.

    • O método set value do widget define o valor após o foco estar no campo. É um requisito obrigatório para um widget de formulário adaptável.

    • O método render precisa ser substituído para chamar o método bootstrapNumber.

    • Não há dependência adicional para o plug-in que não seja o código-fonte principal do plug-in.

    • A amostra não executa nenhum estilo na etapa, portanto, nenhum CSS adicional é necessário.

    • O objeto $userControl deve estar disponível para o método render. É um campo do tipo text que é clonado com o código do plug-in.

    • Os botões + e - devem ser desativados quando o campo estiver desativado.

  5. Substitua o conteúdo do bootstrap-number-input.js (plug-in jQuery) pelo conteúdo do arquivo numericStepper-plugin.js.

  6. No arquivo numericStepper-widget.js , adicione o seguinte código para substituir o método de renderização para chamar o plug-in e retornar o objeto $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. No arquivo numericStepper-widget.js, substitua a propriedade getOptionsMap para substituir a opção de acesso e oculta os botões + e - no modo desativado.

    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. Salve as alterações, navegue até a pasta que contém o arquivo pom.xml e execute o seguinte comando Maven para criar o projeto:

    mvn clean install

  9. Instale o pacote usando o Gerenciador de pacotes AEM.

  10. Abra o formulário adaptável no modo de edição no qual deseja aplicar a aparência personalizada e faça o seguinte:

    1. Clique com o botão direito do mouse no campo no qual deseja aplicar a aparência e clique em Editar para abrir a caixa de diálogo Editar componente .

    2. Na guia Estilo , atualize a propriedade CSS class para adicionar widget_numericStepper.

A nova aparência que você acabou de criar está disponível para uso.

Nesta página