DocumentaçãoAEM 6.5Guia do usuário

Desenvolvimento do Forms (interface clássica) developing-forms-classic-ui

Last update: Wed Mar 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

A estrutura básica de um formulário é:

  • Início do formulário
  • Elementos de formulário
  • Fim do formulário

Todos esses são realizados com uma série de Componentes de formulário, disponível em uma instalação padrão do AEM.

Além de desenvolvimento de novos componentes para usar nos formulários, você também pode:

Uso de scripts para estender a funcionalidade onde necessário.

NOTE
Este documento se concentra no desenvolvimento de formulários usando o Componentes de base na interface clássica. O Adobe recomenda usar o novo Componentes principais e Ocultar condições para desenvolvimento de formulários na interface habilitada para toque.

Pré-carregando Valores de Formulário preloading-form-values

O componente de início do formulário fornece um campo para a Carregar caminho, um caminho opcional que aponta para um nó no repositório.

Carregar caminho é o caminho para as propriedades do nó usado para carregar valores predefinidos em vários campos no formulário.

Este é um campo opcional que especifica o caminho para um nó no repositório. Quando esse nó tem propriedades que correspondem aos nomes dos campos, os campos apropriados no formulário são pré-carregados com o valor dessas propriedades. Se não houver correspondência, o campo conterá o valor padrão.

NOTE
A ação de formulário O também pode definir o recurso do qual carregar os valores iniciais. Isso é feito usando FormsHelper#setFormLoadResource dentro init.jsp.
Somente se isso não for definido, o formulário será preenchido a partir do caminho definido no componente Formulário inicial pelo autor.

Pré-carregamento de campos de formulário com vários valores preloading-form-fields-with-multiple-values

Vários campos de formulário também têm a função Caminho de carregamento de itens, novamente um caminho opcional que aponta para um nó no repositório.

A variável Caminho de carregamento de itens é o caminho para as propriedades do nó usado para carregar valores predefinidos nesse campo específico do formulário, por exemplo, um lista suspensa, grupo de caixas de seleção ou grupo de rádio.

Exemplo - Pré-carregamento De Uma Lista Suspensa Com Vários Valores example-preloading-a-dropdown-list-with-multiple-values

Uma lista suspensa pode ser configurada com o intervalo de valores para seleção.

A variável Caminho de carregamento de itens O pode ser usado para acessar uma lista de uma pasta no repositório e pré-carregá-la no campo:

  1. Criar uma pasta do sling ( sling:Folder) por exemplo, /etc/designs/<myDesign>/formlistvalues

  2. Adicione uma nova propriedade (por exemplo, myList) do tipo sequência de caracteres de vários valores ( String[]) para conter a lista de itens suspensos. O conteúdo também pode ser importado usando um script, como com um script JSP ou cURL em um script de shell.

  3. Use o caminho completo na variável Caminho de carregamento de itens field: por exemplo, /etc/designs/geometrixx/formlistvalues/myList

Observe que se os valores no campo String[] são do formato assim:

  • AL=Alabama
  • AK=Alaska

e assim por diante, o AEM gera a lista como:

  • <option value="AL">Alabama</option>
  • <option value="AK">Alaska</option>

Esse recurso pode, por exemplo, ser bem usado em uma configuração multilíngue.

Desenvolver suas próprias ações de formulário developing-your-own-form-actions

Um formulário precisa de uma ação. Uma ação define a operação que é executada quando o formulário é enviado com os dados do usuário.

Uma série de ações é fornecida com uma instalação padrão de AEM, que podem ser vistas em:

/libs/foundation/components/form/actions

e no Tipo de ação lista de Formulário componente:

chlimage_1-8

Esta seção aborda como você pode desenvolver sua própria ação de formulário para inclusão nesta lista.

