Classe: FWMBrowse




FWMBrowse
FWMBrowse

Descrição
Fornece um objeto do tipo grid, botões laterais e detalhes das colunas baseado no dicionário de dados

Observação
Quando for necessária a chamada de uma segunda FWMBrowse a partir de opção do menu que gere o lock (Ex.: Alteração) de uma primeira FWMBrowse, o método SetCanSaveArea deverá ser obrigatoriamente habilitado.

Exemplo:
oMBrowse := FWMBrowse():New()
oMBrowse:SetCanSaveArea(.T.)

New
New

Sintaxe
FWMBrowse():New()-> oSelf

Descrição
Método construtor da classe

Retorno
oSelf Objeto da classe
Activate
Activate

Sintaxe
FWMBrowse():Activate(< oOwner >)-> NIL

Descrição
Método de ativação da classe

Parâmetros



NomeTipoDescriçãoDefaultObrigatórioReferência

oOwnerObjetoObjeto proprietário
X


 
AfterExecute
AfterExecute

Sintaxe
FWMBrowse():AfterExecute(< cFunction >, < nOption >, < nVerify >)-> NIL

Descrição
Atualiza o limite superior e inferior da tabela, restaura o arquivo de empresas e destrava o lock do registro

Parâmetros



NomeTipoDescriçãoDefaultObrigatórioReferência

cFunctionCaracteresNome da função definida para o botão
X

nOptionNuméricoTipo de operação (1=Visualizar, 2=Visualizar,3=Incluir,4=Alterar, 5=Excluir, 6=Alterar sem inclusão de novas linhas, 7=Cópia e 8=Impressão da regra de negócios)
X

nVerifyNuméricoPosição a ser validada no acesso de usuário
X


 
AddLegend


AddLegend


Sintaxe
FWMBrowse():AddLegend(< xCondition >, < cColor >, [< cTitle >], [< cID >], [< lFilter >])-> NIL


Descrição
Permite adicionar legendas no Browse



NomeTipoDescriçãoDefaultObrigatórioReferência

xConditionCaracter ou Bloco de códigoExpressão AdvPL ou Code-Block com a regra da legenda
X

cColorCaracterCor que identifica a regra
X

cTitleCaracterTítulo da legenda, utilizado na janela de visualização das legendas ""


cIDCaracterID

"DEFAULT"




lFilterLógicoIndica se deve ser exibido filtro da legenda.T.


 




BeforeExecute
BeforeExecute

Sintaxe
FWMBrowse():BeforeExecute(< cFunction >, < nOption >, < nVerify >, < cTitle >, < nRealOpc >, < nRotina >)-> NIL

Descrição
Verifica as permissões de acesso do usuário, se o registro pode sofrer manutenções e pergunta a filial de inclusão para o registro

Parâmetros



NomeTipoDescriçãoDefaultObrigatórioReferência

cFunctionCaracteresNome da função definida para o botão
X

nOptionNuméricoTipo de operação (1=Visualizar, 2=Visualizar, 3=Incluir, 4=Alterar, 5=Excluir, 6=Alterar sem inclusão de novas linhas, 7=Cópia e 8=Impressão da regra de negócios)
X

nVerifyNuméricoPosição a ser validada no acesso de usuário
X

cTitleCaracteresTítulo da janela
X

nRealOpcNuméricoOrdem selecionada do botão
X

nRotinaNuméricoIndica o item do aRotina que está sendo acessado
X


 
BrwGetFil
BrwGetFil

Sintaxe
FWMBrowse():BrwGetFil(< cFil >)-> cLasFil

Descrição
Retorna a descrição de uma filial

Parâmetros



NomeTipoDescriçãoDefaultObrigatórioReferência

cFilCaracteresCódigo da filial
X


 

Retorno
cLasFil Descrição da filial (Ex: 01 - Matriz)
ChangeTopBot
ChangeTopBot

Sintaxe
FWMBrowse():ChangeTopBot(< lDoFilter >)-> NIL

Descrição
Atualiza o limite superior e inferior da tabela para apresentação das informações no Browse.

Parâmetros



NomeTipoDescriçãoDefaultObrigatórioReferência

lDoFilterLógicoIndica se deve executar o filtro imediatamente
X


 
CheckPerm
CheckPerm

Sintaxe
FWMBrowse():CheckPerm(< cFunction >, < nOption >, < nVerify >, < lShowHelp >)-> NIL

Descrição
Avalia se o usuário tem permissão para utilizar a rotina

Parâmetros



NomeTipoDescriçãoDefaultObrigatórioReferência

cFunctionCaracteresNome da função definida para o botão
X

nOptionNuméricoTipo de operação (1=Visualizar, 2=Visualizar, 3=Incluir, 4=Alterar, 5=Excluir, 6=Alterar sem inclusão de novas linhas, 7=Cópia e 8=Impressão da regra de negócios)
X

