Renderização do Forms como HTML rendering-forms-as-html

Os exemplos e amostras neste documento são somente para AEM Forms no ambiente JEE.

O serviço Forms renderiza formulários como HTML em resposta a uma solicitação HTTP de um navegador da Web. Um benefício de renderizar um formulário como HTML é que o computador no qual o navegador da Web do cliente está localizado não requer Adobe Reader, Acrobat ou Flash Player (para Guias de formulário (desaprovado)).

Para renderizar um formulário como HTML, o design do formulário deve ser salvo como um arquivo XDP. Um design de formulário salvo como um arquivo PDF não pode ser renderizado como HTML. Ao desenvolver um design de formulário no Designer que será renderizado como HTML, considere os seguintes critérios:

páginas HTML html-pages

Quando um design de formulário é renderizado como um formulário HTML, cada subformulário de segundo nível é renderizado como uma página de HTML (painel). Você pode exibir a hierarquia de um subformulário no Designer. Os subformulários secundários que pertencem ao subformulário raiz (o nome padrão de um subformulário raiz é form1) são os subformulários do painel. O exemplo a seguir mostra os subformulários de um design de formulário.

     form1
         Master Pages
         PanelSubform1
             NestedDynamicSubform
                 TextEdit1
         PanelSubform2
             TextEdit1
         PanelSubform3
             TextEdit1
         PanelSubform4
             TextEdit1

Quando os designs de formulário são renderizados como formulários de HTML, os painéis não são restritos a nenhum tamanho de página específico. Se você tiver subformulários dinâmicos, eles devem ser aninhados dentro do subformulário do painel. Os subformulários dinâmicos podem se expandir para um número infinito de páginas de HTML.

Quando um formulário é renderizado como um formulário HTML, os tamanhos de página (necessários para paginar formulários renderizados como PDF) não têm significado. Como um formulário com layout fluível pode se expandir para um número infinito de páginas de HTML, é importante evitar rodapés na página principal. Um rodapé abaixo da área de conteúdo em uma página-mestre pode substituir o conteúdo de HTML que flui além de um limite de página.

Você deve mover-se explicitamente de painel a painel usando o xfa.host.pageUp e xfa.host.pageDown métodos. Você altera páginas enviando um formulário para o serviço Forms e fazendo com que o serviço Forms renderize o formulário de volta para o dispositivo cliente, normalmente um navegador da Web.

.fsc-ds-ssb: esta folha de estilos é aplicável se houver um campo de sinal em branco.

.fsc-ds-ssv: esta folha de estilos será aplicável se houver um campo Valid sign.

.fsc-ds-ssc: esta folha de estilos será aplicável se houver um campo Valid sign, mas os dados tiverem sido alterados.

.fsc-ds-ssi: esta folha de estilos é aplicável se houver um campo de sinal inválido.

.fsc-ds-popup-bg: esta propriedade da folha de estilos não está sendo usada.

.fsc-ds-popup-btn: esta propriedade da folha de estilos não está sendo usada.

Execução de scripts running-scripts

Um autor de formulário especifica se um script é executado no servidor ou no cliente. O serviço Forms cria um ambiente de processamento de eventos distribuído para a execução de inteligência de formulários que pode ser distribuído entre o cliente e o servidor usando o runAt atributo. Para obter informações sobre esse atributo ou a criação de scripts em designs de formulário, consulte Forms Designer

O serviço Forms pode executar scripts enquanto o formulário está sendo renderizado. Como resultado, você pode preencher previamente um formulário com dados se conectando a um banco de dados ou a serviços da Web que podem não estar disponíveis no cliente. Também é possível definir as configurações de um botão Click evento a ser executado no servidor para que o cliente arredonde os dados de viagem para o servidor. Isso permite que o cliente execute scripts que podem exigir recursos de servidor, como um banco de dados empresarial, enquanto um usuário interage com um formulário. Para formulários HTML, os scripts formcalc podem ser executados somente no servidor. Como resultado, você deve marcar esses scripts para serem executados em server ou both.

É possível criar formulários que se movem entre páginas (painéis) chamando xfa.host.pageUp e xfa.host.pageDown métodos. Esse script é colocado em um Click e o evento runAt atributo está definido como Both. O motivo escolhido Both é para que o Adobe Reader ou o Acrobat (para formulários renderizados como PDF) possam alterar páginas sem acessar o servidor e o HTML forms possa alterar páginas ao arredondar os dados para o servidor. Ou seja, um formulário é enviado para o serviço Forms e um formulário é renderizado como HTML com a nova página exibida.

