FWFormGridModel

FWFORMGRIDMODEL():ClassName()-> NIL

Fornece o nome da classe

FWFORMGRIDMODEL():SetLPost(<bLinePost >)-> NIL

Configura o bloco de código de pós validação da linha do grid.
A Pós-validação será realizada na validação do submodelo no momento da gravação dos dados e durante a inclusão de uma nova linha.

 

FWFORMGRIDMODEL():SetLPre(<bLinePre >)-> NIL

Configura o bloco código de pré validação da linha do grid.
O bloco será invocado durante qualquer tentativa de atribuição de valor na linha.
O Bloco deve retornar um valor lógico, caso retorne falso a atribuição de valor não será permitida.

 

FWFORMGRIDMODEL():SetUseOldGrid([ lUseCols ])-> NIL

Indica que o submodelo deve trabalhar com aCols/aHeader.
Este método é utilizado para compatibilizar com o Browse antigo do Protheus

 

FWFORMGRIDMODEL():SetStruct(<oFormModelStruct >)-> NIL

Configura o objeto com a estrutura de dados

 

FWFORMGRIDMODEL():GetOldData()-> aData

Fornece um objeto com a folha de dados de compatibilidade com o aCols/aHeader.

aData Array com a seguinte estrutura:
[1] aHeader
[2] aCols

FWFORMGRIDMODEL():AddLine()-> nLine

O grid inicia sempre com uma linha. Esse método AddLine deve ser usado para adicionar novas linhas.
O método retorna a quantidade total de linhas da grid. Se a grid já possui 2 linhas e tudo correu bem na adição da linha, o AddLine retornara 3, se ocorreu algum problema
retornará 2, pois a nova linha não foi inserida.
Os motivos para a inserção não ser bem sucedida podem ser algum campo obrigatório não informado, a pós-validação da linha retornou falso ou o grid atingiu a quantidade máxima de linhas, por exemplo.
Se a linha for incluida com sucesso o grid posiciona na mesma.

nLine Indica a quantidade de linhas do grid

Length

FWFORMGRIDMODEL():UnDeleteLine()-> lDeleted

Desfaz a deleção da linha atual no Grid.

lDeleted Indica se a deleção foi desfeita com sucesso.

FWFORMGRIDMODEL():DeleteLine()-> lDeleted

Deleta a linha atual no Grid de forma lógica, marcando a mesma como deletada.

É possível desfazer essa deleção via o método UnDeleteLine.

lDeleted Indica se a linha foi deletada com sucesso

FWFORMGRIDMODEL():IsUpdated([ nLine ])-> lUpdated

Indica se a linha recebeu valores

 Retorno

lUpdated Indica se a linha recebeu valores

FWFORMGRIDMODEL():SetNoInsertLine([ lSet ])-> NIL

Especifica que o grid não pode receber inserção de linha

 

FWFORMGRIDMODEL():SetNoUpdateLine([ lSet ])-> NIL

Especifica que o grid não pode receber alteração nas linhas

 

FWFORMGRIDMODEL():SetNoDeleteLine([ lSet ])-> NIL

Especifica que o grid não pode receber exclusão de linha

FWFORMGRIDMODEL():IsDeleted([ nLine ])-> lDeleted

Fornece se a linha esta deletada

lDeleted Indica se a linha esta deletada

FWFORMGRIDMODEL():SetLine([ nLine ])-> nLine

Altera a linha em que o Grid está posicionado, se e somente se, a linha atual estiver valida.

 

nLine Indica a linha atualmente posicionada

FWFORMGRIDMODEL():GoLine(<nLine >)-> nLine

Altera a linha em que o Grid está posicionado, mesmo se a linha atual
estiver invalida

 

nLine Indica a linha atual

SetLine

FWFORMGRIDMODEL():GetLine()-> nLine

Fornece a linha do atualmente posicionada no Grid

nLine Indica a linha atual

FWFORMGRIDMODEL():SetValue(<cId >, [ xValue ])-> lAtribuido

