Início / Classes / FWMBrowse

CLASSE · INTERFACE

FWMBrowse

FWMBrowse():New() → oSelf

Classe para construção e controle de browses no Framework do Protheus. Centraliza colunas, pesquisas, filtros, legendas, filiais e o ciclo de vida da interface.

36MÉTODOS

MVCCATEGORIA

01 · VISÃO GERAL

Do objeto à tela

Crie o objeto, defina o alias e os recursos e ative a interface. Aplique as configurações antes de Activate().

Local oBrowse := FWMBrowse():New()
oBrowse:SetAlias("SA1")
oBrowse:SetDescription("Clientes")
oBrowse:SetUseFilter(.T.)
oBrowse:Activate()

02 · REFERÊNCIA

Métodos da classe

New

Método construtor da classe

FWMBrowse():New()-> oSelf

INFORMAÇÕES

Método construtor da classe

EXEMPLO

Local oBrowse := FWMBrowse():New()

Activate

Método de ativação da classe

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

PARÂMETROS

Nome	Tipo	Descrição
`oOwner`obrigatório	Objeto	Objeto proprietário

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:Activate()

AfterExecute

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

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

PARÂMETROS

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

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:AfterExecute()

AddLegend

Permite adicionar legendas no Browse

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

INFORMAÇÕES

Permite adicionar legendas no Browse

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:AddLegend()

BeforeExecute

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

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

PARÂMETROS

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

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:BeforeExecute()

BrwGetFil

Retorna a descrição de uma filial

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

PARÂMETROS

Nome	Tipo	Descrição
`cFil`obrigatório	Caracteres	Código da filial

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:BrwGetFil()

ChangeTopBot

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

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

PARÂMETROS

Nome	Tipo	Descrição
`lDoFilter`obrigatório	Lógico	Indica se deve executar o filtro imediatamente

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:ChangeTopBot()

CheckPerm

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

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

PARÂMETROS

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

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:CheckPerm()

ClassName

Retorna o nome da classe (FWMBROWSE)

FWMBrowse():ClassName()-> cClassName

INFORMAÇÕES

Retorna o nome da classe (FWMBROWSE)

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:ClassName()

ColumnsFields

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.

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

PARÂMETROS

Nome	Tipo	Descrição
`aColumns`obrigatório	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)

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:ColumnsFields()

DeActivate

Método de destruição da classe

FWMBrowse():DeActivate()-> NIL

INFORMAÇÕES

Método de destruição da classe

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:DeActivate()

ExecuteMDef

Executa a ação do clique no menu funcional

FWMBrowse():ExecuteMDef()-> NIL

INFORMAÇÕES

Executa a ação do clique no menu funcional

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:ExecuteMDef()

GetCBox

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

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

PARÂMETROS

Nome	Tipo	Descrição
`nPosSx3`obrigatório	Numérico	Posição do campo no array de dicionário de dados
`cCampo`obrigatório	Caracteres	Campo que contém as opções

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:GetCBox()

GetSizeCBox

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

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

PARÂMETROS

Nome	Tipo	Descrição
`nPosSx3`obrigatório	Numérico	Posição do campo no array de dicionário de dados

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:GetSizeCBox()

GetTimer

Retorna o objeto TIMER

FWMBrowse():GetTimer()-> oTimer

INFORMAÇÕES

Retorna o objeto TIMER

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:GetTimer()

LoadColumns

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

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

PARÂMETROS

Nome	Tipo	Descrição
`cProfFields`obrigatório	Caracteres	Strind contendo os campos da MBrowse antiga

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:LoadColumns()

LoadFils

Retorna as filiais disponíveis para o usuário

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

PARÂMETROS

Nome	Tipo	Descrição
`cAlias`obrigatório	Caracteres	Alias da tabela a ser avaliada

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:LoadFils()

SetAmbiente

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

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

PARÂMETROS

Nome	Tipo	Descrição
`lAmbiente`obrigatório	Lógico	Indica que será disponibilizado a opção Ambiente

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:SetAmbiente()

SetBotFun

Indica o limite inferior das informações no Browse

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

