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.

Derivado da classe TSelect, métodos herdados não sobrescritos podem também ser utililzados por objetos TMultiSearch. Acesse a documentação do componente/classe-pai para conhecê-los.

​
__construct

Construtor da classe TMultiSearch. Parâmetros:
​
$name
mixed
required
Nome do widget.
 Exemplo de código: 
$selecaoEstado = new TMultiSearch('selecaoEstado');
$selecaoEstado->setSize(220, 70);
$selecaoEstado->placeholder = 'Estado';
$selecaoEstado->addItems(['1'=>'Acre','2'=>'Alagoas','3'=>'Amapá','4'=>'Amazonas','5'=>'Bahia','6'=>'Ceará','7'=>'Distrito Federal','8'=>'Espírito Santo','9'=>'Goiás','10'=>'Maranhão','11'=>'Mato Grosso','12'=>'Mato Grosso do Sul','13'=>'Minas Gerais','14'=>'Pará','15'=>'Paraíba','16'=>'Paraná','17'=>'Pernambuco','18'=>'Piauí','19'=>'Rio de Janeiro','20'=>'Rio Grande do Norte','21'=>'Rio Grande do Sul','22'=>'Rondônia','23'=>'Roraima','24'=>'Santa Catarina','25'=>'São Paulo','26'=>'Sergipe','27'=>'Tocantins']);

​
setSize

Define o tamanho do widget. Parâmetros:
​
$width
mixed
required
Largura do widget.
​
$height
mixed
default:"NULL"
(Opcional) Altura do widget.
 Exemplo de código: 
$selecao = new TMultiSearch('selecao');
$selecao->setSize(250, 150);

​
getSize

Retorna o tamanho atual do widget. Exemplo de código: 
$selecaoEstado = new TMultiSearch('selecaoEstado');
$selecaoEstado->setSize(220, 125);
$tamanho = $selecaoEstado->getSize(); // (220, 125)

​
setMinLength

Define o comprimento mínimo para a busca. Parâmetros:
​
$length
mixed
required
Comprimento mínimo.
 Exemplo de código: 
$selecaoEstado = new TMultiSearch('selecaoEstado');
$selecaoEstado->setSize(220, 70);
$selecaoEstado->addItems(['1'=>'Acre','2'=>'Alagoas','3'=>'Amapá','4'=>'Amazonas','5'=>'Bahia','6'=>'Ceará','7'=>'Distrito Federal','8'=>'Espírito Santo','9'=>'Goiás','10'=>'Maranhão','11'=>'Mato Grosso','12'=>'Mato Grosso do Sul','13'=>'Minas Gerais','14'=>'Pará','15'=>'Paraíba','16'=>'Paraná','17'=>'Pernambuco','18'=>'Piauí','19'=>'Rio de Janeiro','20'=>'Rio Grande do Norte','21'=>'Rio Grande do Sul','22'=>'Rondônia','23'=>'Roraima','24'=>'Santa Catarina','25'=>'São Paulo','26'=>'Sergipe','27'=>'Tocantins']);

$selecaoEstado->setMinLength(2);

​
setMaxSize

Define o número máximo de itens que podem ser selecionados. Parâmetros:
​
$maxsize
mixed
required
Número máximo de itens.
 Exemplo de código: 
$selecaoEstado = new TMultiSearch('selecaoEstado');
$selecaoEstado->setSize(220, 70);
$selecaoEstado->addItems(['1'=>'Acre','2'=>'Alagoas','3'=>'Amapá','4'=>'Amazonas','5'=>'Bahia','6'=>'Ceará','7'=>'Distrito Federal','8'=>'Espírito Santo','9'=>'Goiás','10'=>'Maranhão','11'=>'Mato Grosso','12'=>'Mato Grosso do Sul','13'=>'Minas Gerais','14'=>'Pará','15'=>'Paraíba','16'=>'Paraná','17'=>'Pernambuco','18'=>'Piauí','19'=>'Rio de Janeiro','20'=>'Rio Grande do Norte','21'=>'Rio Grande do Sul','22'=>'Rondônia','23'=>'Roraima','24'=>'Santa Catarina','25'=>'São Paulo','26'=>'Sergipe','27'=>'Tocantins']);

$selecaoEstado->setMaxSize(3);

​
setValue

Define o valor do campo. Parâmetros:
​
$value
mixed
required
Valor do campo.
 Exemplo de código: 
$selecaoEstado = new TMultiSearch('selecaoEstado');
$selecaoEstado->setSize(220, 70);
$selecaoEstado->addItems(['1'=>'Acre','2'=>'Alagoas','3'=>'Amapá','4'=>'Amazonas','5'=>'Bahia','6'=>'Ceará','7'=>'Distrito Federal','8'=>'Espírito Santo','9'=>'Goiás','10'=>'Maranhão','11'=>'Mato Grosso','12'=>'Mato Grosso do Sul','13'=>'Minas Gerais','14'=>'Pará','15'=>'Paraíba','16'=>'Paraná','17'=>'Pernambuco','18'=>'Piauí','19'=>'Rio de Janeiro','20'=>'Rio Grande do Norte','21'=>'Rio Grande do Sul','22'=>'Rondônia','23'=>'Roraima','24'=>'Santa Catarina','25'=>'São Paulo','26'=>'Sergipe','27'=>'Tocantins']);

$selecaoEstado->setValue('3');

​
setValueSeparator

