Package br.com.davinti.vitruvio.activiti.component.form

Interface BaseForm

All Superinterfaces:
Serializable
All Known Subinterfaces:
Form, HasAttachments, HasSubForms, MobileBaseForm, MobileForm, MobilePanelForm, MobileSubForm, MutableBaseForm, MutableForm, MutableHasAttachments, MutableHasSubForms, MutableMobileBaseForm, MutableMobileForm, MutableMobilePanelForm, MutableMobileSubForm, MutablePanelForm, MutableReportForm, MutableSubForm, PanelForm, ReportForm, SubForm
All Known Implementing Classes:
AbstractBaseForm, AbstractFormCommomBase, AbstractMobileFormCommomBase, FormImpl, MobileFormImpl, MobilePanelFormImpl, MobileSubFormImpl, PanelFormImpl, SubFormImpl
public interface BaseForm extends Serializable
Form Basico da API De formularios
Author:
eduardo

  • Method Details

    • formKey

      String formKey()
      Form key
      Returns:

    • getName

      String getName()
      Nome do formulario
      Returns:

    • getDescription

      String getDescription()
      Descricao do formulario
      Returns:

    • getRootContainers

      List<FormComponentContainer> getRootContainers()
      Todo formulario comeca com containers de componentes. Dentro dos containers, podem haver outros containers e outros elementos
      Returns:

    • getAfterFormRenderScript

      Script getAfterFormRenderScript()
      Script que podera ser invocado logo apos a renderizacao do form e criacao da UI. Nesta etapa, os dados ainda nao foram carregados e nenhum evento da UI foi processado. Pode ser util para declarar funcoes globais por exemplo
      Returns:

    • getPreInitScript

      Script getPreInitScript()
      Hook de pre init, e invocado logo apos a configuracao dos dados do formulario, porem antes da inicializacao dos widgets
      Returns:

    • getInitScript

      Script getInitScript()
      Hook script que caso presente, sera invocado assim que o formulario estiver renderizado
      Returns:

    • getPersistScript

      Script getPersistScript()
      Hook script, invocado ao persistir os dados do formulario
      Returns:
      Since:
      1.16.1

    • getValidationRules

      ValidationRules getValidationRules()
      Obtem o conjunto de regras gerais
      Returns:

    • getValidators

      List<ValidatorDescriptor> getValidators()
      Deprecated.
      (@see getValidationRUles())
      Relacao de validadores customizados do formulario
      Returns:

    • getFieldIds

      Set<String> getFieldIds()
      Obtem a relacao de todos os IDs de campos disponiveis no formulario
      Returns:

    • getWidgetIds

      Set<String> getWidgetIds()
      Obtem a relacao de todos os IDs de widgets disponiveis no formulario
      Returns:

    • getModelMemberFieldIds

      Set<String> getModelMemberFieldIds()
      Obtem a relacao de todos os IDs de campos que facam parte do modelo de dados do formulario
      Returns:

    • isModelMember

      boolean isModelMember(String fieldId)
      Determina se determinado campo faz parte do modelo de dados do formulario, ou seja: Se os dados deste campo devem ser persistidos/carregados
      Parameters:
      fieldId -
      Returns:

    • getFieldDescriptorById

      FieldDescriptor getFieldDescriptorById(String id)
      Localiza na estrutura de descricao do formulario, a definicao de um deterinado field por ID
      Parameters:
      id -
      Returns:

    • getLabelIds

      Set<String> getLabelIds()
      Obtem a relacao de todos os IDs de labels disponiveis no formulario
      Returns:

    • getLabelDescriptorById

      FieldDescriptor getLabelDescriptorById(String id)
      Localiza na estrutura de descricao do formulario, a definicao de um deterinado label por ID
      Parameters:
      id -
      Returns:

    • getWidth

      String getWidth()
      Tamanho em largura do container do formulario
      Returns:

    • getHeight

      String getHeight()
      Tamanho em altura do formulario
      Returns:

    • getWindowWidth

      String getWindowWidth()
      Quando o sistema julgar que este formulario deve ser exibido em uma janela, este metodo pode retornar uma dica do tamanho ideal de exibicao
      Returns:

    • getWindowHeight

      String getWindowHeight()
      Quando o sistema julgar que este formulario deve ser exibido em uma janela, este metodo pode retornar uma dica do tamanho ideal de exibicao
      Returns:

    • backgroundColor

      String backgroundColor()
      Cor de fundo personalizada do container componente
      Returns:

    • customCss

      String customCss()
      Estilo css personalizado, para o container do componente
      Returns:

    • composer

      String composer()
      Returns:

    • debugMode

      FormDebugMode debugMode()
      Coleta o modo de debug configurado para este formulario
      Returns:

    • debugOutput

      FormDebugOutput debugOutput()
      Caso o modo de debug esteja ativo, especifica qual a saida das informacoes coletadas
      Returns:

    • debugFormat

      FormDebugFormat debugFormat()
      Formato de representacao dos dados de debug
      Returns:

    • allowsBulkFinish

      boolean allowsBulkFinish()
      Determina se este formulario permite conclusao em grupo de tarefas
      Returns:

    • getBulkAction

      BulkAction getBulkAction()
      Obtem a definicao da acao de conclusao em grupo, caso exista
      Returns: