Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs-fw.madbuilder.com.br/llms.txt

Use this file to discover all available pages before exploring further.

​
__construct

Construct do TArrowStep. Parâmetros:
​
$name
mixed
required
Nome do componente.
 Exemplo de código: 
$etapas = new TArrowStep('etapas');

​
setEditable

Define se o componente é editável. Parâmetros:
​
$editable
mixed
required
Booleano para a edição.
 Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->addItems(['inicio' => 'Início', 'meio' => 'Meio', 'fim' => 'Fim']);
$etapas->setEditable(false);

​
getEditable

Retorna se o componente é editável. Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->setEditable(false);
$isEditavel = $etapas->getEditable(); // false

​
setFormName

Define o nome do formulário ao qual o componente pertence. Parâmetros:
​
$name
mixed
required
Nome do formulário.
 Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->addItems(['inicio' => 'Início', 'meio' => 'Meio', 'fim' => 'Fim']);
$etapas->setFormName('formularioProcesso');

​
setName

Define o nome do componente. Parâmetros:
​
$name
mixed
required
Nome do componente.
 Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->addItems(['inicio' => 'Início', 'meio' => 'Meio', 'fim' => 'Fim']);
$etapas->setName('progresso');

​
getName

Retorna o nome do componente. Exemplo de código: 
$etapas = new TArrowStep('etapas');
$nome = $etapas->getName(); // etapas

​
setValue

Define o valor do item atual. Parâmetros:
​
$value
mixed
required
Valor do item.
 Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->addItems(['inicio' => 'Início', 'meio' => 'Meio', 'fim' => 'Fim']);
$etapas->setValue('2');

​
getValue

Obtém o valor do item atual. Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->addItems(['inicio' => 'Início', 'meio' => 'Meio', 'fim' => 'Fim']);
$etapas->setValue('1');
$valorAtual = $etapas->getValue(); // Meio

​
setHideText

Define se o texto dos itens deve ser ocultado. Parâmetros:
​
$hide
bool
default:"true"
(Opcional) Booleano para ocultar texto.
 Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->addItems(['inicio' => 'Início', 'meio' => 'Meio', 'fim' => 'Fim']);
$etapas->setHideText(true);

​
setFontSize

Define o tamanho da fonte dos itens. Parâmetros:
​
$fontSize
mixed
required
Tamanho da fonte.
 Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->addItems(['inicio' => 'Início', 'meio' => 'Meio', 'fim' => 'Fim']);
$etapas->setFontSize(24);

​
setFilledColor

Define a cor de preenchimento dos itens e opcionalmente a cor da fonte. Parâmetros:
​
$color
string
required
Cor de preenchimento.
​
$fontColor
mixed
default:"null"
(Opcional) Cor da fonte.
 Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->addItems(['inicio' => 'Início', 'meio' => 'Meio', 'fim' => 'Fim']);
$etapas->setFilledColor('#00FF00');

​
setFilledFontColor

Define a cor da fonte dos itens preenchidos. Parâmetros:
​
$fontColor
string
required
Cor da fonte.
 Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->addItems(['inicio' => 'Início', 'meio' => 'Meio', 'fim' => 'Fim']);
$etapas->setFilledFontColor('#FF0000');

​
setUnfilledColor

Define a cor de fundo dos itens não preenchidos e opcionalmente a cor da fonte. Parâmetros:
​
$color
string
required
Cor de fundo.
​
$fontColor
mixed
default:"null"
(Opcional) Cor da fonte.
 Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->addItems(['inicio' => 'Início', 'meio' => 'Meio', 'fim' => 'Fim']);
$etapas->setUnfilledColor('#CCCCCC');

​
setUnfilledFontColor

Define a cor da fonte dos itens não preenchidos. Parâmetros:
​
$color
string
required
Cor da fonte.
 Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->addItems(['inicio' => 'Início', 'meio' => 'Meio', 'fim' => 'Fim']);
$etapas->setUnfilledFontColor('#0037FF');

​
setSize

Define a largura e altura do componente. Parâmetros:
​
$width
mixed
required
Largura do componente.
​
$height
mixed
default:"null"
(Opcional) Altura do componente.
 Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->addItems(['inicio' => 'Início', 'meio' => 'Meio', 'fim' => 'Fim']);
$etapas->setSize('50%', 50);

​
getSize

Obtém o tamanho do componente (largura e altura). Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->setSize(350);
$tamanho = $etapas->getSize(); // (350, 50)

​
setWidth

Define a largura do componente. Parâmetros:
​
$width
mixed
required
Largura do componente.
 Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->addItems(['inicio' => 'Início', 'meio' => 'Meio', 'fim' => 'Fim']);
$etapas->setWidth('80%');

​
getWidth

Obtém a largura do componente. Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->setWidth(500);
$largura = $etapas->getWidth(); // 500

​
setHeight

Define a altura do componente. Parâmetros:
​
$height
mixed
required
Altura do componente.
 Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->addItems(['inicio' => 'Início', 'meio' => 'Meio', 'fim' => 'Fim']);
$etapas->setHeight(100);

​
getHeight

Obtém a altura do componente. Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->setHeight(75);
$altura = $etapas->getHeight(); // 75

​
setColorItems

Define as cores dos itens. Parâmetros:
​
$colorItems
mixed
required
Array associativo com as cores dos itens.
 Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->addItems(['inicio' => 'Início', 'meio' => 'Meio', 'fim' => 'Fim']);
$etapas->setColorItems(['inicio' => '#FF0000', 'meio' => '#00FF00', 'fim' => '#0000FF']);

​
setItems

Define os itens do componente. Parâmetros:
​
$items
mixed
required
Array associativo com os itens.
 Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->addItems(['inicio' => 'Início', 'meio' => 'Meio', 'fim' => 'Fim']);
