Árvore de páginas

CONTEÚDO

  1. Visão geral
  2. Construtores
  3. Métodos disponíveis

01. VISÃO GERAL

Classe utilitária para auxiliar na geração de campos em tela para o padrão do PO-UI.

02. CONSTRUTORES

ConstrutorDescrição
Fields()Construtor padrão
Fields(c-dialect AS char)Construtor com a inicialização com um dialeto específico
Fields(h-tt-api AS handle)Construtor com a handle da temp-table relacionada a API
Fields(h-tt-api AS handle, c-except-fields AS char)Construtor com a handle da temp-table relacionada a API e fields exceção (separado por virgula)

03. MÉTODOS DISPONÍVEIS

MétodoDescrição
initialize(c-dialect AS char)

Inicializa a mensagem com um dialeto específico

Caso seja enviado em branco, será considerado o dialeto do usuário logado

loadFieldsFromTableBufferHandle(h-tt-api AS handle, c-except-fields AS char)Carrrega os campos de acordo com a handle da temp-table enviada desconsiderando as fields de exceção (separado por virgula)
loadFieldFromTableBufferHandle(h-tt-api AS handle, c-field AS char)Carrrega os campos (c-field) enviado como parâmetro de acordo com a handle da temp-table enviada
setCurrentGroupId(currentGroupId AS char)Seta o id do grupo
setCurrentField(property_ AS char)Retorna se existe um campo de acordo com o parâmetro enviado
removeField(property_ AS char)Remove um determinado campo enviado como parâmetro
addField(table_ AS char, property_ AS char, label_ AS char, type_ AS char)Adiciona um campo de acordo com as propriedades
addField(table_ AS char, property_ AS char, hide_ AS log, disabled_ AS log)Adiciona um campo de acordo com as propriedades, onde pode ser enviado parâmetros de esconder e desabilitar
addField(property_ AS char)Adiciona um campo (sem tabela)
addField(property_ AS char, hide_ AS log, disabled_ AS log)Adiciona um campo (sem tabela) onde pode ser escondido e / ou desabilitado
addField(property_ AS char, label_ AS char)Adiciona um campo (sem tabela) com sua respectiva label
addField(property_ AS char, label_ AS char, type_ AS char)Adiciona um campo (sem tabela) com sua respectiva label e pode ser informado seu tipo
setDefaultTranslateLabels(defaultTranslateLabels_ AS log)Habilita / desabilita a tradução das literais
translateField()Habilita a tradução do campo
notTranslateField()Desabilita a tradução do campo
setDefaultTranslateContext(defaultTranslateContext_ AS char)

Seta um contexto padrão para a tradução

  • Caso não seja setado um valor, é utilizado o contexto * para tradução (ut-liter) dos labels 
setFieldTranslateContext(fieldTranslateContext_ AS char)

Seta um contexto para a tradução por campo

  • Caso não seja setado, é utilizado o contexto padrão (defaultTranslateContext)
setParams(params AS JSonObject)

Seta os parâmetros utilizados em componentes de lookup ou combo

getParams()Retorna um JsonObject com os parâmetros do campo
addParam(paramName AS char, paramValue AS char)

Adiciona um parâmetro em formato de character

  • Exemplo: { module: 'APB' }
addParam(paramName AS char, paramValue AS date)Adiciona um parâmetro em formato data
addParam(paramName AS char, paramValue AS log)Adiciona um parâmetro em formato logical
addParam(paramName AS char, paramValue AS decimal)Adiciona um parâmetro em formato decimal
addParam(paramName AS char, paramValue AS int)Adiciona um parâmetro em formato integer
setGroupId(groupId_ AS char)Seta o id do grupo
setHide(hide_ AS log)Seta o campo para ser escondido (lógica contrária ao visible)
setVisible(visible_ AS log)Seta o campo para estar visível
setKey()Seta o campo como chave primaria da tabela 
setNotKey()Seta o campo que não representa a chave primária
setType(type_ AS char)

Seta o tipo do campo

Tipos permitidos:

  • STRING
  • BOOLEAN
  • NUMBER
  • DATE
  • DATETIME
  • TIME
  • CURRENCY
setTypeProgress(typeProgress_ AS char)

Seta o tipo do campo com a linguagem Progress

