nginstack

Class: LinkSet

@nginstack/web-framework/lib/anchor/LinkSet~ LinkSet

new LinkSet(attachedTo, process)

Objeto que armazena uma coleção de links.

Parameters:
Name Type Description
attachedTo ViewDefField | Column

Indica a qual objeto esta coleção está ligada.
process Process

Processo ao qual esta coleção pertence.

Extends

  • ServerComponent

Members

alwaysShowMenu :boolean

Por padrão, o menu com os links é exibido para o usuário apenas quando há mais de um link associado a uma coluna de um relatório, diferentemente das colunas da grade, onde o menu sempre é apresentado. Esta opção permite forçar que o menu sempre seja exibido, mesmo quando há apenas um link a ser exibido.

Type:
  • boolean
Example
col = sl.column('test');
col.links.alwaysShowMenu = true;
col.links(link);

Lista de links anexados nessa coleção.

Type:
  • Array.<Link>

size :number

Quantidade de links nesta coleção.

Type:
  • number

Methods

add(value)

Recebe um ou mais links para adicionar na coleção.

Parameters:
Name Type Description
value Link | Array.<Link>

Objetos Link que serão adicionados.

at(position)

Obtém um link na posição informada. O valor informado deve ser um número maior ou igual a zero.

Parameters:
Name Type Description
position number
Returns:
Type
Link

clear()

Esvazia a coleção links.

formatHtml(content [, openParameterValues] [, options])

Formata o html que deve ser renderizado no cliente.

Parameters:
Name Type Argument Description
content string

Conteúdo que será exibido no cliente.
openParameterValues Array <optional>

Valores dos parâmetros abertos dos links declarados em parameters.
options Object <optional>

Opções.

Properties
Name Type Argument Description
cssClass string <optional>

Classe CSS adicional que será aplicada à âncora que abre o menu de links. Múltiplas classes podem ser informadas separadas por espaço.
cssStyle Record.<string, string> <optional>

Estilos CSS em linha que serão aplicados à âncora que abre o menu de links.
key number <optional>

Se esta coleção for vinculada a uma chave ela deve ser definida nesta opção.
storedParametersIds Record.<string, string> <optional>

Mapa relacionando o nome do link ao id dos parâmetros armazenados no servidor. Os parâmetros são persistidos automaticamente pela método formatHtml, portanto, esta opção deve ser informada apenas se os parâmetros precisarem ser persistidos antes da escrita do LinkSet. Esta opção não pode ser utilizada em conjunto com o parâmetro openParameterValues, pois a persistência dos novos parâmetros descartaria os valores persistidos anteriormente.

getFieldLinkSetData()

Obtém os dados para construção dos links de um campo da grade.

Returns:
Type
FieldLinkSetData

isAttachedTo(component)

Indica se esse LinkSet está anexado no componente informado via parâmetro.

Parameters:
Name Type Description
component ViewDefField | Column
Returns:
Type
boolean

storeParameters( [openParameterValues])

Persiste os parâmetros de todos os links e retorna um mapa associando o nome do link ao identificador dos parâmetros persistidos. Este método é chamado automaticamente pelo formatHtml e deve ser utilizado apenas em cenários mais avançados de uso, onde a coleta de parâmetros ocorre antes da escrita do linkSet. Nesse caso, o mapa retornado por este método pode ser informado na opção `storedParametersIds'

Parameters:
Name Type Argument Description
openParameterValues Array <optional>

Valores dos parâmetros abertos dos links declarados em parameters.
Returns:

Mapa relacionando o nome do link ao id de armazenamento dos parâmetros.

Type
Record.<string, string>