Frameworksp

Páginas filhas
  • FWFilter

Versões comparadas

Versão antiga 2

changes.mady.by.user Eduardo De Souza ( Gdp )

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Daniel Mendes De Melo Sousa

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Composition Setup
import.css=/download/attachments/327912/newLayout.css
Classe: FWFilter


 

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ão10.1.1.4
 


FWFilter
Descrição
Fornece um objeto que permite a inclusão, exclusão e execução de filtros nas rotinas
New
Sintaxe
FWFilter():New(< oOwner >, < bCanUse >)-> oSelf

Descrição
Método construtor da classe

Parâmetros

 

 



NomeTipoDescriçãoDefaultObrigatórioReferência
 

oOwnerObjetoObjeto proprietário
 

X
  


bCanUseCode-BlockCode-Block de habilitacao de uso
 

X
 
 


 

Retorno
oSelf Objeto FWFilter
Activate
Sintaxe
FWFilter():Activate(< oOwner >, < lShow >)-> NIL

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

Parâmetros

 

 



NomeTipoDescriçãoDefaultObrigatórioReferência
 

oOwnerObjetoObjeto proprietário
 

X
  


lShowLógicoIndica se realiza a abertura da tela de filtros
 

X


 

 

 
CheckFil
Sintaxe
FWFilter():CheckFil()-> aCheckFil

Descrição
Retorna a seleção dos filtros

Retorno
aCheckFil Seleção dos Filtros
ClassName
Sintaxe
FWFilter():ClassName()-> cClassName

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

Retorno
cClassName Nome da classe
DeActivate
Sintaxe
FWFilter():DeActivate()-> NIL

Descrição
Método destrutor da classe
DeleteFilter
Sintaxe
FWFilter():DeleteFilter(< cID >)-> NIL

Descrição
Permite realizar a exclusão de filtros

Parâmetros


 

 

NomeTipoDescriçãoDefaultObrigatórioReferência
 

cIDCaracteresIdentificador do Filtro
 

X
 
 


 
DisableAdd
Sintaxe
FWFilter():DisableAdd(< lDisable >)-> NIL

Descrição
Desabilita a inclusão dos filtros pelo usuário

Parâmetros
 


 

NomeTipoDescriçãoDefaultObrigatórioReferência
 

lDisableLógicoIndica que a inclusão dos filtros está indisponível
 

X
 
 


 
DisableDel
Sintaxe
FWFilter():DisableDel(< lDisable >)-> NIL

Descrição
Desabilita a exclusão dos filtros pelo usuário

Parâmetros
 


 

NomeTipoDescriçãoDefaultObrigatórioReferência
 

lDisableLógicoIndica que a exclusão dos filtros está indisponível
 

X


 

 

 
DisableExecute
Sintaxe
FWFilter():DisableExecute(< lDisable >)-> NIL

Descrição
Desabilita a execusão dos filtros pelo usuário

Parâmetros

 

 



NomeTipoDescriçãoDefaultObrigatórioReferência
 

lDisableLógicoIndica que a execução dos filtros está indisponível
 

X
 
 


 
DisableSave
Sintaxe
FWFilter():DisableSave(< lDisable >)-> NIL

Descrição
Desabilita a gravação dos filtros realizados pelo usuário.

Parâmetros

 

 



NomeTipoDescriçãoDefaultObrigatórioReferência
 

lDisableLógicoDefine se habilita ou nao a gravação dos filtros realizados pelo usuário.
 

X
 


  
DisableValid
Sintaxe
FWFilter():DisableValid()-> NIL

Descrição
Desabilita a validação da condiçção de filtro informada pelo usuário.
CleanFilter
Sintaxe
FWFilter():CleanFilter(< lDeActivate >)-> NIL

Descrição
Executa a limpeza de todos filtros adicionados pelo usuário

Parâmetros


 

 

NomeTipoDescriçãoDefaultObrigatórioReferência
 

lDeActivateLógicolDeActivate
 

X
 
 


 
EditText
Sintaxe
FWFilter():EditText(< nPosFilter >, < oCheck >)-> NIL

Descrição
Permite a edição do texto do filtro

Parâmetros


 

 

NomeTipoDescriçãoDefaultObrigatórioReferência
 

nPosFilterNuméricoIndica a posição do item no array aFilter
 

X
  


oCheckObjetoObjeto TCheckbox utilizado para atualizar a descrição
 