setColor(color_ AS char)Seta a cor que será aplicado no conteúdo da coluna
setWidth(width_ AS char)

Seta a largura da coluna

  • Pode ser informada em pixels ou porcentagem. (Exemplo: '100px' ou '20%')
setToolTip(tooltip_ AS char)Seta o texto de ajuda que será exibido ao passar o mouse sobre um texto
setLink(link_ AS char)Seta o nome da propriedade que conterá o link a ser redirecionado
setDisabled(disabled_ AS log)Habilita / desabilita um campo
setFilter(filter_ AS log)Seta que o campo será utilizado para busca avançada 
setTag(tag_ AS log)Seta a tag, utilizado em dynamic view
setDuplicate(duplicate_ AS log)Seta se o campo será duplicado caso seja executada uma ação de duplicação
setSortable(sortable_ AS log)

Seta se a coluna é considerada como "ordenável"

  • Caso seja definido um valor falso, a coluna não será usada para ordenação
setAllowColumnsManager(allowColumnsManager_ AS log)

Seta a condição se do campo aparecer no gerenciador de colunas mesmo com a parametrização de visible: false, onde possibilita ativar a exibição na tabela

setFilterInitValue(filterInitValue_ AS longchar)

Seta o filtro inicial para o campo do tipo LONGCHAR

  • Utilizado em conjunto com o filter
setFilterInitValue(filterInitValue_ AS char)

Seta o filtro inicial para o campo do tipo CHARACTER

  • Utilizado em conjunto com o filter
setFilterInitValue(filterInitValue_ AS log)

Seta o filtro inicial para o campo do tipo LOGICAL

  • Utilizado em conjunto com o filter
setFilterInitValue(filterInitValue_ AS decimal)

Seta o filtro inicial para o campo do tipo DECIMAL

  • Utilizado em conjunto com o filter
setFilterInitValue(filterInitValue_ AS int)

Seta o filtro inicial para o campo do tipo INTEGER

  • Utilizado em conjunto com o filter
setFilterInitValue(filterInitValue_ AS date)

Seta o filtro inicial para o campo do tipo DATE

  • Utilizado em conjunto com o filter
setFilterInitValue(filterInitValue_ AS datetime)

Seta o filtro inicial para o campo do tipo DATETIME

  • Utilizado em conjunto com o filter
setFilterInitValue(filterInitValueJsonArray AS JsonArray)

Seta o filtro inicial para o campo do tipo JSONARRAY

  • Utilizado em conjunto com o filter
setFilterInitValue(filterInitValueJsonObject AS JsonObject)

Seta o filtro inicial para o campo do tipo JSONOBJECT

  • Utilizado em conjunto com o filter
setOptions(options_ AS char)

Seta o valor a ser utilizado no componente Radio Button ou Select 

  • Exemplo: oMetadados:setOptions({ininc/i02in295.i 07})
    • Utilizar a opção 07 das includes
  • Por padrão o valor é inteiro, se o valor for caracter usar setOptionsString
setOptionsString(options_ AS char)Seta o valor (caracter) a ser utilizado no componente Radio Button ou Select 
setOptionsDecreaseOne(options_ AS char)

Seta o valor a ser utilizado no componente Radio Button ou Select, mas diminui um do código que veio na listagem, se começa em 1, o primeiro código será 0.        

createLabelsOfIntegerOptions()

Gera as labels para a lista de options, com a utilização do tipo INTEGER, utilizado em componentes do tipo Radio Button ou Select

  • Exemplo: c-lista = {ininc/i02in295.i 07} (usar a opcao 07 das includes)
createLabelsOfCharacterOptions()Gera as labels para a lista de options, com a utilização tipo CHARACTER, utilizado em componentes do tipo Radio Button ou Select
createLabelsOfOptions(typeProgress as char)

Gera as labels para a lista de options de acordo com o parâmetro informado

Tipos de parâmetros permitidos:

  • INT
  • CHAR
setLabel(label_ AS char)Seta a label do campo
isDisabled(property_ AS char)Retorna um LOGICAL com a informação se o campo está desabilitado
isHide(property_ AS char)Retorna um LOGICAL com a informação se o campo está visível
addIcon (iconStr AS char, labelTooltip AS char, valueStr AS char)

