Frameworksp

Páginas filhas
  • FWFormBrowse

Versões comparadas

Versão antiga 34

changes.mady.by.user Danilo Basilio Medeiros

Gravado em

comparado com

Nova versão 35

changes.mady.by.user Gianluca Moreira

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Comentário: Quebra de linha no exemplo

...

Portuguese

Pagetitle
FWFormBrowse
FWFormBrowse

Classe: FWFormBrowse

O FWFOrmBrowse fornece um objeto do tipo grid, que possibilita a inclusão de botões laterais e detalhes das colunas.

Hierarquia

TGrid -> FWBrowse


Construtores
New

New

Construtor da classe.


Sintaxe

FWFormBrowse(): New ( [ ] ) --> oSelf


Parâmetros


 

NomeTipoDescriçãoObrigatórioReferência
 

Array of Record
   

 





Retorno
oSelf
    ()
  • Retorbna o objeto da classe

Observações

Métodos
Activate

Activate

Ativação da classe.


Sintaxe

FWFormBrowse(): Activate ( [ oOwner] ) -->


Parâmetros


 

NomeTipoDescriçãoObrigatórioReferência
oOwnerObjetoObjeto do tipo container que indica o local que será criado o Browse.
  

 





Observações
AddButton

AddButton

Adiciona um botão na área lateral do Browse.


Sintaxe

FWFormBrowse(): AddButton ( < cTitle>, [ xAction], [ uParam1], [ nOption], [ nVerify], [ lNeedFind], [ nRealOpc], [ cOperatId], [ cToolBar] ) -->


Parâmetros


 

NomeTipoDescriçãoObrigatórioReferência
cTitleCaracterTítulo do botão.X
 

xActionQualquerAção que será executada no clique do botão. Pode ser uma função ou um Code Block.
 
 


uParam1QualquerParâmetro reservado.
  


nOptionLógicoTipo 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)
  


nVerifyNuméricoNúmero do acesso a ser verificada a permissão para o usuário.
  


lNeedFindLógicoIndica a necessidade de pesquisar antes da manutenção do registro (Menu Funcional).
  


nRealOpcNuméricoIndica a opção real (ordem de criação) do aRotina antigo - Compatibilização com a MBrowse antiga.
 
 


cOperatIdCaracterIdentificador da opção do menu. Utilizado para relacionar o o botão à uma opção de menu.
  


cToolBarCaracterIndica o relacionamento com os botões da tela (FormBar).
  

 





Observações
O parâmetro <cTitle> deverá receber a string com o título que será impresso em cada botão exatamente como cada Módulo definiu, Framework não terá autonomia para alterar/formatar o título do botão, ficando com a responsabilidade de cada Módulo enviar o texto formatado(inclusive maiúsculas e minúsculas) da forma que foi definido para suas rotinas.
AfterOption

AfterOption

Permite realizar tratamentos após a execução da ação do botão.


Sintaxe

FWFormBrowse(): AfterOption ( < cFunction>, < nOption>, [ nVerify] ) -->


Parâmetros


 

NomeTipoDescriçãoObrigatórioReferência
cFunctionCaracterNome da função definida para o botão.X
 

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

nVerifyNuméricoNúmero do acesso a ser validada a permissão do usuário.
  
 




Observações
BeforeOption

BeforeOption

Permite realizar tratamentos antes da execução da ação do botão.


Sintaxe

FWFormBrowse(): BeforeOption ( < cFunction>, < nOption>, [ nVerify], [ cTitle], [ nRealOpc] ) --> lReturn


Parâmetros


 

NomeTipoDescriçãoObrigatórioReferência
cFunctionCaracterIndica o nome da função definida para o botão.X
 

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

nVerifyNuméricoNúmero do acesso a ser validada a permissão do usuário.
 
 


cTitleCaracterIndica o título da janela.
  


nRealOpcNuméricoIndica a popsição do botão selecionado.
 
 

 




Retorno
lReturn
    (logico)
  • Indica se a ação pode ser executada.

Observações
ClassName

ClassName

Retorna o nome da classe (FWFORMBROWSE)


Sintaxe

FWFormBrowse(): ClassName ( ) --> cClassName

Retorno
cClassName
    (caracter)
  • Retorna o nome da classe (FWFORMBROWSE)

Observações
CleanFilter

CleanFilter

Realiza a limpeza dos filtros utilizados no Browse.


Sintaxe

FWFormBrowse(): CleanFilter ( ) -->


Observações
DeActivate

DeActivate

Método que permite destruir a classe.


Sintaxe

FWFormBrowse(): DeActivate ( [ lFreeChildren] ) -->


Parâmetros
 