É recomendável não atribuir às variáveis de script e aos campos de formulário os mesmos nomes, como item. Alguns navegadores da Web, como o Internet Explorer, podem não inicializar uma variável com o mesmo nome de um campo de formulário que resulta na ocorrência de um erro de script. É uma boa prática fornecer nomes diferentes para campos de formulário e variáveis de script.

Ao renderizar formulários de HTML que contêm a funcionalidade de navegação de página e scripts de formulário (por exemplo, suponha que um script recupere dados de campo de um banco de dados sempre que o formulário for renderizado), verifique se o script de formulário está no formato:calcular evento em vez de no formulário:readyevent.

Os scripts de formulário que estão no evento form:ready são executados apenas uma vez durante a renderização inicial do formulário e não são executados para recuperações de páginas subsequentes. Por outro lado, o evento form:calculate é executado para cada navegação de página em que o formulário é renderizado.

Você pode chamar scripts personalizados antes de enviar um formulário. Esse recurso funciona em todos os navegadores disponíveis. No entanto, ele pode ser usado somente quando os usuários renderizam o formulário HTML que tem sua Output Type propriedade definida como Form Body. Não funcionará quando o Output Type é Full HTML. Consulte Configuração de formulários na ajuda de administração para ver as etapas de configuração desse recurso.

Primeiro, defina uma função de retorno de chamada que seja chamada antes de enviar o formulário, em que o nome da função é _user_onsubmit. Pressupõe-se que a função não lançará nenhuma exceção, ou, se o fizer, a exceção será ignorada. É recomendável colocar a função JavaScript na seção head do html; no entanto, você pode declará-la em qualquer lugar antes do fim das tags de script que incluem xfasubset.js.

Quando formserver renderiza um XDP que contém uma lista suspensa, além de criar a lista suspensa, ele também cria dois campos de texto ocultos. Esses campos de texto armazenam os dados da lista suspensa (um armazena o nome de exibição das opções e outro armazena o valor das opções). Portanto, sempre que um usuário enviar o formulário, todos os dados da lista suspensa serão enviados. Supondo que você não deseje enviar tantos dados sempre, você pode gravar um script personalizado para desativá-los. Por exemplo: o nome da lista suspensa é drpOrderedByStateProv e ele é colocado no cabeçalho do subformulário. O nome do elemento de entrada de HTML será header[0].drpOrderedByStateProv[0]. O nome dos campos ocultos que armazenam e enviam os dados da lista suspensa tem os seguintes nomes: header[0].drpOrderedByStateProv_DISPLAYITEMS_[0] header[0].drpOrderedByStateProv_VALUEITEMS_[0]

Você pode desativar esses elementos de entrada da seguinte maneira se não quiser publicar os dados. var __CUSTOM_SCRIPTS_VERSION = 1; //enabling the feature function _user_onsubmit() { var elems = document.getElementsByName("header[0].drpOrderedByStateProv_DISPLAYITEMS_[0]"); elems[0].disabled = true; elems = document.getElementsByName("header[0].drpOrderedByStateProv_VALUEITEMS_[0]"); elems[0].disabled = true; }

header[0].drpOrderedByStateProv_DISPLAYITEMS_[0] header[0].drpOrderedByStateProv_VALUEITEMS_[0]

var __CUSTOM_SCRIPTS_VERSION = 1; //enabling the feature
    function _user_onsubmit() {
    var elems = document.getElementsByName("header[0].drpOrderedByStateProv_DISPLAYITEMS_[0]");
    elems[0].disabled = true;
    elems = document.getElementsByName("header[0].drpOrderedByStateProv_VALUEITEMS_[0]");
    elems[0].disabled = true;
    }

Subconjuntos XFA xfa-subsets

Ao criar designs de formulário para renderizar como HTML, você deve restringir seu script ao subconjunto XFA para scripts na linguagem JavaScript.

Os scripts executados no cliente ou no servidor devem ser gravados no subconjunto XFA. Os scripts executados no servidor podem usar o modelo de script XFA completo e também usar FormCalc. Para obter informações sobre o uso do JavaScript, consulte Forms Designer.

Ao executar scripts no cliente, somente o painel atual que está sendo exibido pode usar script; por exemplo, você não pode criar scripts para campos que estão no painel A quando o painel B é exibido. Ao executar scripts no servidor, todos os painéis podem ser acessados.