nVerifyNuméricoPosição a ser validada no acesso de usuário
X

lShowHelpLógicoMostra para o usuário o help de sem permissão caso nao tenha
X


 
ClassName
ClassName

Sintaxe
FWMBrowse():ClassName()-> cClassName

Descrição
Retorna o nome da classe (FWMBROWSE)

Retorno
cClassName Nome da classe
ColumnsFields
ColumnsFields

Sintaxe
FWMBrowse():ColumnsFields(< aColumns >)-> NIL

Descrição
Adiciona as colunas que não foram configuradas para serem apresentadas por padrão no Browse, com base nas informações fornecidas através do método SetFields.

Parâmetros



NomeTipoDescriçãoDefaultObrigatórioReferência

aColumnsArray of RecordsEstrutura do array
[n][01] Título da coluna
[n][02] Code-Block de carga dos dados
[n][03] Tipo de dados
[n][04] Máscara
[n][05] Alinhamento (0=Centralizado, 1=Esquerda ou 2=Direita)
[n][06] Tamanho
[n][07] Decimal
[n][08] Indica se permite a edição
[n][09] Code-Block de validação da coluna após a edição
[n][10] Indica se exibe imagem
[n][11] Code-Block de execução do duplo clique
[n][12] Variável a ser utilizada na edição (ReadVar)
[n][13] Code-Block de execução do clique no header
[n][14] Indica se a coluna está deletada
[n][15] Indica se a coluna será exibida nos detalhes do Browse
[n][16] Opções de carga dos dados (Ex: 1=Sim, 2=Não)

X


 
DeActivate
DeActivate

Sintaxe
FWMBrowse():DeActivate()-> NIL

Descrição
Método de destruição da classe
ExecuteMDef
ExecuteMDef

Sintaxe
FWMBrowse():ExecuteMDef()-> NIL

Descrição
Executa a ação do clique no menu funcional
GetCBox
GetCBox

Sintaxe
FWMBrowse():GetCBox(< nPosSx3 >, < cCampo >)-> cConteud

Descrição
Retorna o conteúdo de um campo que possui opções de dados (X3_CBOX), de acordo com as informações atuais.

Parâmetros



NomeTipoDescriçãoDefaultObrigatórioReferência

nPosSx3NuméricoPosição do campo no array de dicionário de dados
X

cCampoCaracteresCampo que contém as opções
X


 

Retorno
cConteud Conteúdo do campo que possui opções de dados
GetSizeCBox
GetSizeCBox

Sintaxe
FWMBrowse():GetSizeCBox(< nPosSx3 >)-> nSize

Descrição
Retorna a largura da coluna para o campo que possui opções de dados (X3_CBOX)

Parâmetros



NomeTipoDescriçãoDefaultObrigatórioReferência

nPosSx3NuméricoPosição do campo no array de dicionário de dados
X


 

Retorno
nSize Largura da coluna para campo que possui opções de dados
GetTimer
GetTimer

Sintaxe
FWMBrowse():GetTimer()-> oTimer

Descrição
Retorna o objeto TIMER

Retorno
oTimer Objeto TIMER
LoadColumns
LoadColumns

Sintaxe
FWMBrowse():LoadColumns(< cProfFields >)-> aColumns

Descrição
Retorna as colunas padrão no Browse. Obs.: Para arquivo temporário serão considerados os campos definidos no método SetFields()

Parâmetros



NomeTipoDescriçãoDefaultObrigatórioReferência

cProfFieldsCaracteresStrind contendo os campos da MBrowse antiga
X


 

Retorno
aColumns Estrutura do array [n][01] Título da coluna [n][02] Code-Block de carga dos dados [n][03] Tipo de dados [n][04] Máscara [n][05] Alinhamento (0=Centralizado, 1=Esquerda ou 2=Direita) [n][06] Tamanho [n][07] Decimal [n][08] Indica se permite a edição [n][09] Code-Block de validação da coluna após a edição [n][10] Indica se exibe imagem [n][11] Code-Block de execução do duplo clique [n][12] Variável a ser utilizada na edição (ReadVar) [n][13] Code-Block de execução do clique no header [n][14] Indica se a coluna está deletada [n][15] Indica se a coluna será exibida nos detalhes do Browse [n][16] Opções de carga dos dados (Ex: 1=Sim, 2=Não)
LoadFils
LoadFils

Sintaxe
FWMBrowse():LoadFils(< cAlias >)-> aFilial

Descrição
Retorna as filiais disponíveis para o usuário

Parâmetros



NomeTipoDescriçãoDefaultObrigatórioReferência

cAliasCaracteresAlias da tabela a ser avaliada
X


 

