Class: GlobalAction

@nginstack/web-framework/lib/classdef/GlobalAction~ GlobalAction


new GlobalAction(name)

Ação global que pode ser executada em um registro de uma classe. Uma ação global é um conjunto de meta-dados que define o que pode ser feito com o registro de uma determinada classe. Por exemplo, uma ação global pode ser a devolução de um pedido, ou a baixa de um título.

Parameters:
Name Type Description
name string

O nome da ação. Deve ser único por classe.

Members


<nullable> activity :string

A atividade a ser usada no alvo aberto pela ação.

Type:
  • string

caption :string

Texto padrão a ser usado onde a ação for exibida.

Type:
  • string

defaultKeyParamName :string

Define o nome do parâmetro que conterá a chave referenciada pelo click.

Type:
  • string
Default Value:
  • __key

enabled :boolean

Indica se a ação está habilitada.

Type:
  • boolean

help :string

A ajuda desta ação.

Type:
  • string

hint :string

Pequena ajuda sobre esta ação, que aparecerá como "tooltip".

Type:
  • string

<nullable> interaction :string

A interação a ser usada no alvo aberto pela ação.

Type:
  • string

name :string

O nome da ação global.

Type:
  • string

onShow :LegacyEvent

Evento que será rodado antes da exibição das ações globais. Para esta função será recebido esta ação e a chave. O valor retornado deverá ser um global action que irá substituir o original.

Type:
  • LegacyEvent

params :Object.<(string|number|boolean|date|null)>

Conjunto de parâmetros para esta ação.

Type:
  • Object.<(string|number|boolean|date|null)>

<nullable> targetKey :number

A chave do alvo (processo ou relatório) da ação.

Type:
  • number

visible :boolean

Indica se a ação pode ser visualizada na interface.

Type:
  • boolean

Methods


addParameter(param)

Adiciona um parâmetro à ação global.

Parameters:
Name Type Description
param Object

O parâmetro a ser adicionado.

Deprecated:
  • Usar #params

clone()

Clone esta ação.

Returns:

Um clone profundo da instância.

Type
GlobalAction

getParameter(paramName)

Recupera um parâmetro da ação global.

Parameters:
Name Type Description
paramName string

O nome do parâmetro.

Deprecated:
  • Usar #params
Returns:

O parâmetro requisitado.

Type
Object

getParameters()

Lista todos os parâmetros definidos para esta ação.

Deprecated:
  • Usar #params
Returns:

Parâmetros.

Type
Object.<(string|number|boolean|date|null)>