X
 


  
ExecuteFilter
Sintaxe
FWFilter():ExecuteFilter()-> NIL

Descrição
Executa o Code-Block, definido no método SetExecute(bFilter), para aplicação dos filtros
Finish
Sintaxe
FWFilter():Finish()-> NIL

Descrição
Executa um bloco de códigos na finalização da janela filtrar
GetAlign
Sintaxe
FWFilter():GetAlign()-> nAlign

Descrição
Retorna o alinhamento do componente na janela

Retorno
nAlign Alinhamento do componente na janela
GetButton
Sintaxe
FWFilter():GetButton()-> Indica

Descrição
Retorna se deverá exibir o componente, no objeto proprietário, através de um botão.

Retorno
Indica se exibe o objeto através de um botão
GetExprADVPL
Sintaxe
FWFilter():GetExprADVPL()-> cExpression

Descrição
Retorna a expressão dos filtros realizados em formato ADVPL

Retorno
cExpression Expressão dos filtros realizados em formato ADVPL
GetExprSQL
Sintaxe
FWFilter():GetExprSQL()-> cExpression

Descrição
Retorna a expressão dos filtros realizados em formato SQL

Retorno
cExpression Expressão dos filtros realizados em formato SQL
GetFilter
Sintaxe
FWFilter():GetFilter(< lFilterAsk >)-> aReturn

Descrição
Retorna a lista de filtros realizados

Parâmetros


 

 

NomeTipoDescriçãoDefaultObrigatórioReferência
 

lFilterAskLógicoIndica se deve ser executado o filtro do tipo pergunta
 

X
 
 


Retorno
aReturn - Array com as informações do filtro
Lista de filtros
[n,1] Expressão literal
[n,2] Expressão no formato AdvPL
[n,3] Expressão no formato SQL
[n,4] Parser do filtro
[n,4,n,1] String contendo o campo, operador ou expressão do filtro
[n,4,n,2] Indica o tipo do parser (FIELD=Campo,OPERATOR=Operador e EXPRESSION=Expressão)
[n,5] Indica que não poderá retirar a marca
[n,6] Marcado/Desmarcado
[n,7] Indica se o filtro pergunta as informações na execução
[n,8] Alias
GetFilterRelation

Observação
As posições dos filtros ADVPL e SQL podem estar vazias, portanto é necessária a validação das mesmas antes do uso, essa situação acontece por exemplo quando é selecionada a opção de informar o valor do filtro no momento da execução do mesmo.
GetFilterRelation
Sintaxe
FWFilter():GetFilterRelation()
Sintaxe
FWFilter():GetFilterRelation()-> aReturn

Descrição
Retorna a lista de filtros do relacionamento realizados

Retorno
aReturn
Lista de filtros
[n,1] Expressão literal
[n,2] Expressão no formato AdvPL
[n,3] Expressão no formato SQL
[n,4] Parser do filtro
[n,4,n,1] String contendo o campo, operador ou expressão do filtro
[n,4,n,2] Indica o tipo do parser (FIELD=Campo,OPERATOR=Operador e EXPRESSION=Expressão)
[n,5] Marcado/Desmarcado
[n,6] Indica se o filtro pergunta as informações na execução
[n,7] Indica que não poderá retirar a marca
[n,8] Alias
GetFilterAdvPL
Sintaxe
FWFilter():GetFilterAdvPL(< nFilter >)-> cReturn

Descrição
Retorna um filtro da lista no formato AdvPL

Parâmetros


 

 

NomeTipoDescriçãoDefaultObrigatórioReferência
 

nFilterNuméricoIndica a posição do filtro na lista
 

X


 

 

 

Retorno
cReturn Expressão do filtro no formato AdvPL
GetFilterSql
Sintaxe
FWFilter():GetFilterSql(< nFilter >)-> cReturn

Descrição
Retorna um filtro da lista no formato AdvPL

Parâmetros

 

 



NomeTipoDescriçãoDefaultObrigatórioReferência
 

nFilterNuméricoIndica a posição do filtro na lista
 

X
 


  

Retorno
cReturn Expressão do filtro no formato AdvPL
GetFilterParser
Sintaxe
FWFilter():GetFilterParser(< nFilter >)-> aReturn

Descrição
Retorna o parser de um filtro da lista

Parâmetros
 


 

NomeTipoDescriçãoDefaultObrigatórioReferência
 

nFilterNuméricoIndica a posição do filtro na lista
 

