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

Construtor da classe TSelect. Parâmetros:
​
$name
mixed
required
Nome do widget.
 Exemplo de código: 
$selectCidades = new TSelect('cidades');

​
setSize

Define o tamanho do campo. Parâmetros:
​
$width
mixed
required
Largura do campo.
​
$height
mixed
default:"NULL"
(Opcional) Altura do campo.
 Exemplo de código: 
$selectCidades = new TSelect('cidades');
$selectCidades->setSize(200, 200);

​
getSize

Retorna o tamanho do campo como um array com largura e altura. Exemplo de código: 
$selectCidades = new TSelect('cidades');
$selectCidades->setSize(250);
$tamanho = $selectCidades->getSize(); // (250, 70)

​
addItems

Adiciona itens ao select. Parâmetros:
​
$items
mixed
required
Array associativo de itens.
 Exemplo de código: 
$selectCidades = new TSelect('cidades');
$selectCidades->addItems(['1' => 'São Paulo', '2' => 'Rio de Janeiro']);

​
getItems

Retorna os itens do select. Este método é útil para obter os itens que foram adicionados ao TSelect, permitindo manipulações ou verificações adicionais. Exemplo de código: 
$selectCidades = new TSelect('cidades');
$itens = $selectCidades->getItems();

​
setDefaultOption

Define uma opção padrão que é exibida no select. Parâmetros:
​
$option
mixed
required
Opção padrão a ser exibida.
 Exemplo de código: 
$selectCidades = new TSelect('cidades');
$selectCidades->setDefaultOption('Selecione uma cidade');

​
setValue

Define o valor do campo. Parâmetros:
​
$value
mixed
required
Valor do campo.
 Exemplo de código: 
$selectCidades = new TSelect('cidades');
$selectCidades->setDefaultOption('Selecione uma cidade');
$selectCidades->addItems(['1' => 'São Paulo', '2' => 'Rio de Janeiro']);
$selectCidades->setValue('1');

​
setValueSeparator

Define um separador para os valores no campo, útil quando o campo permite múltiplas seleções. Parâmetros:
​
$sep
mixed
required
Separador para os valores.
 Exemplo de código: 
$selectCidades = new TSelect('cidades');
$selectCidades->setDefaultOption('Selecione uma cidade');
$selectCidades->addItems(['1' => 'Brasília', '2' => 'São Paulo', '3' => 'Rio de Janeiro', '4' => 'Porto Alegre', '5' => 'Salvador', '6' => 'Fortaleza']);
$selectCidades->setValueSeparator(',');

​
enableSearch

Habilita a pesquisa dentro do componente. Exemplo de código: 
$selectCidades = new TSelect('cidades');
$selectCidades->setDefaultOption('Selecione uma cidade');
$selectCidades->addItems(['1' => 'Brasília', '2' => 'São Paulo', '3' => 'Rio de Janeiro', '4' => 'Porto Alegre', '5' => 'Salvador', '6' => 'Fortaleza']);
$selectCidades->enableSearch();

​
disableMultiple

Desativa a seleção múltipla. Exemplo de código: 
$selectRegiao = new TSelect('regiao');
$selectRegiao->setDefaultOption('Selecione uma região');
$selectRegiao->addItems(['1' => 'Região Centro-Oeste', '2' => 'Região Nordeste', '3' => 'Região Norte', '4' => 'Região Sudeste', '5' => 'Região Sul']);
$selectRegiao->disableMultiple();

​
disableTitles

Desativa os títulos das opções. Exemplo de código: 
$selectCidades = new TSelect('cidades');
$selectCidades->setDefaultOption('Selecione uma cidade');
$selectCidades->addItems(['1' => 'Porto Alegre', '2' => 'Florianópolis', '3' => 'Curitiba']);
$selectCidades->disableTitles();

​
setChangeAction

Define a ação a ser executada quando o usuário altera a seleção. Parâmetros:
​
$action
TAction
required
Objeto TAction.
 Exemplo de código: 