Seta os ícones para a utilização nos campos

addIcon (iconStr AS char, iconColor AS char, labelTooltip AS char, valueStr AS char)

Seta os ícones para a utilização nos campos

setIcons(iconsArray AS JsonArray)

Seta os ícones para a utilização nos campos

Deve ser informado um JsonArray em formato string, utilizado somente para o type icon

setDefaultBooleanIcons(trueToolTip AS char, falseTollTip AS char)

Seta ícones booleanos padrão

  • true representado po-icon-ok
  • false representado por po-icon-minus)
getBooleanIcons(trueIcon AS char, falseIcon AS char, trueColor AS char, falseColor AS char, trueToolTip AS char, falseTollTip AS char)

Retorna um JsonArray com ícones booleanos padrão

  • true representado po-icon-ok
  • false representado por po-icon-minus)
setColumns(columnsArray AS JsonArray)Seta as colunas no formato JsonArray para a utilização em lookup 
addColumnProperty(columnProperty AS char, columnLabel AS CHAR, columnType AS CHAR, visible_ AS log, width_ AS CHAR, format_ AS CHAR)Adiciona uma coluna de acordo com as propriedades informadas
addColumnProperty(columnProperty AS char, columnLabel AS CHAR, columnType AS CHAR, visible_ AS log)

Adiciona uma coluna de acordo com as propriedades informadas, neste método os parâmetros abaixo não são adicionados

  • width
  • format
addColumnProperty(columnProperty AS char, columnLabel AS CHAR, columnType AS CHAR)

Adiciona uma coluna de acordo com as propriedades informadas, neste método os parâmetros abaixo não são adicionados

  • visible
  • width
  • format
addColumnValueProperty(columnProperty AS char, columnLabel AS CHAR, columnType AS CHAR, visible_ AS LOG, width_ AS CHAR, format_ AS CHAR)Adiciona uma coluna de acordo com as propriedades e a insere como valor do campo
addColumnValueProperty(columnProperty AS char, columnLabel AS CHAR, columnType AS CHAR, visible_ AS LOG)Adiciona uma coluna de acordo com as propriedades e a insere como valor do campo, neste método os parâmetros abaixo não são adicionados
  • width
  • format
addColumnValueProperty(columnProperty AS char, columnLabel AS CHAR, columnType AS CHAR)Adiciona uma coluna de acordo com as propriedades e a insere como valor do campo, neste método os parâmetros abaixo não são adicionados
  • visible
  • width
  • format
addColumnLabelProperty(columnProperty AS char, columnLabel AS CHAR, columnType AS CHAR, visible_ AS LOG, width_ AS CHAR, format_ AS CHAR)Adiciona uma coluna de acordo com as propriedades e a insere como label no campo
addColumnLabelProperty(columnProperty AS char, columnLabel AS CHAR, columnType AS CHAR, visible_ AS LOG)Adiciona uma coluna de acordo com as propriedades e a insere como label no campo, neste método os parâmetros abaixo não são adicionados
  • width
  • format
addColumnLabelProperty(columnProperty AS char, columnLabel AS CHAR, columnType AS CHAR)Adiciona uma coluna de acordo com as propriedades e a insere como label no campo, neste método os parâmetros abaixo não são adicionados
  • visible
  • width
  • format
getCurrentDetail()Retorna um JsonObject com os detalhes do campo
setColumnDetailParams(typeHeader AS char, hideSelect AS LOG)Seta os atributos typeHeader e hideSelect nos detalhes da coluna
addColumnDetailProperty(columnDetailProperty AS char, columnDetailLabel AS CHAR, columnDetailType AS CHAR, columnDetailFormat AS CHAR)Adiciona uma coluna com os atributos dos detalhes
setLabels(labelsArray AS JsonArray)Seta uma lista de label do tipo PoTableColumnLabel
addLabelProperty(labelValue AS CHAR, labelColor AS CHAR, labelLabel AS CHAR, labelTooltip AS CHAR)Adiciona um valor (tipo CHARACTER) para as propriedades da label
addLabelProperty(labelValue AS INT, labelColor AS CHAR, labelLabel AS CHAR, labelTooltip AS CHAR)Adiciona um valor (tipo INTEGER) para as propriedades da label
addLabelProperty(labelValue AS LOG, labelColor AS CHAR, labelLabel AS CHAR, labelTooltip AS CHAR)Adiciona um valor (tipo LOGICAL) para as propriedades da label
addLabelProperty(objLabel AS JSonObject, labelColor AS CHAR, labelLabel AS CHAR, labelTooltip AS CHAR)Adiciona um valor (tipo JsonObject) para as propriedades da label
setSubTitles(subTitlesArray AS JsonArray)

