Package org.praxisplatform.uischema

Enum Class FieldConfigProperties

java.lang.Object
java.lang.Enum<FieldConfigProperties>
org.praxisplatform.uischema.FieldConfigProperties
All Implemented Interfaces:
Serializable, Comparable<FieldConfigProperties>, Constable
public enum FieldConfigProperties extends Enum<FieldConfigProperties>
Define as chaves canônicas x-ui utilizadas para descrever campos em formulários, tabelas e filtros.

O CustomOpenApiResolver utiliza esse enum para serializar metadados gerados a partir de UISchema e das validações Bean Validation. As propriedades estão agrupadas por contexto para facilitar a consulta e seguem o vocabulário documentado em docs/architecture-overview.md.

Grupos principais:

  1. Identificação e Rótulo – chaves básicas de nome, label e descrição
  2. Tipo e Componente – descrevem o tipo de dado e o controle visual
  3. Layout e Estilo – controlam ordem, largura e agrupamento
  4. Comportamento e Validação – habilitam regras dinâmicas e restrições
  5. Visibilidade – permitem ocultar campos em contextos específicos
  6. Dependências e Ações – definem reações a outros campos
  7. Ícones e Representação Visual – customizam ícones associados
  8. Opções e Mapeamento – conectam campos a endpoints e listas
  9. Filtros – ajustes específicos para telas de busca
