Skip to main content

__construct

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

setSize

Define o tamanho da lista. Parâmetros:
$width
mixed
required
Largura da lista.
$height
mixed
default:"NULL"
(Opcional) Altura da lista.
Exemplo de código:
$listaOrdenavel = new TSortList('listaOrdenavel');
$listaOrdenavel->setSize(300, 150);

addItems

Adiciona itens à lista. Parâmetros:
$items
mixed
required
Array de itens.
Exemplo de código:
$listaOrdenavel = new TSortList('listaOrdenavel');
$listaOrdenavel->addItems(['Item 1', 'Item 2', 'Item 3']);

getItems

Retorna os itens iniciais da lista. Exemplo de código:
$listaOrdenavel = new TSortList('listaOrdenavel');
$listaOrdenavel->addItems(['Item 1', 'Item 2', 'Item 3']);
$itens = $listaOrdenavel->getItems();

setValue

Define os valores da lista. Parâmetros:
$value
mixed
required
Array de valores.
Exemplo de código:
$listaOrdenavel = new TSortList('listaOrdenavel');
$listaOrdenavel->addItems(['1' => 'Item 1', '2' => 'Item 2', '3' => 'Item 3']);
$listaOrdenavel->setValue(['3', '2', '1']);

setValueSeparator

Define o separador de valores para a lista. Parâmetros:
$sep
mixed
required
Separador de valores.
Exemplo de código:
$listaOrdenavel = new TSortList('listaOrdenavel');
$listaOrdenavel->addItems(['Item 1', 'Item 2', 'Item 3']);
$listaOrdenavel->setValueSeparator(';');

setOrientation

Define a orientação da lista ordenável. Parâmetros:
$orientation
mixed
required
Orientação da lista (‘horizontal’ ou ‘vertical’).
Exemplo de código:
$listaOrdenavel = new TSortList('listaOrdenavel');
$listaOrdenavel->addItems(['Item 1', 'Item 2', 'Item 3']);
$listaOrdenavel->setOrientation('horizontal');

setLimit

Define um limite para o número de itens na lista. Parâmetros:
$limit
mixed
required
Limite de itens.
Exemplo de código:
$listaOrdenavel = new TSortList('listaOrdenavel');
$listaOrdenavel->addItems(['Item 1', 'Item 2', 'Item 3']);
$listaOrdenavel->setLimit(3);
$listaOrdenavel->addItems(['Item Excedente 1', 'Item Excedente 2']);

setItemIcon

Define o ícone para os itens da lista. Parâmetros:
$icon
TImage
required
Ícone para os itens.
Exemplo de código:
$listaOrdenavel = new TSortList('listaOrdenavel');
$listaOrdenavel->addItems(['Roberto', 'Miranda', 'Júlia', 'Daniel']);
$listaOrdenavel->setItemIcon(new TImage('fas:user-circle'));

connectTo

Conecta esta lista a outra, permitindo interação entre ambas. Parâmetros:
$list
TSortList
required
Outra TSortList.
Exemplo de código:
$listaPessoas = new TSortList('listaPessoas');
$listaPessoas->addItems(['Roberto', 'Miranda', 'Júlia', 'Daniel']);

$listaCargo = new TSortList('listaCargo');
$listaCargo->addItems(['Desenvolvedor Front-End', 'Desenvolvedor Back-End', 'Desenvolvedor Full-Stack']);

$listaPessoas->connectTo($listaCargo);
$listaCargo->connectTo($listaPessoas);

setChangeAction

Define a ação a ser executada quando o usuário altera a lista. Parâmetros:
$action
TAction
required
Objeto TAction que define a ação.
Exemplo de código:
$listaOrdenavel = new TSortList('listaOrdenavel');
$listaOrdenavel->addItems(['Item 1', 'Item 2', 'Item 3']);
$listaOrdenavel->setChangeAction(['NomeClasseDeControle', 'onItemChange']);
Código de exemplo da função a ser chamada, lembrando que essa função precisa ser estática (static function).
public static function onItemChange($param = null)
{
    new TMessage('info', 'O item selecionado foi alterado com sucesso!');
}

setChangeFunction

Define a função JavaScript a ser executada quando o usuário altera a lista. Parâmetros:
$function
mixed
required
Função JavaScript.
Exemplo de código:
$listaOrdenavel = new TSortList('listaOrdenavel');
$listaOrdenavel->addItems(['Item 1', 'Item 2', 'Item 3']);
$listaOrdenavel->setChangeFunction('alert("O item selecionado foi alterado com sucesso!");');

getPostData

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

reload

(Método estático) Recarrega os itens da lista dinamicamente. Parâmetros:
$form_name
mixed
required
Nome do formulário.
$field
mixed
required
Nome do campo.
$items
mixed
required
Itens para carregar.
Exemplo de código:
$listaOrdenavel = new TRadioGroup('listaOrdenavel');
$listaOrdenavel->addItems(['Af azer', 'Em andamneto', 'Conclluído']);

$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)
{
    TSortList::reload('nomeForm', 'listaOrdenavel', ['A fazer', 'Em andamento', 'Concluído']);
}

enableField e disableField

(Método estático) Habilita e desabilita um campo da lista no formulário. Parâmetros:
$form_name
mixed
required
Nome do formulário.
$field
mixed
required
Nome do campo.
Exemplo de código:
$listaOrdenavel = new TSortList('listaOrdenavel');
$listaOrdenavel->addItems(['Item 1', 'Item 2', 'Item 3']);

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

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

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

clearField

(Método estático) Limpa um campo da lista no formulário. Parâmetros:
$form_name
mixed
required
Nome do formulário.
$field
mixed
required
Nome do campo.
Exemplo de código:
$listaOrdenavel = new TSortList('listaOrdenavel');
$listaOrdenavel->addItems(['Item 1', 'Item 2', 'Item 3']);

$btnLimpar = new TButton('btnClearField');
$btnLimpar->addStyleClass('btn-default');
$btnLimpar->setImage('far:circle #000000');
$btnLimpar->setAction(new TAction([$this, 'limparCampo']), 'Remover Itens da Lista');
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)
{
    TSortList::clearField('nomeForm', 'listaOrdenavel');
}