$etapas->setItems(['inicio' => 'Começo', 'meio' => 'Meio', 'fim' => 'Término']);

​
addItem

Adiciona um item ao componente. Parâmetros:
​
$title
mixed
required
Título do item.
​
$id
mixed
default:"null"
(Opcional) ID do item.
​
$color
mixed
default:"null"
(Opcional) Cor do item.
 Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->addItem('Início');

​
getItem

Obtém um item específico do componente. Parâmetros:
​
$key
mixed
required
Chave do item.
 Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->addItems(['inicio' => 'Início', 'meio' => 'Meio', 'fim' => 'Fim']);
$item = $etapas->getItem('inicio'); // Início

​
addItems

Adiciona itens ao componente. Parâmetros:
​
$items
mixed
required
Array associativo com os itens a serem adicionados.
 Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->addItems(['inicio' => 'Início', 'meio' => 'Meio']);

​
getItems

Obtém os itens do componente. Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->addItems(['inicio' => 'Início', 'fim' => 'Fim']);
$itens = $etapas->getItems(); // ['inicio' => 'Início', 'fim' => 'Fim']

​
setAction

Define a ação a ser executada quando um item é clicado. Parâmetros:
​
$action
TAction
required
Objeto TAction.
 Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->addItems(['planejamento' => 'Planejamento', 'desenvolvimento' => 'Desenvolvimento', 'producao' => 'Produção']);
$etapas->setAction(new TAction(['NomeClasseDeControle', 'onStepChange']));
Código de exemplo da função a ser chamada, lembrando que essa função precisa ser estática (static function). 
public static function onStepChange($param = null)
{
    new TMessage('info', 'A etapa foi alterada com sucesso!');
}

​
getAction

Obtém a ação associada ao componente. Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->setAction(new TAction(['NomeClasseDeControle, 'onChangeStep']));
$acao = $etapas->getAction();

​
setCurrentKey

Define a chave do item atual. Parâmetros:
​
$key
mixed
required
Chave do item atual.
 Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->addItems(['inicio' => 'Início', 'meio' => 'Meio', 'fim' => 'Fim']);
$etapas->setCurrentKey('meio');

​
getCurrent

Obtém a chave do item atual. Exemplo de código: 
$etapas = new TArrowStep('etapas');
$itemAtual = $etapas->getCurrent();

​
setCurrent

Define o título do item atual. Parâmetros:
​
$title
mixed
required
Título do item atual.
 Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->addItems(['inicio' => 'Início', 'meio' => 'Meio', 'fim' => 'Fim']);
$etapas->setCurrent('Fim');

​
getPostData

Retorna os dados postados pelo formulário. Exemplo de código: 
$etapas = new TArrowStep('etapas');
$dadosPostados = $etapas->getPostData();

​
defineCurrent

(Método estático) Define o item atual por meio de seu valor. Parâmetros:
​
$name
mixed
required
Nome do campo.
​
$value
mixed
required
Chave do item desejado.
 Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->addItems(['inicio' => 'Início', 'meio' => 'Meio', 'fim' => 'Fim']);

$btnDefinir = new TButton('btnDefineCurrent');
$btnDefinir->addStyleClass('btn-default');
$btnDefinir->setImage('far:circle #000000');
$btnDefinir->setAction(new TAction([$this, 'definirAtual']), 'Definir Item Atual -> "Meio"');
Código de exemplo da função a ser chamada, lembrando que essa função precisa ser estática (static function). 
public static function definirAtual($param = null)
{
    TArrowStep::defineCurrent('etapas', 'meio');
}

​
enableField e disableField

(Método estático) Habilita ou desabilita um campo no formulário. Parâmetros:
​
$form_name
mixed
required
Nome do formulário.
​
$field
mixed
required
Nome do campo.
 Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->addItems(['inicio' => 'Início', 'meio' => 'Meio', 'fim' => 'Fim']);

$btnHabilitar = new TButton('btnEnableField');
$btnHabilitar->addStyleClass('btn-default');
$btnHabilitar->setImage('far:circle #000000');
$btnHabilitar->setAction(new TAction([$this, 'habilitarCampo']), 'Habilitar Componente TArrowStep');

$btnDesabilitar = new TButton('btnDisableField');
$btnDesabilitar->addStyleClass('btn-default');
$btnDesabilitar->setImage('far:circle #000000');
$btnDesabilitar->setAction(new TAction([$this, 'desabilitarCampo']), 'Desabilitar Componente TArrowStep');
Código de exemplo das funções a serem chamadas, lembrando que essas funções precisam ser estáticas (static function). 
public static function habilitarCampo($param = null)
{
    TArrowStep::enableField('nomeForm', 'etapas');
}

public static function desabilitarCampo($param = null)
{
    TArrowStep::disableField('nomeForm', 'etapas');
}

​
clearField

(Método estático) Limpa os itens de um campo. Parâmetros:
​
$formName
mixed
required
Nome do formulário.
​
$name
mixed
required
Nome do campo.
 Exemplo de código: 
$etapas = new TArrowStep('etapas');
$etapas->addItems(['inicio' => 'Início', 'meio' => 'Meio', 'fim' => 'Fim']);

$btnLimpar = new TButton('btnEnableField');
$btnLimpar->addStyleClass('btn-default');
$btnLimpar->setImage('far:circle #000000');
$btnLimpar->setAction(new TAction([$this, 'limparCampo']), 'Limpar Seleção');
Código de exemplo da função a ser chamada, lembrando que essa função precisa ser estática (static function). 
public static function limparCampo($param = null)
{
    TArrowStep::clearField('nomeForm', 'etapas');
}