Histórico da Página

Composition Setup
import.css=/download/attachments/327912/newLayout.css

Classe: FWFormGridModel

Compatível Países:	Todos
Sistemas Operacionais:	Todos
Compatível às Bases de Dados:	Todos
Nível de Acesso:	Nível 1 (Acesso Clientes)
Idiomas:	Português, Inglês, Espanhol
Versão	P10 R1.4

Descrição

Fornece um objeto com o submodelo de edição FormGrid.
Um submodelo do tipo Grid permite manipular diversos registros por

...

aHeader.

.T.

SetStruct

Sintaxe

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

Descrição

Configura o objeto com a estrutura de dados

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
oFormModelStruct	Objeto	Objeto com a estrutura de dados.		X

GetOldData

Sintaxe

FWFORMGRIDMODEL():GetOldData()-> aData

Descrição

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

Retorno

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

AddLine

Sintaxe

FWFORMGRIDMODEL():AddLine()-> nLine

Descrição

O grid inicia sempre com uma linha. Esse método AddLine deve ser usado para

...

Retorno

lUpdated Indica se a linha recebeu valores

SetNoInsertLine

Sintaxe

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

Descrição

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

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
lSet	Lógico	Especifica se a inserção deve esta ligada .F. ou desligada .T.	.T.

SetNoUpdateLine

Sintaxe

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

Descrição

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

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
lSet	Lógico	Especifica se a alteração deve esta ligada .F. ou desligada .T.	.T.

SetNoDeleteLine

Sintaxe

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

Descrição

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

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
lSet	Lógico	Especifica se a exclusão deve esta ligada .F. ou desligada .T.	.T.

...

Retorno

lDeleted Indica se a linha esta deletada

SetLine

Sintaxe

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

Descrição

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

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
nLine	Numérico	Numero da linha	0

Retorno

nLine Indica a linha atualmente posicionada

GoLine

Sintaxe

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

Descrição

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

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
nLine	Numérico	Numero da linha do grid que será utilizado como DEFAULT		X

Retorno

nLine Indica a linha atual

Veja também

SetLine

GetLine

Sintaxe

FWFORMGRIDMODEL():GetLine()-> nLine

Descrição

Fornece a linha do

...

Retorno

lRetorno Indica que a linha atual está valida

VldData

Sintaxe

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

Descrição

Valida a folha de dados do submodelo

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
lVldOwner	Lógico	Verifica se será validado o submodelo e seus filhos (.T.) ou se será validado apenas o contexto do submodelo (.F.)	.T.	X

Retorno

lRetorno Indica que a folha de dados é valida

CanSetValue

Sintaxe

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

Descrição

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

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
cId	Caracteres

...

atribuído

SetLoadFilter

Sintaxe

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

Descrição

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

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
aLoadFilter	Array	Estrutura de filtro [n] Array [n][1] ExpC: ID do campo do submodelo de destino [n][2] ExpC: Valor que o campo deve usar no filtro [n][3] Operador Relacional (Opcional, default é MVC_LOADFILTER_EQUAL ) MVC_LOADFILTER_EQUAL Igual a MVC_LOADFILTER_NOT_EQUAL Diferente de MVC_LOADFILTER_LESS Menor que MVC_LOADFILTER_LESS_EQUAL Menor que ou Igual a MVC_LOADFILTER_GREATER Maior que MVC_LOADFILTER_GREATER_EQUAL Maior que ou Igual a MVC_LOADFILTER_CONTAINS Contém MVC_LOADFILTER_NOT_CONTAINS Não Contém MVC_LOADFILTER_IS_CONTAINED Está Contido Em MVC_LOADFILTER_IS_NOT_CONTAINED Não Está Contido Em Para os operadores relacionais MVC_LOADFILTER_IS_CONTAINED e MVC_LOADFILTER_IS_NOT_CONTAINED o 2o elemento de cada array deverá ser uma array em formato caracter oModel:GetModel( 'ZA2DETAIL' ):SetLoadFilter( { { 'ZA2_AUTOR', "{'000500','000501','000502','000503','000504'}", MVC_LOADFILTER_IS_CONTAINED } } ) [n][4] Operador Logico (Opcional, default MVC_LOADFILTER_AND ) MVC_LOADFILTER_AND "e" MVC_LOADFILTER_OR "ou"	{}
cLoadFilter	Caracteres

...

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 " )

GetLoadFilter

Sintaxe

FWFORMGRIDMODEL():GetLoadFilter()-> aRelation

Descrição

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

Retorno

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

SetUniqueLine

Sintaxe

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

Descrição

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

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
aUnique	Array	Array unidimensional com os IDs dos campos		X
bUnique	Bloco de Código	Bloco de código de execução quando há linha duplicada. O bloco deve retornar um valor lógico.

