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, parameterValues [, options])

Formata o html que deve ser renderizado no cliente.

Parameters:
Name Type Argument Description
content string

Conteúdo que será exibido no cliente.
parameterValues Array

Parâmetros ligados a esta coleção.
options Object <optional>

Opções.

Properties
Name Type Argument Description
cssClass string <optional>

Classe CSS adicional a ser aplicada nesta âncora. Deve ser informado apenas o nome da classe CSS. Exemplo: 'custom-class'.
key number <optional>

Se esta coleção for vinculada a uma chave ela deve ser definida neste parâmetro.

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