Retorno
aFilial Filiais disponíveis para o usuário
Seek
Seek

Sintaxe
FWMBrowse():Seek(< oSeek >)-> nLine

Descrição
Executa a pesquisa de dados na tabela

Parâmetros



NomeTipoDescriçãoDefaultObrigatórioReferência

oSeekObjetoObjeto FWSEEK
X


 

Retorno
nLine Indica o registro que foi localizado a informação
SeekChange
SeekChange

Sintaxe
FWMBrowse():SeekChange(< oComboSeek >)-> NIL

Descrição
Realiza tratamentos na mudança da ordem na pesquisa

Parâmetros



NomeTipoDescriçãoDefaultObrigatórioReferência

oComboSeekObjetoObjeto TComboBox com a lista de opções de pesquisa
X


 
SetAmbiente
SetAmbiente

Sintaxe
FWMBrowse():SetAmbiente(< lAmbiente >)-> NIL

Descrição
Habilita a utilização da funcionalidade Walk-Thru no Browse

Parâmetros



NomeTipoDescriçãoDefaultObrigatórioReferência

lAmbienteLógicoIndica que será disponibilizado a opção Ambiente
X


 
SetBotFun
SetBotFun

Sintaxe
FWMBrowse():SetBotFun(< cBotFun >)-> NIL

Descrição
Indica o limite inferior das informações no Browse

Parâmetros



NomeTipoDescriçãoDefaultObrigatórioReferência

cBotFunCaracteresLimite inferior. Ex.: "02"
X


 
SetChgAll
SetChgAll

Sintaxe
FWMBrowse():SetChgAll(< lChgAll >)-> NIL

Descrição
Indica se o usuário tem permissão para alterar registros de outras filiais

Parâmetros



NomeTipoDescriçãoDefaultObrigatórioReferência

lChgAllLógicoIndica que o usuário tem permissão para alterar registros de outras filiais
X


 
SetExecuteDef
SetExecuteDef

Sintaxe
FWMBrowse():SetExecuteDef(< nExecuteDef >)-> NIL

Descrição
Indica a opção do Browse a ser executada no duplo clique no item

Parâmetros



NomeTipoDescriçãoDefaultObrigatórioReferência

nExecuteDefNuméricoIndica a opção do Browse a ser executada no duplo clique no item
X


 
SetFields
SetFields

Sintaxe
FWMBrowse():SetFields(< aFields >)-> NIL

Descrição
Indica os campos que serão adicionados as colunas do Browse. Obs.: Para arquivo temporário, todos os campos informados serão utilizados como coluna e no caso de tabela de dados os campos informados serão adicionados as colunas padrão do Browse.

Parâmetros



NomeTipoDescriçãoDefaultObrigatórioReferência

aFieldsArray of RecordsEstrutura do array
TABELA DE DADOS
[n][01] Título da coluna
[n][02] Code-Block de carga dos dados
[n][03] Tipo de dados
[n][04] Máscara
[n][05] Alinhamento (0=Centralizado, 1=Esquerda ou 2=Direita)
[n][06] Tamanho
[n][07] Decimal
[n][08] Indica se permite a edição
[n][09] Code-Block de validação da coluna após a edição
[n][10] Indica se exibe imagem
[n][11] Code-Block de execução do duplo clique
[n][12] Variável a ser utilizada na edição (ReadVar)
[n][13] Code-Block de execução do clique no header
[n][14] Indica se a coluna está deletada
[n][15] Indica se a coluna será exibida nos detalhes do Browse
[n][16] Opções de carga dos dados (Ex: 1=Sim, 2=Não)
TABELA TEMPORÁRIA
[n][01] Descrição do campo
[n][02] Nome do campo
[n][03] Tipo
[n][04] Tamanho
[n][05] Decimal
[n][06] Picture

X


 
SetFilial
SetFilial

Sintaxe
FWMBrowse():SetFilial(< aFils >)-> NIL

Descrição
Indica as filiais que deverão ser consideradas na apresentação do Browse

Parâmetros



NomeTipoDescriçãoDefaultObrigatórioReferência

aFilsArray of RecordsEstrutura do array
[n]Filial

X


 
SetIniWindow
SetIniWindow

Sintaxe
FWMBrowse():SetIniWindow(< bIniWindow >)-> NIL

Descrição
Indica o Code-Block executado na inicialização da janela do Browse

Parâmetros



NomeTipoDescriçãoDefaultObrigatórioReferência

bIniWindowCode-BlockCode-Block executado na inicialização da janela do Browse
X


 
SetSeeAll
SetSeeAll

Sintaxe
FWMBrowse():SetSeeAll(< lSeeAll >)-> NIL

Descrição
Indica se o usuário tem permissão para visualizar registros de outras filiais

Parâmetros



NomeTipoDescriçãoDefaultObrigatórioReferência