NomeTipoDescriçãoObrigatórioReferência
lFreeChildrenLógicoIndica se deve ser realizada a limpeza dos componentes do objeto do tipo container. (oOwner)
  
 




Observações
Disable

Disable

Desabilita a utilização do Browse.


Sintaxe

FWFormBrowse(): Disable ( ) -->


Observações
DisableDetails

DisableDetails

Desabilita a apresentação dos detalhes no Browse.


Sintaxe

FWFormBrowse(): DisableDetails ( ) -->


Observações
Enable

Enable

Habilita a utilização do Browse.


Sintaxe

FWFormBrowse(): Enable ( ) -->


Observações
ExecuteFilter

ExecuteFilter

Realiza a aplicação dos filtros realizados no Browse.


Sintaxe

FWFormBrowse(): ExecuteFilter ( [ lBrwUpdate] ) -->


Parâmetros
 


NomeTipoDescriçãoObrigatórioReferência
lBrwUpdateLógicoIndica se deve ser realizado o refresh do Browse.
  

 





Observações
ForceQuitButton

ForceQuitButton

Força a exibição sair para Browses não ancorados diretamente em alguns containers.


Sintaxe

FWFormBrowse(): ForceQuitButton ( [ lSet] ) -->


Parâmetros


 

NomeTipoDescriçãoObrigatórioReferência
lSetLógicoIndica se força a exibiçao do botão Sair.
  

 





Observações
FWBrowse

FWBrowse

Retorna o objeto Browse (FWBROWSE)


Sintaxe

FWFormBrowse(): FWBrowse ( ) --> oBrowse

Retorno
oBrowse
    ()
  • Retorna o componente Browse (FWBROWSE).

Observações
GetButton

GetButton

Retorna os botões disponíveis no menu lateral do Browse.


Sintaxe

FWFormBrowse(): GetButton ( [ nButton] ) --> aButtons


Parâmetros
 


NomeTipoDescriçãoObrigatórioReferência
nButtonNuméricoIndica o botão que deverá ser retornado e quando não informado será retornado todos os botões.
  

 




Retorno
aButtons
    (array_of_record)
  • Retorna os botões disponíveis no menu lateral do Browse.

Observações
GetOwner

GetOwner

Retorna o container de criação do Browse.


Sintaxe

FWFormBrowse(): GetOwner ( ) --> oOwner

Retorno
oOwner
    ()
  • Retorna o container de criação do Browse

Observações
SetAfterExec

SetAfterExec

Indica o Code-Block executado após a execução da operação definida para o botão.


Sintaxe

FWFormBrowse(): SetAfterExec ( < bAfterExec> ) -->


Parâmetros
 


NomeTipoDescriçãoObrigatórioReferência
bAfterExecBloco de códigoCode-Block executado após a execução da operação definida para o botão.X
 
 



Observações
SetBeforeExec

SetBeforeExec

Indica o Code-Block executado antes a execução da operação definida para o botão.


Sintaxe

FWFormBrowse(): SetBeforeExec ( < bBeforeExec> ) -->


Parâmetros
 


NomeTipoDescriçãoObrigatórioReferência
bBeforeExecBloco de códigoCode-Block executado antes a execução da operação definida para o botão.X
 
 



Observações
SetbOKMVCWindow

SetbOKMVCWindow

Indica o Code-Block executado ao clicar na opção OK da MVCWINDOW.


Sintaxe

FWFormBrowse(): SetbOKMVCWindow ( < bOKMVCWindow> ) -->


Parâmetros
 


NomeTipoDescriçãoObrigatórioReferência
bOKMVCWindowBloco de códigoCode-Block executado ao clicar na opção OK da MVCWINDOW.X
 

 




Observações
SetCacheView

SetCacheView

Define se o browse faz o cache do View, o default do browse é fazer o cache, porém se tivermos varios views condicionais devemos não utilizar o cache.


Sintaxe

FWFormBrowse(): SetCacheView ( [ lCacheView] ) -->


Parâmetros


 

NomeTipoDescriçãoObrigatórioReferência
lCacheViewLógicoIndica se deve ativar o cache de View.
 
 

 





Observações
SetCheckLoop

SetCheckLoop

Indica o Code-Block executado na verificação do Loop da execução da rotina.


Sintaxe

FWFormBrowse(): SetCheckLoop ( < bCheckLoop> ) -->


Parâmetros
 


NomeTipoDescriçãoObrigatórioReferência
bCheckLoopBloco de códigoCode-Block executado na verificação do Loop da execução da rotina.X
 

 




Observações
SetDetails

SetDetails

Indica que deve ser disponibilizada a barra de detalhes no Browse.


Sintaxe

FWFormBrowse(): SetDetails ( [ lDetails], [ bDetails] ) -->