X
 


  

Retorno
aReturn
Estrutura do array
[n,1] String contendo o campo, operador ou expressão do filtro
[n,2] Indica o tipo do parser (FIELD=Campo,OPERATOR=Operador e EXPRESSION=Expressão)
GetLiteralFilter
Sintaxe
FWFilter():GetLiteralFilter(< nFilter >)-> cReturn

Descrição
Retorna a descrição de um filtro da lista

Parâmetros
 


 

NomeTipoDescriçãoDefaultObrigatórioReferência
 

nFilterNuméricoIndica a posição do filtro na lista
 

X
 
 


 

Retorno
cReturn Descrição do filtro
GetProfileID
Sintaxe
FWFilter():GetProfileID()-> cProfileID

Descrição
Retorna o identificador do Browse utiliza na gravação das configurações no profile do usuário. Deve ser utilizado quando existir mais de um filtro na rotina.

Retorno
cProfileID Identificador do filtro
GetRelation
Sintaxe
FWFilter():GetRelation()-> aRelation

Descrição
Retorna os relacionamentos de tabelas no filtro

Retorno
aRelation
Array contendo os itens do relacionamento aRelation
[n,1] - Se .T., indica que o relacionamento foi selecionado aRelation
[n,2] - Alias aRelation
[n,3] - Descrição da tabela aRelation
[n,4] - Campos de relacionamento da tabela do principal aRelation
[n,5] - Campos de relacionamento da tabela do alias
Hide
Sintaxe
FWFilter():Hide()-> NIL

Descrição
Torna o filtro invisível
LoadFilter
Sintaxe
FWFilter():LoadFilter()-> NIL

Descrição
Carrega aos filtros gravados para o usuário
Relation
Sintaxe
FWFilter():Relation()-> NIL

Descrição
Permite definir os relacionamentos para o filtro
SaveFilter
Sintaxe
FWFilter():SaveFilter()-> NIL

Descrição
Salva os filtros de usuário utilizando a classe FWProfile
SetAlias
Sintaxe
FWFilter():SetAlias(< cAlias >)-> NIL

Descrição
Indica o alias da tabela que será utilizada no Browse

Parâmetros


 

 

NomeTipoDescriçãoDefaultObrigatórioReferência
 

cAliasCaracteresAlias da tabela
 

X
 
 


 
SetAlign
Sintaxe
FWFilter():SetAlign(< nAlign >)-> NIL

Descrição
Indica o alinhamento do componente na janela
Parâmetros
  

Parâmetros



NomeTipoDescriçãoDefaultObrigatórioReferência
 

nAlignNuméricoAlinhamento do componente na janela
 

X
 


  
SetButton
Sintaxe
FWFilter():SetButton()-> NIL

Descrição
Indica se deverá exibir o componente, no objeto proprietário, através de um botão.
SetExecute
Sintaxe
FWFilter():SetExecute(< bFilter >)-> NIL

Descrição
Indica o Code-Block executado na ação do botão "Executar"

Parâmetros
 


 

NomeTipoDescriçãoDefaultObrigatórioReferência
 

bFilterCode-BlockCode-Block executado na ação do botão "Executar"
 

X
 
 


 
SetCanFilterAsk
Sintaxe
FWFilter():SetCanFilterAsk(< lCanFilterAsk >)-> NIL

Descrição
Indica se permite executar filtros com interação do usuário

Parâmetros

 

 



NomeTipoDescriçãoDefaultObrigatórioReferência
 

lCanFilterAskLógicoIndica se permite executar filtros com interação do usuário
 

X
 
 


 
SetCanUse
Sintaxe
FWFilter():SetCanUse(< bCanUse >)-> NIL

Descrição
Indica se permite executar filtros

Parâmetros
 


 

NomeTipoDescriçãoDefaultObrigatórioReferência
 

bCanUseCode-BlockIndica se permite executar filtros
 

X


 

 

 
SetCleanFilter
Sintaxe
FWFilter():SetCleanFilter(< bCleanFilter >)-> NIL

Descrição
Indica o Code-Block executado na ação do botão "Limpar"

Parâmetros
 


 

NomeTipoDescriçãoDefaultObrigatórioReferência
 

bCleanFilterCode-BlockCode-Block executado na ação do botão "Limpar"
 X 
 

X


 
SetField
Sintaxe
FWFilter():SetField(< aFields >)-> NIL