Seta as legendas do tipo PoTableSubtitle, definidas por um array de objetos.

addSubTitleProperty(subTitleTableValue AS CHAR, subTitleColor AS CHAR, subTitleLabel AS CHAR, subTitleContent AS CHAR)Adiciona uma legenda (tipo CHARACTER) de acordo com os parâmetros enviados 
addSubTitleProperty(subTitleTableValue AS INT, subTitleColor AS CHAR, subTitleLabel AS CHAR, subTitleContent AS CHAR)Adiciona uma legenda (tipo INTEGER) de acordo com os parâmetros enviados
addSubTitleProperty(subTitleTableValue AS LOG, subTitleColor AS CHAR, subTitleLabel AS CHAR, subTitleContent AS CHAR)Adiciona uma legenda (tipo LOGICAL) de acordo com os parâmetros enviados
addSubTitleProperty(objSubTitle AS JSonObject, subTitleColor AS CHAR, subTitleLabel AS CHAR, subTitleContent AS CHAR)Adiciona uma legenda (tipo JsonObject) de acordo com os parâmetros enviados
setDivider(divider_ AS char)

Seta um divisor com o parâmetro como titulo

  • O divisor será exibido acima do conteúdo  
setGeneralGridColumnsDefault(generalGridColumnsDefault AS int)Seta um valor padrão da quantidade de colunas para todos os campos
setGridColumnsDefault(gridColumns_ AS int)Seta um valor padrão da quantidade de colunas
setGridColumns(gridLgColumns_ AS INT, gridMdColumns_ AS INT, gridSmColumns_ AS INT, gridXlColumns_ AS INT)

Seta valores (1 ... 12 colunas) para o tamanho de exibição dos campos para telas grandes (lg). telas médias (md), telas menores (sm) e telas extra grandes (xl).

setMaxLength(maxLength_ AS INT)Seta o tamanho máximo de caracteres
setMinLength(minLength_ AS INT)Seta o tamanho mínimo de caracteres
setMaxValue(maxValue_ AS CHAR)

Seta o valor máximo do campo

Tipo de dado permitido:

  • Number
    • Informar no formato 99,99 
  • Date
  • DateTime
setMinValue(minValue_ AS CHAR)

Seta o valor mínimo do campo

Tipo de dado permitido:

  • Number
    • Informar no formato 99,99 
  • Date
  • DateTime
setMask(mask_ AS CHAR)Seta o valor da máscara para o campo
setMaskFormatModel (maskFormatModel_ AS log)Indica se o model receberá o valor formatado pela máscara ou apenas o valor puro (sem formatação).
setRange (range_ AS log)Permitir a entrada de um intervalo ao invés de um único valor. Atualmente essa propriedade esta disponível apenas para o tipo 'date' e 'dateTime'.
setMultiple (multiple_ AS log)Permite a seleção de múltiplos itens. Componentes compatíveis: po-lookup, po-upload
setHelp(help_ AS CHAR)Seta o texto de ajuda
setBooleanTrue(booleanTrue_ AS CHAR)

Seta a descrição para campos lógicos de valor TRUE

  • Caso não seja definido, o valor inicial é Ativado
setBooleanFalse(booleanFalse_ AS CHAR)

Seta a descrição para campos lógicos de valor FALSE

  • Caso não seja definido, o valor inicial é Desativado
setSearchService(searchService_ AS CHAR)Seta o valor do serviço de busca
setFieldValue(fieldValue_ AS CHAR)

Seta a propriedade que será utilizado como valor do campo.

Pode ser utilizado em conjunto com:

  • optionsService
  • searchService 
setFieldLabel(fieldLabel_ AS CHAR)

Seta a propriedade que será utilizado como descrição do campo.