Você pode adicionar sua própria ação em /apps do seguinte modo:

  1. Criar um nó do tipo sling:Folder. Especifique um nome que reflita a ação a ser implementada.

    Por exemplo:

    /apps/myProject/components/customFormAction

  2. Nesse nó, defina as seguintes propriedades e clique em Salvar tudo para manter suas alterações:

    • sling:resourceType - definir como foundation/components/form/action

    • componentGroup - definir como .hidden

    • Opcionalmente:

      • jcr:title - especifique um título de sua escolha, ele será exibido na lista suspensa de seleção. Se não estiver definido, o nome do nó será mostrado

      • jcr:description - insira uma descrição de sua escolha

  3. Na pasta, crie um nó de diálogo:

    1. Adicione campos para que o autor possa editar a caixa de diálogo de formulários depois que a ação for escolhida.

  4. Na pasta, crie:

    1. Um script post.
      O nome do script é post.POST.<extension>, por exemplo, post.POST.jsp
      O script post é chamado quando um formulário é enviado para processar o formulário, ele contém o código que lida com os dados que chegam do formulário POST.

    2. Adicione um script de encaminhamento que é chamado quando o formulário é enviado.
      O nome do script é forward.<extension>, por exemplo, forward.jsp
      Este script pode definir um caminho. A solicitação atual é então encaminhada para o caminho especificado.

    A chamada necessária é FormsHelper#setForwardPath (2 variantes) Um caso típico é executar alguma validação, ou lógica, para encontrar o caminho de destino e, em seguida, encaminhar para esse caminho, permitindo que o servlet Sling POST padrão faça o armazenamento real no JCR.

    Também pode haver outro servlet que faça o processamento real, nesse caso, a ação do formulário e o forward.jsp agiria somente como o código de "cola". Um exemplo disso é a ação de email em /libs/foundation/components/form/actions/mail, que encaminha detalhes para <currentpath>.mail.htmlonde está um servlet de e-mail.

    Assim:

    • a post.POST.jsp é útil para pequenas operações totalmente realizadas pela própria ação
    • enquanto a variável forward.jsp é útil quando somente a delegação é necessária.

    A ordem de execução dos scripts é:

    • Ao renderizar o formulário ( GET):

      1. init.jsp
      2. para todas as restrições do campo: clientvalidation.jsp
      3. validationRT do formulário: clientvalidation.jsp
      4. o formulário é carregado por meio do recurso de carga, se definido
      5. addfields.jsp durante a renderização <form></form>

    • ao manusear um formulário POST:

      1. init.jsp

      2. para todas as restrições do campo: servervalidation.jsp

      3. validationRT do formulário: servervalidation.jsp

      4. forward.jsp

      5. se um caminho de encaminhamento foi definido ( FormsHelper.setForwardPath), encaminhe a solicitação e, em seguida, chame cleanup.jsp

      6. se nenhum caminho de encaminhamento foi definido, chame post.POST.jsp (termina aqui, não cleanup.jsp chamado)

  5. Novamente, na pasta, adicione opcionalmente:

    1. Um script para adicionar campos.
      O nome do script é addfields.<extension>, por exemplo, addfields.jsp
      Um addfields O script é chamado imediatamente após o HTML para o início do formulário ser gravado. Isso permite que a ação adicione campos de entrada personalizados ou outro HTML semelhante dentro do formulário.

    2. Um script de inicialização.
      O nome do script é init.<extension>, por exemplo, init.jsp
      Esse script é chamado quando o formulário é renderizado. Ele pode ser usado para inicializar especificações de ação.

    3. Um script de limpeza.
      O nome do script é cleanup.<extension>, por exemplo, cleanup.jsp
      Esse script pode ser usado para executar a limpeza.

  6. Use o Forms em um parsys. A variável Tipo de ação agora incluirá sua nova ação.

    note note
    NOTE
    Para ver as ações padrão que fazem parte do produto:
    /libs/foundation/components/form/actions

Desenvolver suas próprias restrições de formulário developing-your-own-form-constraints

Restrições podem ser impostas em dois níveis:

Restrições para Campos Individuais constraints-for-individual-fields

Você pode adicionar suas próprias restrições para um campo individual (em /apps) do seguinte modo:

  1. Criar um nó do tipo sling:Folder. Especifique um nome que reflita a restrição a ser implementada.

    Por exemplo:

    /apps/myProject/components/customFormConstraint

  2. Nesse nó, defina as seguintes propriedades e clique em Salvar tudo para manter suas alterações:

    • sling:resourceType - defina como foundation/components/form/constraint

    • constraintMessage - uma mensagem personalizada que é mostrada se o campo não for válido, de acordo com a restrição, quando o formulário for enviado

    • Opcionalmente:

      • jcr:title - especifique um título de sua escolha, ele será exibido na lista de seleção. Se não estiver definido, o nome do nó será mostrado
      • hint - informações adicionais, para o usuário, sobre como usar o campo

  3. Nessa pasta, você pode precisar dos seguintes scripts:

    • Um script de validação de cliente: O nome do script é clientvalidation.<extension>, por exemplo, clientvalidation.jsp
      Isso é chamado quando o campo de formulário é renderizado. Ele pode ser usado para criar o javascript do cliente para validar o campo no cliente.

    • Um script de validação de servidor: o nome do script é servervalidation.<extension>, por exemplo, servervalidation.jsp
      Isso é chamado quando o formulário é enviado. Ele pode ser usado para validar o campo no servidor após ser enviado.

NOTE
Restrições de exemplo podem ser vistas em:
/libs/foundation/components/form/constraints

Restrições globais de forma form-global-constraints

A validação global de formulário é especificada configurando um tipo de recurso no componente de formulário inicial ( validationRT). Por exemplo:

apps/myProject/components/form/validation