Descrição
Indica os campos disponíveis para edição dos filtros

Parâmetros

 

 



NomeTipoDescriçãoDefaultObrigatórioReferência
 

aFieldsArray of RecordsEstrutura do array
[n][01] Campo
[n][02] Título
[n][03] Tipo de dado
[n][04] Tamanho
[n][05] Decimal
[n][06] Picture
[n][07] aOptions
[n][08] cLookUp
[n][09] bValid Indica o Code-Block de validação do campo
[n][10] xAnswer Resposta para a pergunta
 

X
 


  
SetFinish
Sintaxe
FWFilter():SetFinish(< bFinish >)-> NIL

Descrição
Code-Block executado na finalização da janela localizar

Parâmetros


 

 

NomeTipoDescriçãoDefaultObrigatórioReferência
 

bFinishCode-BlockCode-Block executado a ser executado
 

X
 
 


 
SetOnStart
Sintaxe
FWFilter():SetOnStart(< bOnStart >)-> NIL

Descrição
Indica o Code-Block executado na criação do componente de filtro

Parâmetros

 

 



NomeTipoDescriçãoDefaultObrigatórioReferência
 

bOnStartCode-BlockCode-Block executado na criação do componente de filtro
 

X
 


  
SetProfileID
Sintaxe
FWFilter():SetProfileID(< cProfielID >)-> NIL

Descrição
Define o identificador do Browse utiliza na gravação das configurações no profile do usuário. Deve ser utilizado quando existir mais de um filtro na rotina.

Parâmetros
 


 

NomeTipoDescriçãoDefaultObrigatórioReferência
 

cProfielIDCaracteresIdentificador do Filtro
 

X
 


  
SetRelation
Sintaxe
FWFilter():SetRelation(< aRelation >, < bChangeFields >)-> NIL

Descrição
Indica que deverá disponibilizar a opção de relacionamento de tabelas no filtro

Parâmetros

 

 



NomeTipoDescriçãoDefaultObrigatórioReferência
 

aRelationArray of RecordsArray contendo os itens do relacionamento
aRelation[n,1] - Se .T., indica que o relacionamento foi selecionado
aRelation[n,2] - Alias
aRelation[n,3] - Descrição da tabela
aRelation[n,4] - Campos de relacionamento da tabela do principal
aRelation[n,5] - Campos de relacionamento da tabela do alias
 

X
  


bChangeFieldsCode-BlockIndica o Code-Block executado para trocar os campos para o filtro
 

X
 


  
SetSqlFilter
Sintaxe
FWFilter():SetSqlFilter(< lSqlFilter >)-> NIL

Descrição
Indica que deverá disponibilizar a expressão SQL do filtro

Parâmetros
 


 

NomeTipoDescriçãoDefaultObrigatórioReferência
 

lSqlFilterLógicoIndica que deverá disponibilizar a expressão SQL do filtro
 

X
 
 


 
SetOwner
Sintaxe
FWFilter():SetOwner(< oOwner >)-> NIL

Descrição
Indica o container para criação do filtro

Parâmetros

 

 



NomeTipoDescriçãoDefaultObrigatórioReferência
 

oOwnerObjetoObjeto container
 

X
 
 


 
SetValidExecute
Sintaxe
FWFilter():SetValidExecute(< bValidExecute >)-> NIL

Descrição
Define um bloco de códigos para validar se o filtro deve ser executado

Parâmetros
 


 

NomeTipoDescriçãoDefaultObrigatórioReferência
 

bValidExecuteCode-BlockBloco de código a ser utilizado
 

X


 

 

 
Show
Sintaxe
FWFilter():Show()-> NIL

Descrição
Torna o filtro visível
UnCheckFilter
Sintaxe
FWFilter():UnCheckFilter(< cID >)-> NIL

Descrição
Permite desmarcar a execução de filtros específicos

Parâmetros
 


 

NomeTipoDescriçãoDefaultObrigatórioReferência
 

cIDCaracteresIdentificador do Filtro
 

X
 
 


 
Valid
Sintaxe
FWFilter():Valid()-> lValid

Descrição
Retorna se deverá realizar a validação do filtro informado pelo usuário

Retorno
lValid Indica se deverá realizar a validação do filtro informado pelo usuário
Visible
Sintaxe
FWFilter():Visible()-> lVisible

Descrição
Retorna se o filtro está visível

Retorno
lVisible Indica se o filtro está visível