$selectCidades = new TSelect('cidades');
$selectCidades->setDefaultOption('Selecione uma cidade');
$selectCidades->addItems(['1' => 'Belém', '2' => 'Boa Vista', '3' => 'Macapá', '4' => 'Manaus', '5' => 'Palmas', '6' => 'Porto Velho', '7' => 'Rio Branco']);
$selectCidades->setChangeAction(new TAction(['NomeClasseDeControle', 'onStatusChange']));
Código de exemplo da função a ser chamada, lembrando que essa função precisa ser estática (static function). 
public static function onStatusChange($param = null)
{
    new TMessage('info', 'A seleção foi alterada com sucesso!');
}

​
setChangeFunction

Define uma função JavaScript para ser executada quando o usuário altera a seleção. Parâmetros:
​
$function
mixed
required
Função JavaScript.
 Exemplo de código: 
$selectCidades = new TSelect('cidades');
$selectCidades->setDefaultOption('Selecione uma cidade');
$selectCidades->addItems(['1' => 'Brasília', '2' => 'Goiânia', '3' => 'Cuiabá', '4' => 'Campo Grande']);
$selectCidades->setChangeFunction('alert("A seleção foi alterada com sucesso!")');

​
getPostData

Obtém os dados enviados pelo formulário. Exemplo de código: 
$selectCidades = new TSelect('cidades');
$dadosPostados = $selectCidades->getPostData();

​
reload

(Método estático) Recarrega os itens do select de forma dinâmica. Parâmetros:
​
$formname
mixed
required
Nome do formulário.
​
$name
mixed
required
Nome do campo.
​
$items
mixed
required
Array de itens.
​
$startEmpty
bool
default:"FALSE"
(Opcional) Inicia vazio.
 Exemplo de código: 
$opcoesUsuario = new TSelect('opcoesUsuario');
$opcoesUsuario->setDefaultOption('Selecione uma opção');
$opcoesUsuario->addItems(['1' => 'Opção 1', '2' => 'Opção 2']);

$btnRecarregar = new TButton('btnReload');
$btnRecarregar->addStyleClass('btn-default');
$btnRecarregar->setImage('far:circle #000000');
$btnRecarregar->setAction(new TAction([$this, 'recarregarCampo']]), 'Recarregar Opções');
Código de exemplo das funções a serem chamadas, lembrando que essas funções precisam ser estáticas (static function). 
public static function recarregarCampo($param = null)
{
    TSelect::reload('nomeForm', 'opcoesUsuario', ['1' => 'Opção 1', '2' => 'Opção 2', '3' => 'Opção 3']);
}

​
enableField e disableField

(Método estático) Habilita ou desabilita um campo de seleção no formulário. Parâmetros:
​
$form_name
mixed
required
Nome do formulário.
​
$field
mixed
required
Nome do campo.
 Exemplo de código: 
$opcoesUsuario = new TSelect('opcoesUsuario');
$opcoesUsuario->setDefaultOption('Selecione uma opção');
$opcoesUsuario->addItems(['1' => 'Opção 1', '2' => 'Opção 2']);

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

$btnDesabilitar = new TButton('btnDisableField');
$btnDesabilitar->addStyleClass('btn-default');
$btnDesabilitar->setImage('far:circle #000000');
$btnDesabilitar->setAction(new TAction([$this, 'desabilitarCampo']), 'Desabilitar Seleção');
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)
{
    TSelect::enableField('nomeForm', 'opcoesUsuario');
}

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

​
clearField

(Método estático) Limpa o valor de 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: 
$opcoesUsuario = new TSelect('opcoesUsuario');
$opcoesUsuario->setDefaultOption('Selecione uma opção');
$opcoesUsuario->addItems(['1' => 'Opção 1', '2' => 'Opção 2']);

$btnLimpar = new TButton('btnClearField');
$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)
{
    TSelect::clearField('nomeForm', 'opcoesUsuario');
}