Exemplo

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

SetDelAllLine

Sintaxe

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

Descrição

Especifica se todas as linha do grid podem ser apagadas.

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
lDelAllLine	Lógico	Indica se todas as linhas podem ser apagadas	.F.

...

GetQTDLine

...

Length

Obsoleto

Use o método Length

...

Retorno

nMax Quantidade de linhas

...

Retorno

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

...

Retorno

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

...

Parâmetros

...

Retorno

lRetorno Indica se a linha foi encontrada

Exemplo

...

IsFieldUpdated

Sintaxe

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

Descrição

...

Parâmetros

...

Informa se o grid aceita edição nas linhas

Retorno

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

CanDeleteLine

Sintaxe

FWFORMGRIDMODEL():CanDeleteLine()-> lDeleteLine

Descrição

Informa se o grid aceita que as linhas sejam apagadas

Retorno

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

SeekLine

Sintaxe

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

Descrição

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.

Parâmetros

...

lRet Indica que o valor foi Atualizado

...

conteúdo de um campo

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
cId	Caracteres	Codigo/Nome do atributo da folha de dados		X
nLine	Numérico	Indica a linha	::NLINE
lClearTrigger	Lógico	Indica se limpa os campos gatilhados	.F.

Retorno

lAtribuido Indica se o campo foi limpo

IsEmpty

Sintaxe

FWFORMGRIDMODEL():IsEmpty()-> lRet

Descrição

Verifica se o grid não possui nenhuma linha.

Retorno

lRet Se verdadeiro o submodelo esta em branco.

IsInserted

Sintaxe

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

Descrição

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

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
nLine	Numérico	Indica a linha a ser verificada	::NLINE

...

Retorno

lInserted Indica se a linha foi inserida

SetOnlyView

Sintaxe

FWFORMGRIDMODEL():SetOnlyView()-> NIL

Descrição

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.

IsModified

Sintaxe

FWFORMGRIDMODEL():IsModified()-> NIL

Descrição

Retorna se o submodelo não foi modificado.

GetDataId

Sintaxe

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

Descrição

Fornece o recno do registro de origem dos dados da linha

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
nLine	Numérico	Indica a linha a ser verificada	::NLINE

...

padrão da folha de dados de um campo

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
cIdField	Caracteres	Codigo/Nome do atributo da folha de dados		X

Retorno

xValue Valor do inicializador do campo

Compare

Sintaxe

FWFORMGRIDMODEL():Compare(<aCompare >, <oFWFormGridModel >, < lGetID > , < lInvert > , < lCompare > , < lVirtual > )-> NIL

Descrição

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.

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
aCompare	Array

...

Array que deve ser passado por referencia,para que o metodo salve as informações de diferencas
no formato:

[n][1] - ExpC: ID do subModelo
[n][2] - ExpC: Tipo (G)
[n][3] - ExpA: SubArray com os campos alterados
[n][3][1] - ExpN: Número da linha no submodelo do Model
[n][3][2] - ExpC: Operação da linha (3 - Inclusão , 4 - Alteração ou 5 - Exclusão )
[n][3][3][1] - ExpC: ID do Campo
[n][3][3][1] - ExpX: Valor do Modelo(self)
[n][3][3][1] - ExpX: Valor do modelo passado no segundo parametro

Se lGetID == .T.

