Páginas filhas
  • FWLegend

Descrição:

Classe para apresentação padronizada de legendas, apta para trabalhar com acessibilidade visual.


Métodos:



New

Descrição:
Método para instanciar a classe (construtor)


Sintaxe:

FWLegend():New() -> Objeto FWLegend


Add

Descrição:
Método responsável pela adição das cores e legendas


Sintaxe:

FWLegend():Add(<xCondition>, <cColor>, <cTitle>)

Parâmetros

NomeTipoDescriçãoObrigatório
xCondition Caracter / Bloco de código (Utilizado apenas pela FWBrowse)Condição para a exibição da legendaX
cColorCaracterCor da legendaX
cTitle CaracterTítulo da legenda


SetNumber

Descrição:
Método que permite definir se as legendas serão apresentadas de forma numérica


Sintaxe:

FWLegend():SetNumber(<lNumeric>)

Parâmetros

NomeTipoDescriçãoObrigatório
lNumeric LógicoIndica se as legendas serão exibidas como números


Observação:
Caso o Protheus esteja configurado para trabalhar com acessibilidade visual, mesmo informado um valor negativo (.F.), o parâmetro será ignorado e as legendas serão exibidas como números


Activate

Descrição:
Método responsável por ativar a classe para utilização


Sintaxe:

FWLegend():Activate()

View

Descrição:
Método responsável por exibir as legendas


Sintaxe:

FWLegend():View()


View()

Descrição:
Método responsável por exibir as legendas


Sintaxe:

FWLegend():View()


Deactivate

Descrição:
Método responsável por desativar a classe


Sintaxe:

FWLegend():Deactivate()



Exemplo geral de uso da classe

//-------------------------------------------------------------------
/*{Protheus.doc} u_legndTest
Função de exemplo de utilização da classe FWLegend

@author Daniel Mendes
@since 03/07/2020
@version 1.0
*/
//-------------------------------------------------------------------
function u_legndTest()
local oLegend as object

oLegend := FWLegend():New()

oLegend:Add("", "BR_VERDE", "Verde")
oLegend:Add("", "BR_AZUL", "Azul")
oLegend:Add("", "BR_VERMELHO", "Vermelho")
oLegend:Add("", "BR_AMARELO", "Amarelo")
oLegend:Add("", "BR_BRANCO", "Branco")
oLegend:Add("", "BR_CINZA", "Cinza")
oLegend:Add("", "BR_LARANJA", "Laranja")
oLegend:Add("", "BR_MARROM", "Marrom")

oLegend:Activate()
oLegend:View()

oLegend:Deactivate()

oLegend:SetNumber(.T.)

oLegend:Activate()
oLegend:View()

oLegend:Deactivate()

FreeObj(oLegend)

return


Observação

Nem todas as cores são convertidas em números para a acessibilidade visual, abaixo a lista das cores suportadas:

  • "RED" ou "BR_VERMELHO"
  • "GREEN" ou "BR_VERDE"
  • "YELLOW" ou "BR_AMARELO"
  • "BLUE" ou "BR_AZUL"
  • "WHITE" ou "BR_BRANCO"
  • "GRAY" ou "BR_CINZA"
  • "ORANGE" ou "BR_LARANJA"
  • "BROWN" ou "BR_MARROM"
  • "PINK" ou "BR_PINK"
  • "BLACK" ou "BR_PRETO"
  • "VIOLET" ou "BR_VIOLETA"
  • "HGREEN" ou "BR_VERDE_ESCURO"
  • "LBLUE" ou "BR_AZUL_CLARO"
  • "DISABLE" ou "BR_VERMELHO"
  • "ENABLE" ou "BR_VERDE"




Para utilizar dessa classe no browse, utilize do método AddLegend, método presente na classe FWBrowse:
https://tdn.totvs.com/display/PROT/FwBrowse