Em seguida, você pode definir:

  • a clientvalidation.jsp - inserido após os scripts de validação do cliente do campo
  • e uma servervalidation.jsp - também chamado após as validações individuais do servidor de campo em um POST.

Mostrando e ocultando componentes de formulário showing-and-hiding-form-components

Você pode configurar o formulário para mostrar ou ocultar componentes do formulário de acordo com o valor de outros campos no formulário.

Alterar a visibilidade de um campo de formulário é útil quando o campo é necessário somente em condições específicas. Por exemplo, em um formulário de feedback, uma pergunta pergunta pergunta aos clientes se eles desejam que as informações do produto sejam enviadas a eles por email. Ao selecionar sim, um campo de texto aparece para permitir que o cliente digite seu endereço de email.

Use o Editar regras de Mostrar/Ocultar caixa de diálogo para especificar as condições sob as quais um componente de formulário é exibido ou ocultado.

show whideeditor

Use os campos na parte superior da caixa de diálogo para especificar as seguintes informações:

  • Se você está especificando condições para ocultar ou mostrar o componente.
  • Se alguma ou todas as condições precisam ser verdadeiras para mostrar ou ocultar o componente.

Uma ou mais condições aparecem abaixo desses campos. Uma condição compara o valor de outro componente de formulário (no mesmo formulário) a um valor. Se o valor real no campo atender à condição, a condição será avaliada como verdadeira. As condições incluem as seguintes informações:

  • O Título do campo de formulário que é testado.
  • Um operador.
  • Um valor em relação ao com o valor do campo é comparado.

Por exemplo, um componente Grupo de opções com o título Receive email notifications?* * contém Yes e No botões de opção. Um componente Campo de texto com o título de Email Address O usa a seguinte condição para que seja visível se Yes está selecionado:

show whidecondition

No JavaScript, as condições usam o valor da propriedade Nome do elemento para se referir aos campos. No exemplo anterior, a propriedade Nome do elemento do componente Grupo de opções é contact. O código a seguir é o código JavaScript equivalente para esse exemplo:

((contact == "Yes"))

Para mostrar ou ocultar um componente de formulário:

  1. Edite o componente de formulário específico.

  2. Selecionar Mostrar/Ocultar para abrir o Editar regras de Mostrar/Ocultar diálogo:

    • Na primeira lista suspensa, selecione Mostrar ou Ocultar para especificar se as condições determinam se o componente deve ser mostrado ou ocultado.

    • Na lista suspensa no final da linha superior, selecione:

      • all - se todas as condições forem verdadeiras para mostrar ou ocultar o componente
      • qualquer - se apenas uma ou mais condições forem verdadeiras para mostrar ou ocultar o componente

    • Na linha de condição (uma é apresentada como padrão), selecione um componente, operador e especifique um valor.

    • Adicione mais condições, se necessário, clicando em Adicionar Condição.

    Por exemplo:

    chlimage_1-9

  3. Clique em OK para salvar a definição.

  4. Depois de salvar sua definição, uma Editar regras é exibido ao lado da tag Mostrar/Ocultar nas propriedades do componente de formulário. Clique neste link para abrir a Editar regras de Mostrar/Ocultar para fazer alterações.

    Clique em OK para salvar todas as alterações.

    chlimage_1-10

    note caution
    CAUTION
    Os efeitos das definições Mostrar/Ocultar podem ser vistos e testados:

    • in Visualizar no ambiente do autor (precisa de um recarregamento de página ao alternar para visualização pela primeira vez)

    • no ambiente de publicação

Manipular referências de componentes corrompidos handling-broken-component-references

As condições de mostrar/ocultar usam o valor da propriedade Nome do elemento para fazer referência a outros componentes no formulário. A configuração Mostrar/Ocultar é inválida quando qualquer uma das condições se refere a um componente excluído ou teve a propriedade Nome do elemento alterada. Quando essa situação ocorrer, você precisará atualizar manualmente as condições ou ocorrerá um erro quando o formulário for carregado.

Quando a configuração Mostrar/Ocultar é inválida, a configuração é fornecida somente como código JavaScript. Edite o código para corrigir os problemas. O código usa a propriedade Nome do Elemento que foi originalmente usada para fazer referência aos componentes.

Desenvolvimento de scripts para uso com o Forms developing-scripts-for-use-with-forms

Para obter mais informações sobre os elementos da API que podem ser usados ao gravar scripts, consulte a javadocs relacionados a formulários.

Você pode usar isso para ações como chamar um serviço antes que o formulário seja enviado e cancelar o serviço se ele falhar:

  • Definir o tipo de recurso de validação

  • Incluir um script para validação:

    • No JSP, chame o serviço da Web e crie um com.day.cq.wcm.foundation.forms.ValidationInfo objeto contendo suas mensagens de erro. Se houver erros, os dados do formulário não serão publicados.
recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2