[n][3][4] - {Id do dado de origem, Id do dado destino(modelo passado via parametro}

X

oFWFormGridModel

Objeto

...

LineShift

Sintaxe

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

Descrição

...

Parâmetros

...

Exemplo

...

GetLinesChanged

Sintaxe

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

Descrição

...

Lógico	Se .T. retorna os IDs dos dados das alterações, e considera a troca de Id como um alteração tambem. Caso o modelo não tenha ID de dado ou a linha for nova (no caso de grid), voltara o ID 0
lInvert	Lógico	Se .T. salva o valor da esquerda na direita, e o da direita na esquerda, padrao. .F.
lCompare	Lógico	Indica se deve comparar com o outro modelo (definido como falso quando o grid pai for uma linha nova, não devendo comparar com os valores atuais do modelo)
lVirtual	Lógico	Indica se deve considerar a diferença de campos virtuais sem outras alterações (Caso existam alterações de campos reais, o parâmetro é desconsiderado)

Bloco de código

language	js
theme	Midnight
title	Código Exemplo

/*/{Protheus.doc} fCompare
    Função compare usada para comparar dois objetos e exibe o resultado

    @Type Static Function
    @author FRAMEWORK
    @since 21/11/2024
//-----------------------------------------------------------------*/
Static Function fCompare()
    Local oModel   as object
    Local oGrid1   as object
    Local oGrid2   as object
    Local aCompare as Array

    oModel := FWModelActive()
    oGrid1 := oModel:GetModel("ZC4DETAIL")
    oGrid2 := oModel:GetModel("ZC4DET2")
    aCompare := {}

    aCompare := oGrid1:Compare(aCompare, oGrid2)
    Aviso('retorno', VarInfo('aCompare', aCompare, , .F.), {'ok'}, 4, , , , .T.)

Return

LineShift

Sintaxe

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

Descrição

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.

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
nLineFrom	Numérico	Numero da linha de origem	::NLINE
nLineTo	Numérico	Numero da linha de destino	::NLINE

Exemplo

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

GetLinesChanged

Sintaxe

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

Descrição

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

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
nType	Numérico	Tipo da informação: MODEL_GRID_LINECHANGED_ALL Todas as linhas modificadas MODEL_GRID_LINECHANGED_INSERTED Somente as linhas inseridas MODEL_GRID_LINECHANGED_UPDATED Somente as linhas alteradas MODEL_GRID_LINECHANGED_DELETED Somente as linhas excluidas	MODEL_GRID_LINECHANGED_ALL

SetLineModify

Sintaxe

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

Descrição

Define a linha como modificada

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
nLine	Numérico	Numero da Linha		X

LdValueByPos

Sintaxe

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

Descrição

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.

...

SetLineModify

Sintaxe

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

Descrição

Define a linha como modificada

Parâmetros

...

Retorno

...

Descrição

...

Veja também

...

Exemplo

...

GetFldNoCopy

Sintaxe

FWFORMGRIDMODEL():GetFldNoCopy()-> NIL

Descrição

...

Descrição

...

lInit , lBlankLine ) →

Descrição
Limpa(apaga da memória) todo o conteúdo do sub-formulário, e de todos os seu filhos.

ATENÇÃO:
Esse método não pode ser utilizado em Modelos que venham de Banco de Dados, no modo de Operação ALTERAÇÃO, pois seria gerado inconsistência na base de dados, tendo em vista que este método NÃO APAGA os registros da base.

Parâmetros

Nome	Tipo	Descrição	Obrigatório
lInit	Lógico	Indica se deve carregar os inicializadores padrões
lBlankLine	Lógico	Indica se deve criar a linha em branco

SetForceLoad

Parâmetros

...

Veja também

...

Descrição

...

SetForceLoad( lForce ) →

Descrição
Informa que o bloco de carga(load) do subformulário será executado em todas as Operações, inclusive na Inclusão, que não é o padrão.

Parâmetros

Nome	Tipo	Descrição

...

Retorno

oObserable Objeto do tipo FWObserable

Veja também

...

Código/Nome do atributo da folha de dados		X
xValue	Qualquer	Valor a ser

Código/Nome do atributo da folha de dados		X
xValue	Qualquer	Valor a ser

Caracteres	Código/Nome do atributo da folha de dados		X
xValue	Qualquer	Valor a ser atribuído

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 3

Nova versão Atual

Chave

ClassName

SetLPost

SetLPre

SetUseOldGrid

SetStruct

GetOldData

AddLine

UnDeleteLine

DeleteLine

IsUpdated

SetNoInsertLine

SetNoUpdateLine

SetNoDeleteLine

IsDeleted

SetLine

GoLine

GetLine

SetValue

LoadValue

GetValue

VldLineData

VldData

CanSetValue

SetLoadFilter

GetLoadFilter

SetUniqueLine

SetDelAllLine

DelAllLine

copyDataFromGrid

GetQTDLine

Sintaxe FWFORMGRIDMODEL():

Length

Sintaxe FWFORMGRIDMODEL():

CanInsertLine

Sintaxe FWFORMGRIDMODEL():

CanUpdateLine

CanDeleteLine

SeekLine

IsFieldUpdated

Sintaxe FWFORMGRIDMODEL():

SetMaxLine

GetMaxLines

IsLineValidate

ClearField

IsEmpty

IsInserted

SetOnlyView

IsModified

GetDataId

InitValue

Compare

LineShift

GetLinesChanged

SetLineModify

LdValueByPos

GetValueByPos

Sintaxe FWFORMGRIDMODEL():

SetFldNoCopy

GetFldNoCopy

ClearData

CanClearData

isEnable

MaxValueField

Sintaxe
FWFORMGRIDMODEL():

Sintaxe
FWFORMGRIDMODEL():

Sintaxe
FWFORMGRIDMODEL():

Sintaxe
FWFORMGRIDMODEL():

Sintaxe
FWFORMGRIDMODEL():