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 
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
setIcons(iconsArray AS JsonArray)icons (JsonArray) em formato string, somente para o type 'icon'
setDefaultBooleanIcons(trueToolTip AS char, falseTollTip AS char)Seta a 
getBooleanIcons(trueIcon AS char, falseIcon AS char, trueColor AS char, falseColor AS char, trueToolTip AS char, falseTollTip AS char)
setColumns(columnsArray AS JsonArray)
addColumnProperty(columnProperty AS char, columnLabel AS CHAR, columnType AS CHAR, visible_ AS log, width_ AS CHAR, format_ AS CHAR)
addColumnProperty(columnProperty AS char, columnLabel AS CHAR, columnType AS CHAR, visible_ AS log)
addColumnProperty(columnProperty AS char, columnLabel AS CHAR, columnType AS CHAR)
addColumnValueProperty(columnProperty AS char, columnLabel AS CHAR, columnType AS CHAR, visible_ AS LOG, width_ AS CHAR, format_ AS CHAR)
addColumnValueProperty(columnProperty AS char, columnLabel AS CHAR, columnType AS CHAR, visible_ AS LOG)
addColumnValueProperty(columnProperty AS char, columnLabel AS CHAR, columnType AS CHAR)
addColumnLabelProperty(columnProperty AS char, columnLabel AS CHAR, columnType AS CHAR, visible_ AS LOG, width_ AS CHAR, format_ AS CHAR)
addColumnLabelProperty(columnProperty AS char, columnLabel AS CHAR, columnType AS CHAR, visible_ AS LOG)
addColumnLabelProperty(columnProperty AS char, columnLabel AS CHAR, columnType AS CHAR)
getCurrentDetail()
setColumnDetailParams(typeHeader AS char, hideSelect AS LOG)
addColumnDetailProperty(columnDetailProperty AS char, columnDetailLabel AS CHAR, columnDetailType AS CHAR, columnDetailFormat AS CHAR)
setLabels(labelsArray AS JsonArray)
addLabelProperty(labelValue AS CHAR, labelColor AS CHAR, labelLabel AS CHAR, labelTooltip AS CHAR)
addLabelProperty(labelValue AS INT, labelColor AS CHAR, labelLabel AS CHAR, labelTooltip AS CHAR)
addLabelProperty(labelValue AS LOG, labelColor AS CHAR, labelLabel AS CHAR, labelTooltip AS CHAR)
addLabelProperty(objLabel AS JSonObject, labelColor AS CHAR, labelLabel AS CHAR, labelTooltip AS CHAR)
setSubTitles(subTitlesArray AS JsonArray)
addSubTitleProperty(subTitleTableValue AS CHAR, subTitleColor AS CHAR, subTitleLabel AS CHAR, subTitleContent AS CHAR)
addSubTitleProperty(subTitleTableValue AS INT, subTitleColor AS CHAR, subTitleLabel AS CHAR, subTitleContent AS CHAR)
addSubTitleProperty(subTitleTableValue AS LOG, subTitleColor AS CHAR, subTitleLabel AS CHAR, subTitleContent AS CHAR)
addSubTitleProperty(objSubTitle AS JSonObject, subTitleColor AS CHAR, subTitleLabel AS CHAR, subTitleContent AS CHAR)
setDivider(divider_ AS char)
setGeneralGridColumnsDefault(generalGridColumnsDefault AS int)
setGridColumnsDefault(gridColumns_ AS int)
setGridColumns(gridLgColumns_ AS INT, gridMdColumns_ AS INT, gridSmColumns_ AS INT, gridXlColumns_ AS INT)
setMaxLength(maxLength_ AS INT)
setMinLength(minLength_ AS INT)
setMaxValue(maxValue_ AS CHAR)
setMinValue(minValue_ AS CHAR)
setMask(mask_ AS CHAR)
setHelp(help_ AS CHAR)
setBooleanTrue(booleanTrue_ AS CHAR)
setBooleanFalse(booleanFalse_ AS CHAR)
setSearchService(searchService_ AS CHAR)
setFieldValue(fieldValue_ AS CHAR)
setFieldLabel(fieldLabel_ AS CHAR)
setFieldPlaceholder(fieldPlaceholder_ AS CHAR)
setRequired(required_ AS LOG)
setOptional(optional_ AS LOG)
setSecret(secret_ AS LOG)
setRows(rows_ AS INT)
setOptionsMulti(optionsMulti_ AS LOG)
setPattern(pattern_ AS CHAR)
setOptionsService(optionsService_ AS CHAR)
setValidate(validate_ AS CHAR)
setErrorMessage(errorMessage_ AS CHAR)
setFormat(format_ AS CHAR)
setFormat(format_ AS longchar)
setFormat(formatJsonArray AS JsonArray)
setFormatPropertyList(propertyFormatList_ AS CHAR)
disableAll()
enableOrder()
disableOrder()
setIcon(icon_ AS CHAR)
setDecimalsLength(decimalsLength_ AS INT)
setThousandMaxlength(thousandMaxlength_ AS INT)
copyPropertiesOfField(propertyToBeCopy AS CHAR)
translate(c-literal AS char)
translate(c-literal AS char, c-context AS char)
parseToJsonObject(cJson AS char)
parseToJsonArray(cJson AS char)
createField()
toJsonArray(groupId_ as char)
toJsonArray()
toJsonObject()