PARÂMETROS

Nome	Tipo	Descrição
`cBotFun`obrigatório	Caracteres	Limite inferior. Ex.: "02"

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:SetBotFun()

SetChgAll

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

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

PARÂMETROS

Nome	Tipo	Descrição
`lChgAll`obrigatório	Lógico	Indica que o usuário tem permissão para alterar registros de outras filiais

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:SetChgAll()

SetExecuteDef

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

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

PARÂMETROS

Nome	Tipo	Descrição
`nExecuteDef`obrigatório	Numérico	Indica a opção do Browse a ser executada no duplo clique no item

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:SetExecuteDef()

SetFields

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.

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

PARÂMETROS

Nome	Tipo	Descrição
`aFields`obrigatório	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

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:SetFields()

SetFilial

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

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

PARÂMETROS

Nome	Tipo	Descrição
`aFils`obrigatório	Array of Records	Estrutura do array [n]Filial

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:SetFilial()

SetIniWindow

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

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

PARÂMETROS

Nome	Tipo	Descrição
`bIniWindow`obrigatório	Code-Block	Code-Block executado na inicialização da janela do Browse

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:SetIniWindow()

SetSeeAll

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

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

PARÂMETROS

Nome	Tipo	Descrição
`lSeeAll`obrigatório	Lógico	Indica que o usuário tem permissão para visualizar registros de outras filiais

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:SetSeeAll()

SetSeek

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

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

PARÂMETROS

Nome	Tipo	Descrição
`lSeek`obrigatório	Lógico	Indica que será disponibiliza a opçãoo de pesquisa no Browse
`aSeek`obrigatório	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

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:SetSeek()

SetTimer

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

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

PARÂMETROS

Nome	Tipo	Descrição
`bTimerAction`obrigatório	Code-Block	Code-Block executado na atualização da janela do Browse
`nInterval`obrigatório	Numérico	Intervalo de atualização da janela

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:SetTimer()

SetTopFun

Indica o limite superior das informações no Browse

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

PARÂMETROS

Nome	Tipo	Descrição
`cTopFun`obrigatório	Caracteres	Limite superior. Ex.: "01"

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:SetTopFun()

SetUseFilter

Habilita a utilização do filtro no Browse

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

PARÂMETROS

Nome	Tipo	Descrição
`lFilter`obrigatório	Lógico	Indica que será disponibiliza a opção de filtro no Browse

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:SetUseFilter()

SetUseCaseFilter

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

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

PARÂMETROS

Nome	Tipo	Descrição
`lFilter`obrigatório	Lógico	Indica que será disponibilizada a opção de filtro no Browse

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:SetUseCaseFilter()

SetX3Tela

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 )

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

PARÂMETROS

Nome	Tipo	Descrição
`cTela`obrigatório	Caracteres	Indica a regra para apresentação dos campos no Browse

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:SetX3Tela()

SetWalkThru

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

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

PARÂMETROS

Nome	Tipo	Descrição
`lWalkThru`obrigatório	Lógico	Indica que será disponibilizado a opção Walk-Thru

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:SetWalkThru()

SetOnlyFields

Seta quais campos da tabelas serão apresentados no Browse

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

PARÂMETROS

Nome	Tipo	Descrição
`aFields`obrigatório	Array of Records	Array com os nomes dos campos a serem apresentados

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:SetOnlyFields()

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

Destroy

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

FWMBrowse():Destroy()-> NIL

INFORMAÇÕES

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

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:Destroy()

SetMainProc

Método da classe FWMBrowse.

FWMBrowse():SetMainProc()

INFORMAÇÕES

Método da classe FWMBrowse.

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:SetMainProc()

OptionReport

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

FWMBrowse():OptionReport()-> lOptionReport

INFORMAÇÕES

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

EXEMPLO

Local oBrowse := FWMBrowse():New()
// Exemplo ilustrativo — ajuste à rotina
oBrowse:OptionReport()

Conteúdo estruturado a partir da documentação TDN fornecida. Exemplos ilustrativos devem ser adaptados e validados no ambiente Protheus.