Atribui um valor a folha de dados do submodelo

lAtribuido Indica que o valor foi atribuído

CanSetValue

FWFORMGRIDMODEL():LoadValue(<cId >, [ xValue ])-> lAtribuido

Carrega um valor a folha de dados do objeto. Este método somente pode ser utilizado quando há SetValue na pilha de chamadas
de função ( CallStack ). Diferentemente do método SetValue, este método não executa a validação do campo, mas fornece
todas as indicações de que ele foi atualizado. Ele é muito útil quando dentro de uma validação de campo, necessitamos
alterar valores de outros campos, sem que isto implique em validá-los.

lAtribuido Indica que o valor foi atribuído

FWFORMGRIDMODEL():GetValue(<cId >, [ nLine ])-> xRetorno

Fornece o valor da folha de dados de um campo do submodelo

xRetorno Valor do campo

FWFORMGRIDMODEL():VldLineData(<lVldOwner >)-> lRetorno

Valida a linha atualmente posicionada no grid

lRetorno Indica que a linha atual está valida

FWFORMGRIDMODEL():VldData(<lVldOwner >)-> lRetorno

Valida a folha de dados do submodelo

 

lRetorno Indica que a folha de dados é valida

FWFORMGRIDMODEL():CanSetValue(<cId >)-> lRetorno

Verificar se pode-se atribuir um valor a folha de dados do submodelo

lRetorno Indica se o valor foi atribuído

FWFORMGRIDMODEL():SetLoadFilter([ aLoadFilter ], [ cLoadFilter ])-> NIL

Atribui o critério de filtro a ser usado na carga do formulário de dados

 Exemplo

// Para dado igual a
oModel:GetModel( 'IDGRID' ):SetLoadFilter( { { 'ZA2_AUTOR', "'000500'" } } )

// Para dado igual a um ou outro valor
oModel:GetModel( 'IDGRID' ):SetLoadFilter( { { 'ZA2_AUTOR', "'000500'" }, { 'ZA2_AUTOR', "'000600'",, MVC_LOADFILTER_OR } } )

// Para dado diferente
oModel:GetModel( 'IDGRID' ):SetLoadFilter( { { 'ZA2_AUTOR', "'000500'", MVC_LOADFILTER_NOT_EQUAL } } )

// Para dado maior que valor
oModel:GetModel( 'IDGRID' ):SetLoadFilter( { { 'ZA2_VALOR', "0", MVC_LOADFILTER_GREATER } } )

// Para dado entre um valor e outro
oModel:GetModel( 'IDGRID' ):SetLoadFilter( { { 'ZA2_VALOR', "0", MVC_LOADFILTER_GREATER_EQUAL }, { 'ZA2_VALOR', "100", MVC_LOADFILTER_LESS_EQUAL } } )

// Para dado que contém um valor
oModel:GetModel( 'IDGRID' ):SetLoadFilter( { { 'ZA2_AUTOR', "'0005'", MVC_LOADFILTER_CONTAINS } } )

// Para dado que está contido
oModel:GetModel( 'IDGRID' ):SetLoadFilter( { { 'ZA2_AUTOR', "{'000500','000501'}", MVC_LOADFILTER_IS_CONTAINED } } )

// Usando uma expressão
oModel:GetModel( 'IDGRID' ):SetLoadFilter( , " ( ZA2_AUTOR >= '000500' .AND. ZA2_AUTOR < '000600' ) .OR. ZA2_VALOR > 0 " )

FWFORMGRIDMODEL():GetLoadFilter()-> aRelation

Fornece o critério de filtro na carga do formulário de dados

aRelation Estrutura de relacionamento
            [1] cIdField do submodelo de destino
            [2] cIdField ou expressão do submodelo de destino
            [3] Operador

FWFORMGRIDMODEL():SetUniqueLine(<aUnique >, [ bUnique ])-> NIL

Define que determinado(s) campo(s) não pode ser repetido dentro do grid.

 

