Criar aparências personalizadas para campos de formulário adaptáveis
ATENÇÃO
AEM 6.4 chegou ao fim do suporte estendido e esta documentação não é mais atualizada. Para obter mais detalhes, consulte nossa períodos de assistência técnica. Encontre as versões compatíveis here.
Introdução
Os formulários adaptáveis usam o estrutura de aparência para ajudá-lo a criar aparências personalizadas para campos de formulário 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ência Refere-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.
Plug-in do jQuery Fornece um mecanismo padrão, baseado na estrutura do widget jQuery, para implementar uma aparência alternativa.
ClientLib Um sistema de bibliotecas do lado do cliente em AEM processamento no lado do cliente, orientado por códigos complexos de JavaScript e CSS. Para obter mais informações, consulte Usar bibliotecas do lado do cliente.
Arquétipo Um 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 do 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:
Criar um projeto: Crie um projeto Maven que gera um pacote de conteúdo para implantar no AEM.
Estender uma classe de widget existente: Estender uma classe de widget existente e substituir as classes necessárias.
Criar uma biblioteca do cliente: Crie um clientLib: af.customwidget e adicione os arquivos JavaScript e CSS necessários.
Criar e instalar o projeto: Crie o projeto Maven e instale o pacote de conteúdo gerado no AEM.
Atualizar 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:
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.
version: 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:
Inclua a dependência de plug-in de terceiros no projeto.
Coloque os plug-ins jQuery de terceiros ou personalizados no jqueryplugin/javascript pasta e arquivos CSS relacionados na jqueryplugin/css pasta. Para obter mais detalhes, consulte os arquivos JS e CSS na seção jqueryplugin/javascript and jqueryplugin/css pasta.
Modifique o js.txt e css.txt arquivos para incluir qualquer arquivo JavaScript e CSS adicional do plug-in jQuery.
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 a variável $userControl especifica a restrição acima, as funções da variável AbstractWidget funcionam como esperado, caso contrário, algumas das APIs comuns (foco, clique) exigem 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, a variável rawValue do campo é exibido. Essa função é chamada para mostrar a variável rawValue ao usuário.
showDisplayValue
Por padrão, no evento XFA na saída, a variável formattedValue do campo é exibido. Essa função é chamada para mostrar a variável formattedValue ao usuário.
Atualize o arquivo JavaScript no integration/javascript , conforme necessário.
Substituir o texto __widgetName__ com o 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 por todas as instâncias da cadeia de caracteres xfaWidget.textField no arquivo e substitua-os pela classe pai real usada.
Estender o render para fornecer uma interface 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 render deve retornar um elemento de controle de usuário.
Estender o 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 getEventMap O método 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.
O showDisplayValue e showValue aplique a cláusula de exibição e edição de imagem e pode ser substituída para ter um comportamento alternativo.
O getCommitValue é chamado pela estrutura de formulários adaptáveis quando a variável 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 Expressões adaptáveis do Forms.
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 de clientes necessárias e as envolve em uma biblioteca de clientes com uma categoria af.customwidgets. Os arquivos JavaScript e CSS disponíveis no af.customwidgets são incluídas 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 é somente para fins de referência e, de acordo com os padrões Maven, as informações do repositório são capturadas na variável settings.xml arquivo.
Atualizar o formulário adaptável
Para aplicar a aparência personalizada a um campo de formulário adaptável:
Abra o formulário adaptável no modo de edição.
Abra o Propriedade para o campo no qual você deseja aplicar a aparência personalizada.
No Estilo , atualize a guia CSS class para adicionar o nome da aparência na widget_<widgetName> formato. 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:
Execute o seguinte comando para criar um projeto local com base no arquétipo Maven:
No projeto do Eclipse, revise o código do plug-in no plugin.js para garantir que 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 set value O método 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 render deve ser substituído para chamar o método bootstrapNumber método .
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 $userControl deve estar disponível para a variável render método . É um campo da variável text tipo que é clonado com o código do plug-in.
O + e - botões devem ser desativados quando o campo estiver desativado.
Substitua o conteúdo da variável bootstrap-number-input.js (plugin jQuery) com o conteúdo do numericStepper-plugin.js arquivo.
No numericStepper-widget.js , adicione o seguinte código para substituir o método de renderização para chamar o plug-in e retornar o $userControl objeto:
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;
}
No numericStepper-widget.js , substitua o getOptionsMap para substituir a opção de acesso e ocultar os botões + e - no modo desativado.
