FWFilter

Fornece um objeto que permite a inclusão, exclusão e execução de filtros nas rotinas

New

FWFilter():New(< oOwner >, < bCanUse >)-> oSelf

Método construtor da classe

 

oSelf Objeto FWFilter

Activate

FWFilter():Activate(< oOwner >, < lShow >)-> NIL

Método de ativação da classe

 

CheckFil

FWFilter():CheckFil()-> aCheckFil

Retorna a seleção dos filtros

aCheckFil Seleção dos Filtros

ClassName

FWFilter():ClassName()-> cClassName

Retorna o nome da classe (FWFILTER)

cClassName Nome da classe

DeActivate

FWFilter():DeActivate()-> NIL

Método destrutor da classe

DeleteFilter

FWFilter():DeleteFilter(< cID >)-> NIL

Permite realizar a exclusão de filtros

 

DisableAdd

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

Desabilita a inclusão dos filtros pelo usuário

 

DisableDel

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

Desabilita a exclusão dos filtros pelo usuário

 

DisableExecute

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

Desabilita a execusão dos filtros pelo usuário

 

DisableSave

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

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

 

DisableValid

FWFilter():DisableValid()-> NIL

Desabilita a validação da condiçção de filtro informada pelo usuário.

CleanFilter

FWFilter():CleanFilter(< lDeActivate >)-> NIL

Executa a limpeza de todos filtros adicionados pelo usuário

 

EditText

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

Permite a edição do texto do filtro

 

ExecuteFilter

FWFilter():ExecuteFilter()-> NIL

Executa o Code-Block, definido no método SetExecute(bFilter), para aplicação dos filtros

Finish

FWFilter():Finish()-> NIL

Executa um bloco de códigos na finalização da janela filtrar

GetAlign

FWFilter():GetAlign()-> nAlign

Retorna o alinhamento do componente na janela

nAlign Alinhamento do componente na janela

GetButton

FWFilter():GetButton()-> Indica

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

Indica se exibe o objeto através de um botão

GetExprADVPL

FWFilter():GetExprADVPL()-> cExpression

Retorna a expressão dos filtros realizados em formato ADVPL

cExpression Expressão dos filtros realizados em formato ADVPL

GetExprSQL

FWFilter():GetExprSQL()-> cExpression

Retorna a expressão dos filtros realizados em formato SQL

cExpression Expressão dos filtros realizados em formato SQL

GetFilter

FWFilter():GetFilter(< lFilterAsk >)-> aReturn

Retorna a lista de filtros realizados

 

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] 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

FWFilter():GetFilterRelation()-> aReturn

Retorna a lista de filtros do relacionamento realizados

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

FWFilter():GetFilterAdvPL(< nFilter >)-> cReturn

Retorna um filtro da lista no formato AdvPL

 

cReturn Expressão do filtro no formato AdvPL

GetFilterSql

FWFilter():GetFilterSql(< nFilter >)-> cReturn

Retorna um filtro da lista no formato AdvPL

 

cReturn Expressão do filtro no formato AdvPL

GetFilterParser

FWFilter():GetFilterParser(< nFilter >)-> aReturn

Retorna o parser de um filtro da lista

 

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

FWFilter():GetLiteralFilter(< nFilter >)-> cReturn

Retorna a descrição de um filtro da lista

 

cReturn Descrição do filtro

GetProfileID

FWFilter():GetProfileID()-> cProfileID

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.

cProfileID Identificador do filtro

GetRelation

FWFilter():GetRelation()-> aRelation

Retorna os relacionamentos de tabelas no filtro

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

FWFilter():Hide()-> NIL

Torna o filtro invisível

LoadFilter

FWFilter():LoadFilter()-> NIL

Carrega aos filtros gravados para o usuário

Relation

FWFilter():Relation()-> NIL

Permite definir os relacionamentos para o filtro

SaveFilter

FWFilter():SaveFilter()-> NIL

Salva os filtros de usuário utilizando a classe FWProfile

SetAlias

FWFilter():SetAlias(< cAlias >)-> NIL

Indica o alias da tabela que será utilizada no Browse

 

SetAlign

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

Indica o alinhamento do componente na janela

 

SetButton

FWFilter():SetButton()-> NIL

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

SetExecute

FWFilter():SetExecute(< bFilter >)-> NIL

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

 

SetCanFilterAsk

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

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

 

SetCanUse

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

Indica se permite executar filtros

 

SetCleanFilter

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

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

 

SetField

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

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

 

SetFinish

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

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

 

SetOnStart

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

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

 

SetProfileID

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

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.

 

SetRelation

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

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

 

SetSqlFilter

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

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

 

SetOwner

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

Indica o container para criação do filtro

 

SetValidExecute

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

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

 

Show

FWFilter():Show()-> NIL

Torna o filtro visível

UnCheckFilter

FWFilter():UnCheckFilter(< cID >)-> NIL

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

 

Valid

FWFilter():Valid()-> lValid

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

lValid Indica se deverá realizar a validação do filtro informado pelo usuário

Visible

FWFilter():Visible()-> lVisible

Retorna se o filtro está visível

lVisible Indica se o filtro está visível