Tenha cuidado ao usar expressões de modelo de objeto de script (SOM) em scripts executados no cliente. Somente um subconjunto simplificado de expressões SOM é suportado por scripts executados no cliente.

Tempo do evento event-timing

O subconjunto XFA define os eventos XFA que são mapeados para eventos HTML. Há uma pequena diferença no comportamento em relação ao tempo dos eventos de cálculo e validação. Em um navegador da Web, um evento de cálculo completo é executado ao sair de um campo. Eventos de cálculo não são executados automaticamente quando você faz uma alteração em um valor de campo. Você pode forçar um evento de cálculo chamando o xfa.form.execCalculate método.

Em um navegador da Web, a validação de eventos só é executada ao sair de um campo ou enviar um formulário. Você pode forçar um evento de validação usando o xfa.form.execValidate método.

A Forms exibida em um navegador da Web (em vez de Adobe Reader ou Acrobat) está em conformidade com o teste nulo XFA (erros ou avisos) para campos obrigatórios.

Para obter mais informações sobre um teste nulo, consulte Forms Designer.

Botões de formulário form-buttons

Clicar em um botão enviar envia dados de formulário para o serviço Forms e representa o fim do processamento de formulário. A variável preSubmit evento pode ser definido para execução no cliente ou servidor. A variável preSubmit O evento será executado antes do envio do formulário se ele estiver configurado para ser executado no cliente. Caso contrário, a variável preSubmit evento é executado no servidor durante o envio do formulário. Para obter mais informações sobre o preSubmit evento, consulte Forms Designer.

Se um botão não tiver script do lado do cliente associado a ele, os dados serão enviados ao servidor, os cálculos serão executados no servidor e o formulário HTML será gerado novamente. Se um botão contiver um script do lado do cliente, os dados não serão enviados para o servidor e o script do lado do cliente será executado no navegador da Web.

navegador HTML 4.0 html-4-0-web-browser

Um navegador da Web compatível apenas com o HTML 4.0 não pode oferecer suporte ao modelo de script do lado do cliente do subconjunto XFA. Ao criar um design de formulário para funcionar no HTML 4.0 e MSDHTML ou CSS2HTML, um script que está marcado para execução no cliente será realmente executado no servidor. Por exemplo, suponha que um usuário clique em um botão localizado em um formulário exibido em um navegador HTML 4.0. Nessa situação, os dados de formulário são enviados para o servidor onde o script do lado do cliente é executado.

É recomendável colocar a lógica do formulário em calcular eventos, que são executados no servidor no HTML 4.0 e no cliente para MSDHTML ou CSS2HTML.

Manutenção das alterações na apresentação maintaining-presentation-changes

À medida que você se move entre páginas HTML (painéis), somente o estado dos dados é mantido. Configurações como cor de fundo ou configurações de campo obrigatório não são mantidas (se forem diferentes das configurações iniciais). Para manter o estado de apresentação, você deve criar campos (geralmente ocultos) que representem o estado de apresentação dos campos. Se você adicionar um script a um campo do Calculate caso altere a apresentação com base em valores de campo ocultos, você poderá preservar o estado de apresentação conforme avança e volta entre páginas HTML (painéis).

O script a seguir mantém o fillColor de um campo com base no valor de hiddenField. Suponha que esse script esteja em um campo Calculate evento.

     If (hiddenField.rawValue == 1)
         this.fillColor = "255,0,0"
     else
         this.fillColor = "0,255,0"

Assinatura digital de formulários de HTML digitally-signing-html-forms

Não é possível assinar um formulário de HTML que contém um campo de assinatura digital se o formulário for renderizado como uma das seguintes transformações de HTML:

Para obter informações sobre como assinar digitalmente um documento, consulte Assinatura digital e documentos de certificação

Renderização de um formulário XHTML compatível com as diretrizes de acessibilidade rendering-an-accessibility-guidelines-compliant-xhtml-form

Você pode renderizar um formulário de HTML completo que esteja em conformidade com as diretrizes de acessibilidade. Ou seja, o formulário é renderizado em tags de HTML completo, em vez de o formulário de HTML ser renderizado em tags de corpo (não uma página de HTML completa).

Validação de dados do formulário validating-form-data

