Class: Header

Members

---

autoSanitize :boolean

Determina se os textos escritos no cabeçalho são tratados para remover tags que possam ser utilizadas com o objetivo de injetar scripts maliciosos em ataques do tipo Cross Site Scripting (XSS).

Ao desativar esta propriedade, é de crítica importância que algum tipo de validação ou sanitização seja realizada no conteúdo a ser escrito na tela.

Type:

• boolean

---

complement :string

Complemento textual a ser exibido no cabeçalho.

Type:

• string

Default Value:

• ''

---

filtersDisplay :string

Indica a forma como as variáveis da consulta devem ser exibidas na visualização. Seus valores possíveis se encontram na enumeração FiltersDisplayMode.

Type:

• string

Default Value:

• FiltersDisplayMode.FILLED;

---

onAfterComplement :Event

Método disparado após a inserção do complemento do cabeçalho.

Type:

• Event

---

showDateTime :boolean

Indica se a data e a hora da consulta devem ser exibidas.

Type:

• boolean

Default Value:

• true

---

showEnterpriseName :boolean

Indica se o nome da empresa deve ser exibido no cabeçalho.

Type:

• boolean

Default Value:

• true

---

showUserAndDatabaseName :boolean

Indica se o nome do usuário e o da base de dados devem ser exibidos.

Type:

• boolean

Default Value:

• true

---

useTagsAsLiterals :boolean

Indica se tags HTML presentes nas strings do cabeçalho devem ser convertidas para texto literal durante a exibição.

Type:

• boolean

Default Value:

• true

---

visible :boolean

Indica se o cabeçalho deve ser exibido.

Type:

• boolean

Default Value:

• true

Methods

---

<static> groupFilters(filters)

Método usado para agrupar todos os filtros que possuem a mesma label e/ou mesmo grupo, evitando assim as redundâncias.

Parameters:

Name	Type	Description
filters

Returns:

Type

Array

---

formatFiltersToHeader(filters, convertTagsToLiterals, showAll)

Gera uma string contendo os nomes dos filtros informados, associados aos seus valores preenchidos.

Parameters:

Name	Type	Description
filters	Array.<FilterDef>	Objetos que representam os filtros utilizados na consulta.
convertTagsToLiterals	boolean	Indica se tags HTML devem ser convertidas para texto literal.
showAll	boolean	Indica se todos os filtros informados devem ser inclusos na string gerada, ou apenas aqueles filtros que possuem valor preenchido.

Returns:

Uma string relacionando os nomes dos filtros aos seus valores.

Type

string

---

writeHtml(sender, outputObj [, options])

Escreve o cabeçalho em formato HTML.

Parameters:

Name	Type	Argument	Description
sender	Visualization | SimpleLayout		O relatório cujas informações devem ser impressas no cabeçalho.
outputObj	Object		Objeto de output no qual o texto será escrito.
options	Object	<optional>	Opções que podem ser passadas para a função, para controlar a forma como o cabeçalho é montado. Properties Name Type Argument Description colspan number <optional> A quantidade de colunas sob o cabeçalho. enterpriseLogo number <optional> Chave da imagem de logotipo a ser usada no cabeçalho. mailObject Email <optional> Objeto de email no qual o conteúdo do rodapé deve ser escrito. filters Array.<{label: string, group: string, value: *}> <optional> Array de objetos que contém informações sobre os filtros utilizados na consulta.

---

writePlain(sender, outputObj, options)

Escreve o cabeçalho em um formato de texto plano.

Parameters:

Name	Type	Description
sender	SimpleLayout	O relatório cujas informações devem ser impressas no cabeçalho.
outputObj	Object	Objeto de output no qual o texto será escrito.
options	Object	Opções a serem utilizadas na escrita. Properties Name Type Argument Description leftMargin number O tamanho da margem esquerda do texto. calculatedWidth number A largura calculada do texto. currentPage number A página atual do texto. filters Array.<{label: string, group: string, value: *}> <optional> Array de objetos que contém informações sobre os filtros utilizados na consulta.