Parâmetros
 


NomeTipoDescriçãoObrigatórioReferência
lDetailsLógicoIndica que deverá ser disponibilizada a barra de detalhes no Browse.
  


bDetailsBloco de códigoCode-Block executado na carga do container dos detalhes. Quando não informado será utilizado o padrão.
  
 




Observações
SetEditDetail

SetEditDetail

Indica que deve ser disponibilizada a edição no detalhes do browse.


Sintaxe

FWFormBrowse(): SetEditDetail ( [ lEditDetail], [ oModel] ) -->


Parâmetros
 


NomeTipoDescriçãoObrigatórioReferência
lEditDetailLógicoIndica que deverá ser disponibilizada edição no browse
 
 


oModelObjetoObjeto do tipo FWFormModel que contem o modelo de edição para edição da linha no detalhes.
  

 





Observações
SetMenuDef

SetMenuDef

Indica o programa que é utilizado para a carga do menu funcional.


Sintaxe

FWFormBrowse(): SetMenuDef ( [ cMenuDef] ) -->


Parâmetros


 

NomeTipoDescriçãoObrigatórioReferência
cMenuDefCaracterIndica o programa que será utilizado para a carga do menu funcional
  
 




Observações
SetNoBrowse

SetNoBrowse

Indica que a execução das operações dos botões não deverão atualizar o Browse.


Sintaxe

FWFormBrowse(): SetNoBrowse ( [ lNoBrowse] ) -->


Parâmetros


 

NomeTipoDescriçãoObrigatórioReferência
lNoBrowseLógicoIndica que a execução das operações dos botões não deverão atualizar o Browse.
  
 




Observações
SetOwner

SetOwner

Indica o container para criação do Browse.


Sintaxe

FWFormBrowse(): SetOwner ( [ oOwner] ) -->


Parâmetros
 


NomeTipoDescriçãoObrigatórioReferência
oOwnerObjetoIndica o container para criação do Browse.
  
 




Observações
SetParam

SetParam

Indica o Code-Block executado ao pressionar a tecla F12.


Sintaxe

FWFormBrowse(): SetParam ( < bParam> ) -->


Parâmetros
 


NomeTipoDescriçãoObrigatórioReferência
bParamBloco de códigoCode-Block executado ao pressionar a tecla F12.X
 

 




Observações
SetSizeBrowse

SetSizeBrowse

Indica o tamanho em percentual do Browse na tela.


Sintaxe

FWFormBrowse(): SetSizeBrowse ( < nPerc> ) -->


Parâmetros
 


NomeTipoDescriçãoObrigatórioReferência
nPercNuméricoIndica o tamanho em percentual do Browse na tela.X
 

 




Observações
SetSizeDetails

SetSizeDetails

Indica o tamanho em percentual dos detalhes do Browse na tela.


Sintaxe

FWFormBrowse(): SetSizeDetails ( < nPerc> ) -->


Parâmetros


 

NomeTipoDescriçãoObrigatórioReferência
nPercNuméricoIndica o percentual do tamanho dos detalhes.X
 

 




Observações
SetTemporary

SetTemporary

Indica que o Browse utiliza tabela temporária.


Sintaxe

FWFormBrowse(): SetTemporary ( [ lTemporary] ) -->


Parâmetros


 

NomeTipoDescriçãoObrigatórioReferência
lTemporaryLógicoIndica que o Browse utiliza tabela temporária.
  

 





Observações
SetUseCaseFilter

SetUseCaseFilter

Indica que é permitido o filtro case-sensitive no Browse.


Sintaxe

FWFormBrowse(): SetUseCaseFilter ( [ lFilter] ) -->


Parâmetros


 

NomeTipoDescriçãoObrigatórioReferência
lFilterLógicoIndica que será permitido o filtro case-sensitive no Browse.
  
 




Observações
SetUseCursor

SetUseCursor

Define se as rotinas em MVC tem os botões de navegação.


Sintaxe

FWFormBrowse(): SetUseCursor ( [ lUseCursor] ) -->


Parâmetros
 


NomeTipoDescriçãoObrigatórioReferência
lUseCursorLógicoIndica se as rotinas em MVC teram os botões de navegação.
  

 





Observações
SetUseFilter

SetUseFilter

Indica que é permitido o filtro no Browse.


Sintaxe

FWFormBrowse(): SetUseFilter ( [ lFilter], [ bOnStart] ) -->


Parâmetros
 


NomeTipoDescriçãoObrigatórioReferência
lFilterLógicoIndica que será permitido o filtro no Browse.
 
 


bOnStartBloco de códigoCode-Block executado na criação do componente de filtro.
  

 





Observações
Temporary

Temporary

Retorna se o Browse utiliza tabela temporária.


