nginstack

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

hasPermissionControl :boolean

Indica se a ação global irá validar a permissão do usuário para a classe em que ela foi definida.

Type:
  • boolean
Default Value:
  • true

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 :Adapter

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:
  • Adapter
Deprecated:
  • Use this.on('show', listener);

params :Record.<string, (string|number|boolean|Date|null)>

Parâmetros que serão passados para o processo destino quando o usuário selecionar essa ação.

Esta propriedade é um objeto que associa os nomes das propriedades ao seus valores. As propriedades informadas serão definidas no processo destino quando a ação for acionada. Somente podem ser informados valores primitivos ou datas.

Type:
  • Record.<string, (string|number|boolean|Date|null)>
Example
action.params.eventKey = ds.num('iKey');
action.params.description = ds.str('iDescription');

<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)>

Events

show

Evento que será emitido antes da exibição desta ação global. Neste evento a ação global pode ter seus parâmetros complementados e suas propriedades alteradas dinamicamente de acordo com a chave do registro que está acionando essa ação global.

A propriedade target do evento é a instância da ação global.

Type: GlobalActionEvent
See:
  • module:@nginstack/web-framework/lib/classdef/GlobalActionEvent~GlobalActionEvent
Example
globalAction.on('show', function (evt) {
   const key = DBKey.from(evt.key);
   if (key.num('classe') == CHAVE_CLASSE_CLIENTES) {
     evt.target.caption = 'Abrir cadastro do cliente';
   } else {
     evt.target.caption = 'Abrir cadastro do fornecedor';
   }
   evt.target.addParameter({ nome: key.str('nome') });
 });