TCheckGroup

O TCheckGroup é um componente que agrupa vários botões de seleção (CheckButtons) (derivado da classe TField), permitindo que o usuário selecione múltiplas opções de uma lista.

__construct

Construtor da classe TCheckGroup.

Parâmetros:

Exemplo de código:

$opcoesUsuario = new TCheckGroup('opcoesUsuario');

__clone

Clona o objeto, criando cópias dos botões e labels internos.

Exemplo de código:

$opcoesUsuario = new TCheckGroup('opcoesUsuario');
$opcoesUsuario->addItems(['1' => 'Opção 1', '2' => 'Opção 2']);
$opcoesUsuarioClone = clone $opcoesUsuario;

addItems

Adiciona itens ao grupo de seleção.

Parâmetros:

Exemplo de código:

$opcoesUsuario = new TCheckGroup('opcoesUsuario');
$opcoesUsuario->addItems(['1' => 'Opção 1', '2' => 'Opção 2']);

setValue

Define o valor do campo.

Parâmetros:

Exemplo de código:

$opcoesUsuario = new TCheckGroup('opcoesUsuario');
$opcoesUsuario->setValue('1;2');

getItems

Retorna os itens do grupo de seleção.

Exemplo de código:

$opcoesUsuario = new TCheckGroup('opcoesUsuario');
$itens = $opcoesUsuario->getItems();

checkAll

Marca todas as opções no grupo de seleção.

Exemplo de código:

$opcoesUsuario = new TCheckGroup('opcoesUsuario');
$opcoesUsuario->addItems(['1' => 'Opção 1', '2' => 'Opção 2']);
$opcoesUsuario->checkAll();

setLayout

Define a direção das opções (vertical ou horizontal).

Parâmetros:

Exemplo de código:

$opcoesUsuario = new TCheckGroup('opcoesUsuario');
$opcoesUsuario->addItems(['1' => 'Opção 1', '2' => 'Opção 2']);
$opcoesUsuario->setLayout('horizontal');

getLayout

Obtém a direção atual das opções.

Exemplo de código:

$opcoesUsuario = new TCheckGroup('opcoesUsuario');
$opcoesUsuario->setLayout('vertical');
$layout = $opcoesUsuario->getLayout(); // vertical

setBreakItems

Define após quantos itens uma quebra deve ser inserida no layout.

Parâmetros:

Exemplo de código:

$opcoesUsuario = new TCheckGroup('opcoesUsuario');
$opcoesUsuario->addItems(['1' => 'Opção 1', '2' => 'Opção 2', '3' => 'Opção 3', '4' => 'Opção 4']);
$opcoesUsuario->setLayout('horizontal');
$opcoesUsuario->setBreakItems(3);

setUseButton

Exibe as opções como botões.

Exemplo de código:

$opcoesUsuario = new TCheckGroup('opcoesUsuario');
$opcoesUsuario->addItems(['1' => 'Opção 1', '2' => 'Opção 2']);
$opcoesUsuario->setUseButton();

setUseSwitch

Exibe as opções como interruptores (switch).

Parâmetros:

Exemplo de código:

$opcoesUsuario = new TCheckGroup('opcoesUsuario');
$opcoesUsuario->addItems(['1' => 'Opção 1', '2' => 'Opção 2']);
$opcoesUsuario->setUseSwitch();

getButtons

Retorna os botões do grupo de seleção.

Exemplo de código:

$opcoesUsuario = new TCheckGroup('opcoesUsuario');
$botões = $opcoesUsuario->getButtons();

getLabels

Retorna os rótulos do grupo de seleção.

Exemplo de código:

$opcoesUsuario = new TCheckGroup('opcoesUsuario');
$rotulos = $opcoesUsuario->getLabels();

setValueSeparator

Define o separador para os valores do campo.

Parâmetros:

Exemplo de código:

$opcoesUsuario = new TCheckGroup('opcoesUsuario');
$opcoesUsuario->setValueSeparator(';');

setChangeAction

Define a ação a ser executada quando o usuário alterar a seleção.

Parâmetros:

Exemplo de código:

$opcoesUsuario = new TCheckGroup('opcoesUsuario');
$opcoesUsuario->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', 'O status do botão foi alterado com sucesso!');
}

setChangeFunction

Define a função JavaScript a ser executada quando o usuário alterar a seleção.

Parâmetros:

Exemplo de código:

$opcoesUsuario = new TCheckGroup('opcoesUsuario');
$opcoesUsuario->setChangeFunction('alert("O estado do botão foi alterado com sucesso!");');

getPostData

Obtém os dados enviados pelo formulário.

Exemplo de código:

$opcoesUsuario = new TCheckGroup('opcoesUsuario');
$dadosPostados = $opcoesUsuario->getPostData();

reload

(Método estático) Recarrega os itens do grupo de seleção após a exibição inicial.

Parâmetros:

Exemplo de código:

$opcoesUsuario = new TCheckGroup('opcoesUsuario');
$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)
{
    TCheckGroup::reload('nomeForm', 'opcoesUsuario', ['1' => 'Opção 1', '2' => 'Opção 2', '3' => 'Opção 3'], true);
}

enableField e disableField

(Método estático) Habilita e desabilita um campo no formulário.

Parâmetros:

Exemplo de código:

$opcoesUsuario = new TCheckGroup('opcoesUsuario');
$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 Botões de Seleção');

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

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

clearField

(Método estático) Limpa um campo no formulário.

Parâmetros:

Exemplo de código:

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