Package systextil.help

Class Help

java.lang.Object
systextil.help.Help
public class Help extends Object
Monta as páginas de ajuda, e possui métodos auxiliares para serem usados pelos formulários. Suporta arquivos de ajuda em alguns formatos, na seguinte ordem de prioridade:
  1. Se houver arquivo com extensão ".html", este será usado.
  2. Caso contrário, se houver arquivo com extensão ".md", este será usado e convertido para HTML usando Markdown4J.
  3. Caso contrário, se houver arquivo com extensão ".hlp", este será lido e apresentado no padrão Systêxtil.
  4. Não havendo nenhum desses arquivos, é informado que não há ajuda disponível.
Todos os arquivos com textos para ajuda devem estar codificados como WINDOWS-1252 ou compatível (ISO-8859-1), isto é, no padrão Windows.

Padrões para os nomes dos arquivos de ajuda

Se for definido um nome específico para um campo, será usado este. Se não for, então o nome do arquivo é gerado automaticamente a partir do nome do campo e do nome do dataview (formulário ou subformulário) onde o campo se encontra. A parte correspondente ao nome do campo está limitada a 10 caracteres.

Por exemplo: inte_f440_url_syspla

Padrões para empacotamento e distribuição dos arquivos de ajuda

Os arquivos de ajuda podem ser distribuídos de duas maneiras:

Abertos, na pasta de arquivos de ajuda (projeto systextil-hlp)

Os arquivos são buscados no seguinte caminho: 
[idioma]/hlp/[nomeDoArquivo].[extensao]
P. ex.: pt_BR/hlp/inte_f440_campo_39.hlp

Embutidos em arquivos JAR (p. ex. plugins)

Os arquivos são buscados no seguinte caminho padronizado: 
systextil/[móduloDoPlugin]/[idiomaEmMinúsculas]/hlp/[nomeDoArquivo].[extensao]
P. ex.: systextil/ddpr/pt_br/hlp/ddpr_f440_campo_39.hlp

  • Field Details

    • file

      public final File file

  • Constructor Details

    • Help

      public Help(String locale, String fileName)
      Depois de construir este objeto, é importante ver se existe file.
      Parameters:
      locale - se for espanhol, será "es_ES"; caso contrário, "pt_BR". Por enquanto, só há suporte para estes dois idiomas.
      fileName - o nome do arquivo, com a extensão.

  • Method Details

    • print

      public void print(PrintWriter out)

    • findHelpFilePath

      public static File findHelpFilePath(String lingua, String subformName, String campo)
      Busca um arquivo de ajuda correspondente ao campo no subform informado. Se a busca pelo nome do subform não encontrar arquivo, é feita nova busca retirando o último caractere do nome do subform, até que se encontre arquivo - desde que não restem menos de 4 caracteres. A extensão do arquivo retornado não é alterada - mesmo que o próprio arquivo não exista, desde que neste caso exista um arquivo correspondente com extensão suportada.
      Returns:
      o caminho completo do arquivo de ajuda encontrado, sem alterar a extensão, ou null se não existir

    • findHelpFilePath

      public static String findHelpFilePath(String lingua, String formName, String subformName, String campo, ClassLoader cl)
      Procura o arquivo de ajuda a partir do nome do campo.

      Isto é usado pelos formulários.

      Parameters:
      lingua - o idioma
      formName - o nome do formulário
      subformName - o nome do form ou subform onde se encontra o campo
      campo - o nome do campo
      cl - o classloader onde é possível que se encontre o arquivo
      Returns:
      o caminho onde o arquivo se encontra, ou nulo se não se encontrar

    • findHelpFilePath

      public static String findHelpFilePath(String lingua, String formName, String helpFileName, ClassLoader cl)
      Procura o arquivo de ajuda dado um nome de arquivo personalizado.

      Isto é usado pelos formulários.

      Parameters:
      lingua - o idioma
      formName - o nome do formulário
      helpFileName - o nome de arquivo de ajuda personalizado, sem extensão
      cl - o classloader onde é possível que se encontre o arquivo
      Returns:
      o caminho pelo qual o arquivo pode ser encontrado, sem extensão, ou nulo se não se encontrar