new Button(name, target [, processKey] [, newTab])
Controle visual com formato de botão, exibido na barra de botões de um processo ou de uma grade.
O caractere "&" antes de uma das letras do nome ou do rótulo do botão indica que a letra será preferencialmente escolhida como atalho. Caso a letra já esteja definida como um outro atalho de ação, o atalho será vinculado a alguma outra letra do rótulo, ou a um número, caso não existam letras possíveis de serem usadas como atalho.
Um botão pode ser utilizado para:
- direcionar o usuário para uma outra interação ou atividade, inclusive de outro processo;
- executar um evento JavaScript na interação corrente; Este construtor não deve ser executado diretamente. Para criar um botão, utilize os métodos Process.button ou Grid.button.
Parameters:
Name | Type | Argument | Description |
---|---|---|---|
name |
string | Nome do botão. O valor informado também será utilizado como o texto do botão, caso a propriedade label não seja informada. |
|
target |
string | function | Poderá ser informado:
|
|
processKey |
number |
<optional> |
Indica a chave do processo que contém a atividade ou interação informada no parâmetro "target". Será considerado o processo corrente quando não for informado. |
newTab |
boolean |
<optional> |
Indica se deve ser criada uma nova aba para exibir a interação ou atividade informada em "target". Considerado "false" quando não for informado. |
- See:
-
- Grid#button
- Process#button
Examples
this.button("Soma", "sumInteraction")
this.gridTeste.button("Exibir quantidade registros", function (bt){ var grid = bt.parent var process = grid.process process.alert(grid.ds.recordCount) });
Extends
- Anchor
Members
-
defaultAction :boolean
-
Determina se este botão deve ser considerado o botão padrão do processo.
O botão padrão é disparado automaticamente quando o usuário informa o último campo de uma grade de variáveis. Ele é destacado em negrito.Type:
- boolean
- Deprecated:
-
- Utilize a propriedade defaultButton
- See:
-
defaultButton :boolean
-
Determina se este botão deve ser considerado o botão padrão do processo.
O botão padrão é disparado automaticamente quando o usuário informa o último campo de uma grade de variáveis. Ele é destacado em negrito.Type:
- boolean
-
disabledIcon :number
-
Chave de um arquivo da Virtual File System que deve ser exibido como ícone do botão quando este estiver desabilitado. Se não for informado, será utilizada a imagem padrão definida no tema do usuário.
Type:
- number
-
icon :number
-
Chave de um arquivo da Virtual File System que deve ser exibido como ícone do botão quando este estiver habilitado. Se não for informado, será utilizada a imagem padrão definida no tema do usuário.
Type:
- number
-
label :string
-
Texto que será exibido no botão. Caso não seja informado, será utilizado o valor da propriedade "name".
Type:
- string
-
maxSelectedRecords :number
-
Indica a quantidade máxima de registros selecionados para que este botão possa ser utilizado em uma grade.
Propriedade válida apenas para botões de grade.
Valor padrão: Infinity.Type:
- number
- See:
-
- Button#maxSelectedRecords
-
minSelectedRecords :number
-
Indica a quantidade mínima de registros selecionados para que este botão possa ser utilizado em uma grade.
Propriedade válida apenas para botões de grade.
Valor padrão: 1.Type:
- number
- See:
-
- Button#minSelectedRecords
-
name :string
-
Nome do botão.
Type:
- string
-
order :number
-
Indica a ordem do botão na barra de botões. Os botões são exibidos em ordem crescente da propriedade "order". Quando não for informado, os botões serão exibidos na ordem em que foram declarados.
Type:
- number
-
timeout :number
-
Indica o tempo em milissegundos para o disparo automático do botão.
Type:
- number
- Deprecated:
-
- Utilize a propriedade "timer".
- See:
-
- Button#timer
-
timer :ButtonTimer
-
Temporizador para disparos automáticos do botão.
Type:
- ButtonTimer
- See:
-
- ButtonTimer
-
visible :boolean
-
Indica se o botão deve ser exibido na barra de botões do processo ou da grade.
É recomendada a utilização das propriedades Process.visibleButtons e Grid.visibleButtons para definir quais botões devem ser exibidos.
Type:
- boolean
- See:
-
- Process#visibleButtons
- Grid#visibleButtons
Methods
-
disable()
-
Desabilita o botão.
- Deprecated:
-
- Utilize a propriedade enabled.
- See:
-
- Button#enabled
-
enable()
-
Habilita o botão.
- Deprecated:
-
- Utilize a propriedade enabled.
- See:
-
- Button#enabled
-
hide()
-
Torna o botão invisível.
- Deprecated:
-
- Utilize a propriedade visible.
- See:
-
- Button#visible
-
show()
-
Torna o botão visível.
- Deprecated:
-
- Utilize a propriedade visible.
- See:
-
- Button#visible