É recomendável limitar o uso das regras de validação para campos de formulário ao renderizar o formulário como um formulário HTML. Algumas regras de validação podem não ser compatíveis com formulários HTML. Por exemplo, quando um padrão de validação de MM-DD-AAAA é aplicado a um Date/Time que está em um design de formulário renderizado como um formulário HTML, ele não funciona corretamente, mesmo se a data for digitada corretamente. No entanto, esse padrão de validação funciona corretamente para formulários renderizados como PDF.

Resumo das etapas summary-of-steps

Para renderizar um formulário HTML, execute as seguintes etapas:

Incluir arquivos de projeto

Inclua os arquivos necessários no projeto de desenvolvimento. Se você estiver criando uma aplicação cliente usando Java, inclua os arquivos JAR necessários. Se você estiver usando serviços da Web, certifique-se de incluir os arquivos proxy.

Criar um objeto da API do cliente do Forms

Antes de importar dados programaticamente para uma API formClient do PDF, você deve criar um cliente do serviço de Integração de dados de formulário. Ao criar um cliente de serviço, você define as configurações de conexão necessárias para chamar um serviço.

Definir opções de tempo de execução de HTML

Você define opções de tempo de execução de HTML ao renderizar um formulário de HTML. Por exemplo, você pode adicionar uma barra de ferramentas a um formulário HTML para permitir que os usuários selecionem anexos de arquivo localizados no computador cliente ou para recuperar anexos de arquivo renderizados com o formulário HTML. Por padrão, uma barra de ferramentas HTML está desativada. Para adicionar uma barra de ferramentas a um formulário HTML, você deve definir programaticamente as opções de tempo de execução. Por padrão, uma barra de ferramentas HTML consiste nos seguintes botões:

Quando uma barra de ferramentas HTML é exibida em um formulário HTML, um usuário pode selecionar no máximo dez arquivos para enviar juntamente com os dados de formulário. Depois que os arquivos forem enviados, o serviço Forms poderá recuperá-los.

Ao renderizar um formulário como HTML, você pode especificar um valor user-agent. Um valor agente-usuário fornece informações do navegador e do sistema. Este é um valor opcional, e você pode passar um valor de string vazio. O início rápido da Renderização de um formulário de HTML usando a API Java mostra como obter um valor de agente de usuário e usá-lo para renderizar um formulário como HTML.

Os URLs HTTP para onde os dados de formulário são publicados podem ser especificados definindo o URL de destino usando a API do cliente de serviço do Forms ou podem ser especificados no botão Enviar contido no design do formulário XDP. Se a URL de destino estiver especificada no design do formulário, não defina um valor usando a API do cliente de serviço do Forms.

Renderizar um formulário HTML

Para renderizar um formulário HTML, especifique um design de formulário que foi criado no Designer e salvo como um arquivo XDP. Selecione um tipo de transformação HTML. Por exemplo, você pode especificar o tipo de transformação de HTML que renderiza um HTML dinâmico para o Internet Explorer 5.0 ou posterior.

A renderização de um formulário HTML também requer valores, como valores de URI, que são necessários para renderizar outros tipos de formulário.

Gravar o fluxo de dados do formulário no navegador Web cliente

Quando o serviço Forms renderiza um formulário HTML, ele retorna um fluxo de dados de formulário que você deve gravar no navegador da Web do cliente. Quando gravado no navegador da web do cliente, o formulário de HTML fica visível para o usuário.

Consulte também

Renderizar um formulário como HTML usando a API Java

Renderizar um formulário como HTML usando a API do serviço Web

Inclusão de arquivos da biblioteca Java do AEM Forms

Definindo propriedades de conexão

Início rápido da API de serviço do Forms

Renderização de PDF forms interativos

Renderização do HTML Forms com barras de ferramentas personalizadas

Criação de aplicações Web que renderizam o Forms

Renderizar um formulário como HTML usando a API Java render-a-form-as-html-using-the-java-api

Renderize um formulário HTML usando a API do Forms (Java):

Consulte também

Renderização do Forms como HTML

Início rápido (modo SOAP): renderização de um formulário HTML usando a API Java

Inclusão de arquivos da biblioteca Java do AEM Forms

Definindo propriedades de conexão

Renderizar um formulário como HTML usando a API do serviço Web render-a-form-as-html-using-the-web-service-api

Renderize um formulário HTML usando a API (serviço da Web) do Forms:

Consulte também

Renderização do Forms como HTML

Chamada de AEM Forms usando codificação Base64