oModel:GetModel( 'ZA2DETAIL' ):SetUniqueLine( { "ZA2_AUTOR" , "ZA2_ITEM"} )

FWFORMGRIDMODEL():SetDelAllLine([ lDelAllLine ])-> NIL

Especifica se todas as linha do grid podem ser apagadas.

FWFORMGRIDMODEL():DelAllLine()-> NIL

Esse método apaga todas as linhas do grid.

FWFORMGRIDMODEL():copyDataFromGrid(<oGrid >)-> NIL

Esse método copia as linhas e dados de um grid para o objeto em questão.

Esse método só pode ser executado se o Grid base possuir a mesma estrutura que o Grid destino.

FWFORMGRIDMODEL():GetQTDLine()-> NIL

Retornar a quantidade de linhas do grid.

Use o método Length

FWFORMGRIDMODEL():Length([ lOnlyActive ])-> nMax

Retorna a quantidade de linhas que o grid possui

nMax Quantidade de linhas

FWFORMGRIDMODEL():CanInsertLine()-> lInsertLine

Informa se o grid aceita a inserção de novas linhas

lInsertLine Se verdadeiro o grid permite a inclusão de linhas

FWFORMGRIDMODEL():CanUpdateLine()-> lUpdateLine

Informa se o grid aceita edição nas linhas

lUpdateLine Se verdadeiro o grid permite a edição de linhas

FWFORMGRIDMODEL():CanDeleteLine()-> lDeleteLine

Informa se o grid aceita que as linhas sejam apagadas

lDeleteLine Se verdadeiro o grid permite a exclusão de linhas

FWFORMGRIDMODEL():SeekLine(<aBusca >, [ lDeleted ], [lLocate] )-> lRetorno

Localiza uma linha baseada no conteúdo dos campos informados
como parâmetro. Se houver mais de uma linha com os valores procurados,
o método irá retornar a primeira linha que for encontrada.

 

lRetorno Indica se a linha foi encontrada

oGrid:SeekLine({{"XXH_MODULO",cModule},{"XXH_CODIGO",cCode}})

FWFORMGRIDMODEL():IsFieldUpdated(<cID >, [ nLine ])-> lRet

Retorna se um Campo foi atualizado

 

lRet Indica que o valor foi Atualizado

FWFORMGRIDMODEL():SetMaxLine(<nMax >)-> NIL

Determina quantas linhas o grid pode possuir.

GetMaxLines

FWFORMGRIDMODEL():GetMaxLines()-> nMAx

Retorna quantas linhas o grid pode possuir

nMAx Quantidade máxima de linhas permitidas no grid

SetMaxLine

FWFORMGRIDMODEL():IsLineValidate([ nLine ])-> lRet

Analisa se uma determinada linha está valida

 

lRet Se verdadeiro a linha esta valida

FWFORMGRIDMODEL():ClearField(<cId >, [ nLine ], [ lClearTrigger ])-> lAtribuido

Limpa o conteúdo de um campo

 

lAtribuido Indica se o campo foi limpo

FWFORMGRIDMODEL():IsEmpty()-> lRet

Verifica se o grid não possui nenhuma linha.

lRet Se verdadeiro o submodelo esta em branco.

FWFORMGRIDMODEL():IsInserted([ nLine ])-> lInserted

Verifica se uma linha é nova no grid, ou seja, ela não existia e foi
criada pelo método addLine.

lInserted Indica se a linha foi inserida

FWFORMGRIDMODEL():SetOnlyView()-> NIL

Define que o submodelo não irá permitir a edição de dados.
Se a operação for inclusão o when dos campos passará a ser falso
e se for qualquer outra operação os campos não permitirão edição.
Além disse não permite inserção e nem exclusão de linhas.

FWFORMGRIDMODEL():IsModified()-> NIL

Retorna se o submodelo não foi modificado.

FWFORMGRIDMODEL():GetDataId([ nLine ])-> nID

Fornece o recno do registro de origem dos dados da linha

nID ID dos dados da Linha
nID ID do registro