Since:
1.0.0

  • Enum Constant Details

    • NAME

      public static final FieldConfigProperties NAME
      Nome do campo (identificador interno)

    • LABEL

      public static final FieldConfigProperties LABEL
      Rótulo que será exibido na UI

    • DESCRIPTION

      public static final FieldConfigProperties DESCRIPTION
      Descrição do campo

    • TYPE

      public static final FieldConfigProperties TYPE
      Tipo de dado do campo, padrão é "text". Valor padrão: FieldDataType.TEXT

    • CONTROL_TYPE

      public static final FieldConfigProperties CONTROL_TYPE
      Define o controle/componente que será utilizado pelo front-end. Os possíveis valores estão em FieldControlType

    • PLACEHOLDER

      public static final FieldConfigProperties PLACEHOLDER
      Texto exibido como placeholder no campo

    • DEFAULT_VALUE

      public static final FieldConfigProperties DEFAULT_VALUE
      Valor padrão do campo

    • GROUP

      public static final FieldConfigProperties GROUP
      Agrupamento ou seção do campo

    • ORDER

      public static final FieldConfigProperties ORDER
      Ordem de exibição do campo

    • WIDTH

      public static final FieldConfigProperties WIDTH
      Largura do campo

    • IS_FLEX

      public static final FieldConfigProperties IS_FLEX
      Indica se o campo utiliza layout flex

    • DISPLAY_ORIENTATION

      public static final FieldConfigProperties DISPLAY_ORIENTATION
      Define a orientação de exibição do campo

    • DISABLED

      public static final FieldConfigProperties DISABLED
      Define se o campo está desabilitado

    • READ_ONLY

      public static final FieldConfigProperties READ_ONLY
      Define se o campo é somente leitura

    • MULTIPLE

      public static final FieldConfigProperties MULTIPLE
      Permite seleção múltipla (por exemplo, em selects)

    • EDITABLE

      public static final FieldConfigProperties EDITABLE
      Define se o campo é editável

    • VALIDATION_MODE

      public static final FieldConfigProperties VALIDATION_MODE
      Modo de validação a ser aplicado

    • UNIQUE

      public static final FieldConfigProperties UNIQUE
      Define se o valor do campo deve ser único

    • MASK

      public static final FieldConfigProperties MASK
      Máscara para formatação do campo

    • SORTABLE

      public static final FieldConfigProperties SORTABLE
      Define se o campo pode ser ordenado em uma grid

    • CONDITIONAL_REQUIRED

      public static final FieldConfigProperties CONDITIONAL_REQUIRED
      Define se o campo é condicionalmente obrigatório

    • VIEW_ONLY_STYLE

      public static final FieldConfigProperties VIEW_ONLY_STYLE
      Define o estilo para visualização somente (quando aplicável)

    • VALIDATION_TRIGGERS

      public static final FieldConfigProperties VALIDATION_TRIGGERS
      Define os gatilhos que disparam a validação

    • HIDDEN

      public static final FieldConfigProperties HIDDEN
      Indica se o campo deve ser oculto de forma global. Essa propriedade pode ser usada como padrão e/ou sobrescrita pelos contextos específicos abaixo.

    • TABLE_HIDDEN

      public static final FieldConfigProperties TABLE_HIDDEN
      Especifica se o campo deve ser oculto na exibição da tabela (grid)

    • FORM_HIDDEN

      public static final FieldConfigProperties FORM_HIDDEN
      Especifica se o campo deve ser oculto no formulário

    • FILTERABLE

      public static final FieldConfigProperties FILTERABLE
      Indica que o campo é filtrável. A presença dessa propriedade (ou o uso da anotação @Filterable) define que o campo deve ser considerado na geração de filtros dinâmicos. Não interfere na exibição do campo nas tabelas ou formulários. Apenas indica que o campo pode ser utilizado como critério de filtro no component de filtro exibido acima da Table.

    • CONDITIONAL_DISPLAY

      public static final FieldConfigProperties CONDITIONAL_DISPLAY
      Define se a exibição do campo depende do valor de outro campo

    • DEPENDENT_FIELD

      public static final FieldConfigProperties DEPENDENT_FIELD
      Campo que o atual depende (para comportamento dinâmico)

    • RESET_ON_DEPENDENT_CHANGE

      public static final FieldConfigProperties RESET_ON_DEPENDENT_CHANGE
      Define se o valor deve ser resetado quando o campo dependente mudar

    • INLINE_EDITING

      public static final FieldConfigProperties INLINE_EDITING
      Indica se o campo pode ser editado inline

    • TRANSFORM_VALUE_FUNCTION

      public static final FieldConfigProperties TRANSFORM_VALUE_FUNCTION
      Define se o campo é transformado através de uma função customizada

    • DEBOUNCE_TIME

      public static final FieldConfigProperties DEBOUNCE_TIME
      Tempo de debounce para validações ou ações

    • HELP_TEXT

      public static final FieldConfigProperties HELP_TEXT
      Texto de ajuda que pode ser exibido para o usuário

    • HINT

      public static final FieldConfigProperties HINT
      Dica ou hint exibido próximo ao campo

    • HIDDEN_CONDITION

      public static final FieldConfigProperties HIDDEN_CONDITION
      Define a condição que determina se o campo deve ser ocultado

    • TOOLTIP_ON_HOVER

      public static final FieldConfigProperties TOOLTIP_ON_HOVER
      Define o tooltip que será exibido quando o usuário passar o mouse sobre o campo. Essa propriedade pode auxiliar na compreensão do propósito ou funcionamento do campo.

    • ICON

      public static final FieldConfigProperties ICON
      Define o ícone associado ao campo

    • ICON_POSITION

      public static final FieldConfigProperties ICON_POSITION
      Posição do ícone em relação ao campo

    • ICON_SIZE

      public static final FieldConfigProperties ICON_SIZE
      Tamanho do ícone

    • ICON_COLOR

      public static final FieldConfigProperties ICON_COLOR
      Cor do ícone

    • ICON_CLASS

      public static final FieldConfigProperties ICON_CLASS
      Classe CSS para o ícone

    • ICON_STYLE

      public static final FieldConfigProperties ICON_STYLE
      Estilo inline para o ícone

    • ICON_FONT_SIZE

      public static final FieldConfigProperties ICON_FONT_SIZE
      Tamanho da fonte para o ícone

    • VALUE_FIELD

      public static final FieldConfigProperties VALUE_FIELD
      Campo que representa o valor (para selects, por exemplo)

    • DISPLAY_FIELD

      public static final FieldConfigProperties DISPLAY_FIELD
      Campo que representa o rótulo ou descrição a ser exibido

    • ENDPOINT

      public static final FieldConfigProperties ENDPOINT
      Endpoint para obtenção de dados ou opções dinâmicas

    • EMPTY_OPTION_TEXT

      public static final FieldConfigProperties EMPTY_OPTION_TEXT
      Texto para opção vazia (quando nenhuma opção é selecionada)

    • OPTIONS

      public static final FieldConfigProperties OPTIONS
      Lista de opções disponíveis para o campo, usado em campos de listas como combobox

    • VALUE_PRESENTATION

      public static final FieldConfigProperties VALUE_PRESENTATION
      Contrato canônico de apresentação de valor para display/read-only

    • FILTER

      public static final FieldConfigProperties FILTER
      Define a propriedade de filtro (pode indicar o tipo de operação ou similar)

    • FILTER_OPTIONS

      public static final FieldConfigProperties FILTER_OPTIONS
      Define as opções disponíveis para filtros, quando aplicável

    • NUMERIC_FORMAT

      public static final FieldConfigProperties NUMERIC_FORMAT
      Define o tipo de formatação de um input numérico

    • NUMERIC_STEP

      public static final FieldConfigProperties NUMERIC_STEP
      Define a quantidade de incremento ou decremento por step de um input numérico

    • NUMERIC_MIN

      public static final FieldConfigProperties NUMERIC_MIN
      Define o valor mínimo para um input numérico

    • NUMERIC_MAX

      public static final FieldConfigProperties NUMERIC_MAX
      Define o valor máximo para um input numérico

    • NUMERIC_MAX_LENGTH

      public static final FieldConfigProperties NUMERIC_MAX_LENGTH
      Define a quantidade máxima de caracteres de um input numérico

  • Method Details

    • values

      public static FieldConfigProperties[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static FieldConfigProperties valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getValue

      public String getValue()

    • fromValue

      public static FieldConfigProperties fromValue(String value)