Define o separador dos valores no campo. Parâmetros:
​
$sep
mixed
required
Separador.
 Exemplo de código: 
$selecaoEstado = new TMultiSearch('selecaoEstado');
$selecaoEstado->setSize(220, 70);
$selecaoEstado->addItems(['1'=>'Acre','2'=>'Alagoas','3'=>'Amapá','4'=>'Amazonas','5'=>'Bahia','6'=>'Ceará','7'=>'Distrito Federal','8'=>'Espírito Santo','9'=>'Goiás','10'=>'Maranhão','11'=>'Mato Grosso','12'=>'Mato Grosso do Sul','13'=>'Minas Gerais','14'=>'Pará','15'=>'Paraíba','16'=>'Paraná','17'=>'Pernambuco','18'=>'Piauí','19'=>'Rio de Janeiro','20'=>'Rio Grande do Norte','21'=>'Rio Grande do Sul','22'=>'Rondônia','23'=>'Roraima','24'=>'Santa Catarina','25'=>'São Paulo','26'=>'Sergipe','27'=>'Tocantins']);

$selecaoEstado->setValueSeparator(';');

​
disableMultiple

Desativa a seleção múltipla do componente. Exemplo de código: 
$selecaoEstado = new TMultiSearch('selecaoEstado');
$selecaoEstado->setSize(220, 70);
$selecaoEstado->addItems(['1'=>'Acre','2'=>'Alagoas','3'=>'Amapá','4'=>'Amazonas','5'=>'Bahia','6'=>'Ceará','7'=>'Distrito Federal','8'=>'Espírito Santo','9'=>'Goiás','10'=>'Maranhão','11'=>'Mato Grosso','12'=>'Mato Grosso do Sul','13'=>'Minas Gerais','14'=>'Pará','15'=>'Paraíba','16'=>'Paraná','17'=>'Pernambuco','18'=>'Piauí','19'=>'Rio de Janeiro','20'=>'Rio Grande do Norte','21'=>'Rio Grande do Sul','22'=>'Rondônia','23'=>'Roraima','24'=>'Santa Catarina','25'=>'São Paulo','26'=>'Sergipe','27'=>'Tocantins']);

$selecaoEstado->disableMultiple();

​
disableClear

Desativa a opção de limpar a seleção. Exemplo de código: 
$selecaoEstado = new TMultiSearch('selecaoEstado');
$selecaoEstado->setSize(220, 70);
$selecaoEstado->addItems(['1'=>'Acre','2'=>'Alagoas','3'=>'Amapá','4'=>'Amazonas','5'=>'Bahia','6'=>'Ceará','7'=>'Distrito Federal','8'=>'Espírito Santo','9'=>'Goiás','10'=>'Maranhão','11'=>'Mato Grosso','12'=>'Mato Grosso do Sul','13'=>'Minas Gerais','14'=>'Pará','15'=>'Paraíba','16'=>'Paraná','17'=>'Pernambuco','18'=>'Piauí','19'=>'Rio de Janeiro','20'=>'Rio Grande do Norte','21'=>'Rio Grande do Sul','22'=>'Rondônia','23'=>'Roraima','24'=>'Santa Catarina','25'=>'São Paulo','26'=>'Sergipe','27'=>'Tocantins']);

$selecaoEstado->disableClear();

​
disableSearch

Desativa a função de busca dentro do componente. Exemplo de código: 
$selecaoEstado = new TMultiSearch('selecaoEstado');
$selecaoEstado->setSize(220, 70);
$selecaoEstado->addItems(['1'=>'Acre','2'=>'Alagoas','3'=>'Amapá','4'=>'Amazonas','5'=>'Bahia','6'=>'Ceará','7'=>'Distrito Federal','8'=>'Espírito Santo','9'=>'Goiás','10'=>'Maranhão','11'=>'Mato Grosso','12'=>'Mato Grosso do Sul','13'=>'Minas Gerais','14'=>'Pará','15'=>'Paraíba','16'=>'Paraná','17'=>'Pernambuco','18'=>'Piauí','19'=>'Rio de Janeiro','20'=>'Rio Grande do Norte','21'=>'Rio Grande do Sul','22'=>'Rondônia','23'=>'Roraima','24'=>'Santa Catarina','25'=>'São Paulo','26'=>'Sergipe','27'=>'Tocantins']);

$selecaoEstado->disableSearch();

​
getPostData

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

​
enableField e disableField

(Método estático) Habilita e desabilita o campo no formulário. Parâmetros:
​
$form_name
mixed
required
Nome do formulário.
​
$field
mixed
required
Nome do campo.
 Exemplo de código: 
$selecao = new TMultiSearch('selecao');
$selecao->setSize(220, 70);
$selecao->addItems(['1'=>'Opção 1','2'=>'Opção 2','3'=>'Opção 3']);

$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)
{
    TMultiSearch::enableField('nomeForm', 'selecao');
}

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

​
clearField

(Método estático) Limpa o campo no formulário. Parâmetros:
​
$form_name
mixed
required
Nome do formulário.
​
$field
mixed
required
Nome do campo.
 Exemplo de código: 
$selecao = new TMultiSearch('selecao');
$selecao->setSize(220, 70);
$selecao->addItems(['1'=>'Opção 1','2'=>'Opção 2','3'=>'Opção 3']);

$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)
{
    TMultiSearch::clearField('nomeForm', 'selecao');
}