Pode ser utilizado em conjunto com:

  • optionsService
  • searchService
setFieldPlaceholder(fieldPlaceholder_ AS CHAR)

Seta a propriedade que será utilizado como placeholder do campo.

Pode ser utilizado em conjunto com:

  • optionsService
  • searchService
setRequired(required_ AS LOG)Define que o campo pode ser obrigatório 
setOptional(optional_ AS LOG)Define que o campo pode ser opcional
setSecret(secret_ AS LOG)

Define que o campo é do estilo password, sendo utilizado quando o tipo de dado for string. 

setRows(rows_ AS INT)Seta a quantidade de linhas exibidas no componente po-textarea
setOptionsMulti(optionsMulti_ AS LOG)Define que o campo pode ter múltipla seleção, dentro de uma lista de opções
setPattern(pattern_ AS CHAR)Seta a expressão regular para a validação do campo
setOptionsService(optionsService_ AS CHAR)Seta o serviço que será utilizado para buscar os itens e preencher a lista de opções dinamicamente
setValidate(validate_ AS CHAR)

Seta o endpoint usado pelo componente para requisicao via POST.

  • No backend não é possível utilizar a opção "Function"
setErrorMessage(errorMessage_ AS CHAR)Seta a mensagem apresentada quando o campo for inválido
setFormat(format_ AS CHAR)

Seta o formato para a exibição de datas, com o parametro de entrada como CHARACTER

Valores permitidos:

  • dd/mm/yyyy
  • mm/dd/yyyy
  • yyyy/mm/dd 
setFormat(format_ AS longchar)

Seta o formato para a exibição de datas, com o parametro de entrada como LONGCHAR

Valores permitidos:

  • dd/mm/yyyy
  • mm/dd/yyyy
  • yyyy/mm/dd 
setFormat(formatJsonArray AS JsonArray)

Seta o formato para a exibição de datas, definidos por um JsonArray

Valores permitidos:

  • dd/mm/yyyy
  • mm/dd/yyyy
  • yyyy/mm/dd 
setFormatPropertyList(propertyFormatList_ AS CHAR)Seta uma lista de formatos, separados por , (vírgula)
disableAll()Desabilita todos os campos
enableOrder()Habilita a ordenação dos campos
disableOrder()Desabilita a ordenação dos campos
setIcon(icon_ AS CHAR)

Define um ícone para ser utilizado no campo

  • Lista de ícones disponíveis na biblioteca do PO-UI
setDecimalsLength(decimalsLength_ AS INT)

Seta a quantidade máxima de casas decimais

  • Esta propriedade somente pode ser utilizada quando o tipo do campo for CURRENCY 
setThousandMaxlength(thousandMaxlength_ AS INT)

Seta a quantidade máxima de dígitos antes do separador decimal.

  • O valor máximo permitido é 13.
  • Esta propriedade so pode ser utilizada quando o tipo do campo for CURRENCY 
forceBooleanComponentType (forceBooleanComponentType_ AS CHAR)Permite a escolha entre Switch ou Checkbox para campos Booleanos. Disponível para a versão do PO-UI 16.7 ou acima.

showRequired (showRequired_ AS LOG)Exibe a label (obrigatório) caso o required_ seja TRUE.

setAdvancedFilters (advancedFiltersJsonArray AS JsonArray)JsonArray criado a partir da Fields com a definição dos campos da busca avançada.
copyPropertiesOfField(propertyToBeCopy AS CHAR)Copia as propriedades do campo
translate(c-literal AS char)Retorna um CHARACTER com a literal traduzida de acordo com o dialeto especificado
translate(c-literal AS char, c-context AS char)Retorna um CHARACTER com a literal traduzida de acordo com o dialeto e contexto especificados
parseToJsonObject(cJson AS char)Retorna um JsonObject a partir de um CHARACTER
parseToJsonArray(cJson AS char)Retorna um JsonArray a partir de um CHARACTER
createField()Efetua a criação de um campo de acordo com os métodos previamente setados
toJsonArray(groupId_ as char)Retorna um JsonArray de acordo com o groupId informado
toJsonArray()Retorna um JsonArray relacionado aos campos (fields)
toJsonObject()Retorna um JsonObject com informações do campo