Sintaxe

FWFormBrowse(): Temporary ( ) --> lTemporary

Retorno
lTemporary
    (logico)
  • Indica que o Browse utiliza tabela temporária.

Observações
UpdateDetails

UpdateDetails

Executa a atualização das informações nos detalhes do Browse.


Sintaxe

FWFormBrowse(): UpdateDetails ( ) -->


Observações
SetFixedBrowse

SetFixedBrowse

Seta a fixação do Layer do Browse, não permitindo minimizar a tela do browse.

Sintaxe

FWFormBrowse(): SetFixedBrowse ( lFixed ) --> nil

Parâmetros


 

NomeTipoDescriçãoObrigatórioReferência
lFixedLógico.T. - Fixa o Layer do Browse. Default .F.
  

 




SetFixedDetails

SetFixedDetails

Seta a fixação do Layer do Detalhes, não permitindo minimizar a tela de Detalhes do browse.

Sintaxe

FWFormBrowse(): SetFixedDetails ( lFixed ) --> nil

Parâmetros


 

NomeTipoDescriçãoObrigatórioReferência
lFixedLógico.T. - Fixa o Layer do Detalhes. Default .F.
  
 



Exemplos
#INCLUDE "FWBROWSE.CH"
User Function FormBrwTable()
Local oBrowse
Local oButton
Local oColumn
LocaloBrowseLocal oButtonLocal oColumnLocal oDlg
//-------------------------------------------------------------------
// Abertura da tabela
//-------------------------------------------------------------------
DbUseArea(.T.,,"SX2990","SX2",.T.,.F.)
DbSetOrder(1)
//-------------------------------------------------------------------
// Define a janela do Browse
//-------------------------------------------------------------------
DEFINE MSDIALOG oDlg FROM 0,0 TO 600,800 PIXEL	
//-------------------------------------------------------------------	
// Define o Browse	
//-------------------------------------------------------------------	
DEFINE FWFORMBROWSE oBrowse DATA TABLE ALIAS "SX2" OF oDlg		
//--------------------------------------------------------		
// Cria uma coluna de marca/desmarca		
//--------------------------------------------------------		
ADD MARKCOLUMN oColumn DATA { || If(.T./* Função com a regra*/,'LBOK','LBNO') } DOUBLECLICK { |oBrowse| /* Função que atualiza a regra*/ } HEADERCLICK { |oBrowse| /* Função executada no clique do header */ } OF oBrowse		
//--------------------------------------------------------		
// Cria uma coluna de status		
//--------------------------------------------------------		
ADD STATUSCOLUMN oColumn DATA { || If(.T./* Função com a regra*/,'BR_VERDE','BR_VERMELHO') } DOUBLECLICK { |oBrowse| /* Função executada no duplo clique na coluna*/ } OF oBrowse		
//--------------------------------------------------------		
// Adiciona legenda no Browse		
//--------------------------------------------------------		
ADD LEGEND DATA 'X2_CHAVE $ "AA1|AA2"'    COLOR "GREEN" TITLE "Chave teste 1" OF oBrowse		
ADD LEGEND DATA '!(X2_CHAVE $ "AA1|AA2")' COLOR "RED"   TITLE "Chave teste 2" OF oBrowse		
//-------------------------------------------------------------------		
// Adiciona as colunas do Browse		
//-------------------------------------------------------------------		
ADD BUTTON oButton TITLE "Botão 1" ACTION { || MsgAlert(oBrowse:At()) } OF oBrowse		
ADD BUTTON oButton TITLE "Botão 2" ACTION { || MsgAlert(oBrowse:At()) } OF oBrowse		
//-------------------------------------------------------------------		
// Adiciona as colunas do Browse		
//-------------------------------------------------------------------		
ADD COLUMN oColumn DATA { || X2_CHAVE   } TITLE "Chave"     SIZE  3 OF oBrowse		
ADD COLUMN oColumn DATA { || X2_ARQUIVO } TITLE "Arquivo"   SIZE 10 OF oBrowse		
ADD COLUMN oColumn DATA { || X2_NOME    } TITLE "Descrição" SIZE 40 OF oBrowse		
ADD COLUMN oColumn DATA { || X2_MODO    } TITLE "Modo"      SIZE  1 OF oBrowse	
//-------------------------------------------------------------------	
// Ativação do Browse	
//-------------------------------------------------------------------	
ACTIVATE FWFORMBROWSE oBrowse
//-------------------------------------------------------------------
// Ativação do janela
//-------------------------------------------------------------------
ACTIVATE MSDIALOG oDlg CENTEREDReturnCENTERED
Return

Abrangência
Microsiga Protheus 11 , Protheus 10

 

 

...