Exibir origem

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

Classe: 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

Sintaxe

FWMBrowse():New()-> oSelf

Descrição

Método construtor da classe

Retorno

oSelf Objeto da classe

Activate

Sintaxe

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

Descrição

Método de ativação da classe

Parâmetros

	Nome	Tipo	Descrição	Default	Obrigatório	Referência
	oOwner	Objeto	Objeto proprietário		X

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

Nome	Tipo	Descrição	Default	Obrigatório	Referência
cFunction	Caracteres	Nome da função definida para o botão		X
nOption	Numérico	Tipo 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
nVerify	Numérico	Posição a ser validada no acesso de usuário		X

AddLegend

Sintaxe

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

Descrição

Permite adicionar legendas no Browse

Nome	Tipo	Descrição	Default	Obrigatório	Referência
xCondition	Caracter ou Bloco de código	Expressão AdvPL ou Code-Block com a regra da legenda		X
cColor	Caracter	Cor que identifica a regra		X
cTitle	Caracter	Título da legenda, utilizado na janela de visualização das legendas	""
cID	Caracter	ID	"DEFAULT"
lFilter	Lógico	Indica se deve ser exibido filtro da legenda	.T.

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

Nome	Tipo	Descrição	Default	Obrigatório	Referência
cFunction	Caracteres	Nome da função definida para o botão		X
nOption	Numérico	Tipo 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
nVerify	Numérico	Posição a ser validada no acesso de usuário		X
cTitle	Caracteres	Título da janela		X
nRealOpc	Numérico	Ordem selecionada do botão		X
nRotina	Numérico	Indica o item do aRotina que está sendo acessado		X

BrwGetFil

Sintaxe

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

Descrição

Retorna a descrição de uma filial

Parâmetros

	Nome	Tipo	Descrição	Default	Obrigatório	Referência
	cFil	Caracteres	Código da filial		X

Retorno

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

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

	Nome	Tipo	Descrição	Default	Obrigatório	Referência
	lDoFilter	Lógico	Indica se deve executar o filtro imediatamente		X

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

Nome	Tipo	Descrição	Default	Obrigatório	Referência
cFunction	Caracteres	Nome da função definida para o botão		X
nOption	Numérico	Tipo 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
nVerify	Numérico	Posição a ser validada no acesso de usuário		X
lShowHelp	Lógico	Mostra para o usuário o help de sem permissão caso nao tenha		X

ClassName

Sintaxe

FWMBrowse():ClassName()-> cClassName

Descrição

Retorna o nome da classe (FWMBROWSE)

Retorno

cClassName Nome da classe

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

	Nome	Tipo	Descrição	Default	Obrigatório	Referência
	aColumns	Array of Records	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)		X

DeActivate

Sintaxe

FWMBrowse():DeActivate()-> NIL

Descrição

Método de destruição da classe

ExecuteMDef

Sintaxe

FWMBrowse():ExecuteMDef()-> NIL

Descrição

Executa a ação do clique no menu funcional

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

Nome	Tipo	Descrição	Default	Obrigatório	Referência
nPosSx3	Numérico	Posição do campo no array de dicionário de dados		X
cCampo	Caracteres	Campo que contém as opções		X

Retorno

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

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

	Nome	Tipo	Descrição	Default	Obrigatório	Referência
	nPosSx3	Numérico	Posiçã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

Sintaxe

FWMBrowse():GetTimer()-> oTimer

Descrição

Retorna o objeto TIMER

Retorno

oTimer Objeto TIMER

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

	Nome	Tipo	Descrição	Default	Obrigatório	Referência
	cProfFields	Caracteres	Strind 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

Sintaxe

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

Descrição

Retorna as filiais disponíveis para o usuário

Parâmetros

	Nome	Tipo	Descrição	Default	Obrigatório	Referência
	cAlias	Caracteres	Alias da tabela a ser avaliada		X

Retorno

aFilial Filiais disponíveis para o usuário

SeekChange

Sintaxe

FWMBrowse():SeekChange()-> NIL

Descrição

Realiza tratamentos na mudança da ordem na pesquisa

SetAmbiente

Sintaxe

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

Descrição

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

