Skip to main content

__construct

Construct da classe TCombo. Parâmetros:
$name
mixed
required
Nome do widget.
Exemplo de código:
$selecaoEstado = new TCombo('estado');

setBooleanMode

Ativa o modo booleano. Exemplo de código:
$selecaoSimNao = new TCombo('confirmacao');
$selecaoSimNao->setBooleanMode();

setValue

Define o valor do campo. Parâmetros:
$value
string
required
Uma string contendo o valor do campo.
Exemplo de código:
$selecaoEstado = new TCombo('estado');
$selecaoEstado->addItems(['1' => 'Mato Grosso', '2' => 'Mato Grosso do Sul', '3' => 'Goiás']);
$selecaoEstado->setValue('2');

getValue

Obtém o valor do campo. Exemplo de código:
$selecaoEstado = new TCombo('estado');
$selecaoEstado->addItems(['1' => 'Mato Grosso', '2' => 'Mato Grosso do Sul', '3' => 'Goiás']);
$selecaoEstado->setValue('2');
$valor = $selecaoEstado->getValue(); // Mato Grosso do Sul

addItems

Adiciona itens à combo-box. Parâmetros:
$items
mixed
required
Array associativo de itens.
Exemplo de código:
$selecaoEstado = new TCombo('estado');
$selecaoEstado->addItems(['1' => 'Paraná', '2' => 'Santa Catarina', '3' => 'Rio Grande do Sul']);

getItems

Retorna os itens do combo. Exemplo de código:
$selecao = new TCombo('estado');
$selecaoEstado->addItems(['1' => 'Paraná', '2' => 'Santa Catarina', '3' => 'Rio Grande do Sul']);
$itens = $selecaoEstado->getItems();

setDefaultOption

Define a opção padrão do combo. Parâmetros:
$option
mixed
required
Valor da opção padrão.
Exemplo de código:
$selecaoEstado = new TCombo('estado');
$selecaoEstado->setDefaultOption('Selecione um Estado');

enableSearch

Habilita a busca dentro do combo. Exemplo de código:
$selecaoEstado = new TCombo('estado');
$selecaoEstado->addItems(['1' => 'São Paulo', '2' => 'Rio de Janeiro', '3' => 'Minas Gerais', '4' => 'Espírito Santo']);
$selecaoEstado->enableSearch();

clear

Limpa os itens do combo. Exemplo de código:
$selecaoNivelIngles = new TCombo('nivelIngles');
$selecaoNivelIngles->addItems(['1' => 'Básico', '2' => 'Intermediário', '3' => 'Avançado']);
$selecaoNivelIngles->clear();
$selecaoNivelIngles->addItems(['1' => 'Básico', '2' => 'Intermediário', '3' => 'Avançado', '4' => 'Fluente/Nativo']);

setChangeAction

Define a ação a ser executada quando o usuário altera a seleção do combo. Parâmetros:
$action
TAction
required
Objeto TAction.
Exemplo de código:
$selecaoEstado = new TCombo('estado');
$selecaoEstado->addItems(['1' => 'Bahia', '2' => 'Sergipe', '3' => 'Alagoas', '4' => 'Pernambuco', '5' => 'Piauí', '6' => 'Paraíba', '7' => 'Rio Grande do Norte', '8' => 'Ceará', '9' => 'Maranhão']);
$selecaoEstado->setChangeAction(new TAction(['NomeClasseDeControle', 'onOptionChange']));
Código de exemplo da função a ser chamada, lembrando que essa função precisa ser estática (static function).
public static function onOptionChange($param = null)
{
    new TMessage('info', 'A opção foi alterada com sucesso!');
}

setChangeFunction

Define a função JavaScript a ser executada quando o usuário altera a seleção do combo. Parâmetros:
$function
mixed
required
Função JavaScript.
Exemplo de código:
$selecaoEstado = new TCombo('estado');
$selecaoEstado->addItems(['1' => 'Tocantins', '2' => 'Rondônia', '3' => 'Acre', '4' => 'Amazonas', '5' => 'Pará', '6' => 'Roraima', '7' => 'Amapá']);
$selecaoEstado->setChangeFunction('alert("O estado foi alterado com sucesso!");');

getPostData

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

reload

(Método estático) Recarrega os itens do combo. Parâmetros:
$formname
mixed
required
Nome do formulário.
$name
mixed
required
Nome do campo.
$items
mixed
required
Array com os itens.
$startEmpty
bool
default:"FALSE"
(Opcional) Se o combo começará vazio.
$fire_events
bool
default:"TRUE"
(Opcional) Se a ação de mudança será disparada.
Exemplo de código:
$combo = new TCombo('combo');
$combo->addItems(['1' => 'Paraná', '2' => 'Santa Catarina']);

$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)
{
    TCombo::reload('nomeForm', 'combo', ['1' => 'Paraná', '2' => 'Santa Catarina', '3' => 'Rio Grande do Sul'], true);
}

enableField e disableField

(Método estático) Habilita 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 TCombo('selecao');

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

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

public static function desabilitarCampo($param = null)
{
    TCombo::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.
$fire_events
bool
default:"TRUE"
(Opcional) Se a ação de mudança será disparada.
Exemplo de código:
$combo = new TCombo('combo');
$combo->addItems(['inicio' => 'Início', 'meio' => 'Meio', 'fim' => 'Fim']);

$btnLimpar = new TButton('btnClearField');
$btnLimpar->addStyleClass('btn-default');
$btnLimpar->setImage('far:circle #000000');
$btnLimpar->setAction(new TAction([$this, 'limparCampo']), 'Limpar Opções');
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)
{
    TCombo::clearField('nomeForm', 'combo');
}