lSeeAllLógicoIndica que o usuário tem permissão para visualizar registros de outras filiais
X


 
SetSeek
SetSeek

Sintaxe
FWMBrowse():SetSeek(< lSeek >, < aSeek >)-> NIL

Descrição
Habilita a utilização da pesquisa de registros no Browse

Parâmetros



NomeTipoDescriçãoDefaultObrigatórioReferência

lSeekLógicoIndica que será disponibiliza a opçãoo de pesquisa no Browse
X

aSeekArray of RecordsEstrutura do array
[n,1] Título da pesquisa
[n,2,1] LookUp
[n,2,2] Tipo de dados
[n,2,3] Tamanho
[n,2,4] Decimal
[n,2,5] Título do campo
[n,2,6] Máscara
[n,3] Ordem da pesquisa
[n,4] Exibe na pesquisa

X


 
SetTimer
SetTimer

Sintaxe
FWMBrowse():SetTimer(< bTimerAction >, < nInterval >)-> NIL

Descrição
Indica o tempo de atualização da janela do Browse

Parâmetros



NomeTipoDescriçãoDefaultObrigatórioReferência

bTimerActionCode-BlockCode-Block executado na atualização da janela do Browse
X

nIntervalNuméricoIntervalo de atualização da janela
X


 
SetTopFun
SetTopFun

Sintaxe
FWMBrowse():SetTopFun(< cTopFun >)-> NIL

Descrição
Indica o limite superior das informações no Browse

Parâmetros



NomeTipoDescriçãoDefaultObrigatórioReferência

cTopFunCaracteresLimite superior. Ex.: "01"
X


 
SetUseFilter
SetUseFilter

Sintaxe
FWMBrowse():SetUseFilter(< lFilter >)-> NIL

Descrição
Habilita a utilização do filtro no Browse

Parâmetros



NomeTipoDescriçãoDefaultObrigatórioReferência

lFilterLógicoIndica que será disponibiliza a opção de filtro no Browse
X


 
SetUseCaseFilter
SetUseCaseFilter

Sintaxe
FWMBrowse():SetUseCaseFilter(< lFilter >)-> NIL

Descrição
Habilita a utilização do filtro rápido no Browse

Parâmetros



NomeTipoDescriçãoDefaultObrigatórioReferência

lFilterLógicoIndica que será disponibilizada a opção de filtro no Browse
X


 
SetX3Tela
SetX3Tela

Sintaxe
FWMBrowse():SetX3Tela(< cTela >)-> NIL

Descrição
Permite adicionar uma regra para apresentação dos campos no Browse Obs.: O conteúdo da string deve conter o caracter "|" que permite separar os indentificadores utilizados na regra de validação.

Parâmetros



NomeTipoDescriçãoDefaultObrigatórioReferência

cTelaCaracteresIndica a regra para apresentação dos campos no Browse
X


 
SetWalkThru
SetWalkThru

Sintaxe
FWMBrowse():SetWalkThru(< lWalkThru >)-> NIL

Descrição
Habilita a utilização da funcionalidade Walk-Thru no Browse

Parâmetros



NomeTipoDescriçãoDefaultObrigatórioReferência

lWalkThruLógicoIndica que será disponibilizado a opção Walk-Thru
X


 
SetOnlyFields
SetOnlyFields

Sintaxe
FWMBrowse():SetOnlyFields(< aFields >)-> NIL

Descrição
Seta quais campos da tabelas serão apresentados no Browse

Parâmetros



NomeTipoDescriçãoDefaultObrigatórioReferência

aFieldsArray of RecordsArray com os nomes dos campos a serem apresentados
X


 

Exemplo
@sample oBrowse := FWMBrowse():New() oBrowse:SetAlias('SA1') oBrowse:SetOnlyFields( { 'A1_COD', 'A1_LOJA', 'A1_NOME' } ) oBrowse:Activate()

Observações
Os campos que constam no array têm que estar configurados para exibição no Browse (X3_BROWSE=="S")
Destroy
Destroy

Sintaxe
FWMBrowse():Destroy()-> NIL

Descrição
Destroy o objeto e suas referências a outros objetos.

SetMainProc


SetMainProc


Sintaxe
FWMBrowse():SetMainProc(< cProc >)-> NIL

Descrição
Indica à qual rotina o browse pertence, quando ele é instanciado fora da função principal

Parâmetros

NomeTipoDescriçãoDefaultObrigatórioReferência

cProcCharacterNome da Rotina principal à qual o browse pertence
X



OptionReport
OptionReport

Sintaxe
FWMBrowse():OptionReport()-> lOptionReport

Descrição
Indica se a opção de impressão das informações do Browse está habilitada

Retorno
lOptionReport Indica se a opção de impressão está habilitada
  • Sem rótulos