Parâmetros

	Nome	Tipo	Descrição	Default	Obrigatório	Referência
	lAmbiente	Lógico	Indica que será disponibilizado a opção Ambiente		X

SetBotFun

Sintaxe

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

Descrição

Indica o limite inferior das informações no Browse

Parâmetros

	Nome	Tipo	Descrição	Default	Obrigatório	Referência
	cBotFun	Caracteres	Limite inferior. Ex.: "02"		X

SetChgAll

Sintaxe

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

Descrição

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

Parâmetros

	Nome	Tipo	Descrição	Default	Obrigatório	Referência
	lChgAll	Lógico	Indica que o usuário tem permissão para alterar registros de outras filiais		X

SetExecuteDef

Sintaxe

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

Descrição

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

Parâmetros

	Nome	Tipo	Descrição	Default	Obrigatório	Referência
	nExecuteDef	Numérico	Indica a opção do Browse a ser executada no duplo clique no item		X

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

	Nome	Tipo	Descrição	Default	Obrigatório	Referência
	aFields	Array of Records	Estrutura 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

Sintaxe

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

Descrição

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

Parâmetros

	Nome	Tipo	Descrição	Default	Obrigatório	Referência
	aFils	Array of Records	Estrutura do array [n]Filial		X

SetIniWindow

Sintaxe

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

Descrição

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

Parâmetros

	Nome	Tipo	Descrição	Default	Obrigatório	Referência
	bIniWindow	Code-Block	Code-Block executado na inicialização da janela do Browse		X

SetSeeAll

Sintaxe

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

Descrição

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

Parâmetros

	Nome	Tipo	Descrição	Default	Obrigatório	Referência
	lSeeAll	Lógico	Indica que o usuário tem permissão para visualizar registros de outras filiais		X

SetSeek

Sintaxe

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

Descrição

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

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
lSeek	Lógico	Indica que será disponibiliza a opçãoo de pesquisa no Browse		X
aSeek	Array of Records	Estrutura 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

Sintaxe

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

Descrição

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

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
bTimerAction	Code-Block	Code-Block executado na atualização da janela do Browse		X
nInterval	Numérico	Intervalo de atualização da janela		X

SetTopFun

Sintaxe

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

Descrição

Indica o limite superior das informações no Browse

Parâmetros

	Nome	Tipo	Descrição	Default	Obrigatório	Referência
	cTopFun	Caracteres	Limite superior. Ex.: "01"		X

SetUseFilter

Sintaxe

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

Descrição

Habilita a utilização do filtro no Browse

Parâmetros

	Nome	Tipo	Descrição	Default	Obrigatório	Referência
	lFilter	Lógico	Indica que será disponibiliza a opção de filtro no Browse		X

SetUseCaseFilter

Sintaxe

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

Descrição

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

Parâmetros

	Nome	Tipo	Descrição	Default	Obrigatório	Referência
	lFilter	Lógico	Indica que será disponibilizada a opção de filtro no Browse		X

SetX3Tela

Sintaxe

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

Descrição

Permite adicionar uma regra para apresentação dos campos no Browse.

Observações:

O conteúdo da string deve conter o caracter "|" que permite separar os indentificadores utilizados na regra de validação.
O conteúdo será utilizado como parâmetro de avaliação da função FWFormStruct (terceiro parâmetro, bSX3)

Parâmetros

	Nome	Tipo	Descrição	Default	Obrigatório	Referência
	cTela	Caracteres	Indica a regra para apresentação dos campos no Browse		X

SetWalkThru

Sintaxe

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

Descrição

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

Parâmetros

	Nome	Tipo	Descrição	Default	Obrigatório	Referência
	lWalkThru	Lógico	Indica que será disponibilizado a opção Walk-Thru		X

SetOnlyFields

Sintaxe

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

Descrição

Seta quais campos da tabelas serão apresentados no Browse

Parâmetros

	Nome	Tipo	Descrição	Default	Obrigatório	Referência
	aFields	Array of Records	Array 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

Sintaxe

FWMBrowse():Destroy()-> NIL

Descrição

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

SetMainProc

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

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

Parâmetros

	Nome	Tipo	Descrição	Default	Obrigatório	Referência
	cProc	Character	Nome da Rotina principal à qual o browse pertence		X

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