FWFORMGRIDMODEL():InitValue(<cIdField >)-> xValue

Fornece o valor do inicializador padrão da folha de dados de um campo

 

xValue Valor do inicializador do campo

Faz a comparação entre os dados de um objeto do tipo FWFormGridModel passado por referência
com o próprio objeto. Os dois objetos devem possuir a mesma estrutura, pois esse
método compara apenas os dados, supondo que a estrutura seja a mesma.

FWFORMGRIDMODEL():LineShift([ nLineFrom ], [ nLineTo ])-> NIL

Realiza uma troca de dados entre duas linhas. Os dados da linha origem
serão movidos para a linha destino e os dados da linha destino serão
movidos para a linha origem.
Se a linha atualmente posicionada é a origem ou o destino, o número
da linha posicionada irá ser mudado para o numero da origem ou do
destino, porque os dados são trocados porém a linha ainda precisa
ser validada.

 

oModel:GetModel("ZA2DETAIL"):LineShift(5,6)

FWFORMGRIDMODEL():GetLinesChanged([ nType ])-> NIL

Retorna um array unidimensional com o numero das linhas que sofreram alguma modificação

 

FWFORMGRIDMODEL():SetLineModify(<nLine >)-> NIL

Define a linha como modificada

FWFORMGRIDMODEL():LdValueByPos(<cId >, [ xValue ])-> lAtribuido

Carrega um valor para a folha de dados através de acesso direto a posição
do campo na estrutura. Use esse método somente quando possuir um
grande volume de processamento na rotina.
Para determinar a posição do campo utilize o método GetArrayPos da
estrutura de dados do submodelo (FWFormModelStruct).
O valor será atribuído para a linha que estiver posicionada no grid.

 

lAtribuido Indica que o valor foi atribuído

aPosFields := oStruZA2:GetArrayPos("ZA2_MUSICA", "ZA2_ITEM")

oModel:GetModel("ZA2DETAIL"):LdValueByPos(aPosFields[1], "00001")
oModel:GetModel("ZA2DETAIL"):LdValueByPos(aPosFields[2], "1")

GetValueByPos
GetArrayPos -> FWFormModelStruct

FWFORMGRIDMODEL():GetValueByPos(<nIdPos >, [ nLine ])-> NIL

Fornece o valor da folha de dados de um campo, baseado na posição dele
na estrutura, utilize ele somente quando a rotina possui um grande volume
processamento. Para saber a posição do campo use o método GetArrayPos
do objeto de estrutura de dados (FWFormModelStruct).
Atenção!! Esse método não verifica se o campo existe.

aPosFields := oStruZA2:GetArrayPos("ZA2_MUSICA", "ZA2_ITEM")

cMusica := oModel:GetModel("ZA2DETAIL"):GetValueByPos(aPosFields[1], 1)
cItem := oModel:GetModel("ZA2DETAIL"):GetValueByPos(aPosFields[2], 2)

GetArrayPos -> FWFormModelStruct
LdValueByPos

FWFORMGRIDMODEL():SetFldNoCopy(<aFldNoCopy >)-> NIL

Define quais campos do submodelo não serão copiados no processo de cópia
do submodelo.

 

oModel:GetModel("ZA2DETAIL"):SetFldNoCopy( { 'ZA2_MUSICA', 'ZA2_ITEM' } )

FWFORMGRIDMODEL():GetFldNoCopy()-> NIL

Retorna quais campos do formulário não serão copiados no processo de cópia

FWFORMGRIDMODEL():CanClearData()-> NIL

Determina se o ClearData pode ser executado.
Se veio de banco não permite.

FWFORMGRIDMODEL():isEnable()-> lRet

Executa o bloco de bPre do modelo, retornando se ele está disponível para edição ou não

lRet - Indica se o modelo está disponível

FWFORMGRIDMODEL():MaxValueField(<cFieldID >)-> nMax

Retorna o valor máximo de um campo do grid, o campo precisa ser numérico

nMax Maior valor