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 THtmlEditor. Parâmetros:
​
$name
mixed
required
Nome do campo que será usado no formulário.
 Exemplo de código: 
$editorTexto = new THtmlEditor('textoArtigo');

​
setSize

Define o tamanho do editor. Parâmetros:
​
$width
mixed
required
Largura do editor em pixels.
​
$height
mixed
default:"NULL"
(Opcional) Altura do editor em pixels.
 Exemplo de código: 
$editorTexto = new THtmlEditor('textoArtigo');
$editorTexto->setSize(500, 100);

​
getSize

Retorna as dimensões do editor. Retorno:
​
Array
mixed
required
Array contendo a largura e a altura do editor em pixels.
 Exemplo de código: 
$editorTexto = new THtmlEditor('textoArtigo');
$editorTexto->setSize(500, 300);
$tamanho = $editorTexto->getSize(); // (500, 300)

​
setMaxLength

Define o comprimento máximo do texto. Parâmetros:
​
$length
mixed
required
Comprimento máximo do texto em caracteres.
 Exemplo de código: 
$editorTexto = new THtmlEditor('resumo');
$editorTexto->setMaxLength(120);

​
setOption

Configura opções adicionais do editor. Parâmetros:
​
$option
mixed
required
Nome da opção.
​
$value
mixed
required
Valor da opção.
 Exemplo de código: 
$editorTexto = new THtmlEditor('textoArtigo');
$editorTexto->setOption('placeholder', 'Digite seu texto aqui...');

​
addCustomButton

Adiciona um botão customizado à barra de ferramentas. Parâmetros:
​
$name
mixed
required
Nome do botão.
​
$function
mixed
required
Função JavaScript a ser executada.
​
$title
mixed
required
Título do botão.
​
$icon
TImage
required
Ícone do botão.
​
$showLabel
bool
default:"false"
(Opcional) Mostrar rótulo do botão.
 Exemplo de código: 
$icone = new TImage('far:circle #000000');
$funcao = "function() {
    var editor = document.getElementById('editorCustomizado'); 
    if (editor) {
        editor.innerHTML += 'Texto inserido pelo botão customizado';
    }
}}";

$editorTexto = new THtmlEditor('editorCustomizado');
$editorTexto->addCustomButton('inserirForm', $funcao, 'Inserir Form', $icone, true);

​
disableToolbar

Desabilita a barra de ferramentas do editor. Exemplo de código: 
$editorSimples = new THtmlEditor('editorSimples');
$editorSimples->disableToolbar();
Obs.: apesar de não ser visível, o campo THtmlEditor se faz presente.

​
setCompletion

Define as opções de autoconclusão para o editor. Parâmetros:
​
$options
array
required
Array de opções para autoconclusão.
 Exemplo de código: 
$editorTexto = new THtmlEditor('editorAutoComplete');
$editorTexto->setCompletion(['teste', 'texto', 'autocomplete']);

​
enableField e disableField

(Método estático) Habilita ou desabilita um campo HtmlEditor no formulário. Parâmetros:
​
$form_name
mixed
required
Nome do formulário.
​
$field
mixed
required
Nome do campo.
 Exemplo de código: 
$editor = new THtmlEditor('editor');

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

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

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

​
clearField

(Método estático) Limpa o conteúdo do editor HTML. Parâmetros:
​
$form_name
mixed
required
Nome do formulário.
​
$field
mixed
required
Nome do campo.
 Exemplo de código: 
$editor = new THtmlEditor('editor');

$btnLimpar = new TButton('btnLimpar');
$btnLimpar->addStyleClass('btn-default');
$btnLimpar->setImage('far:circle #000000');
$btnLimpar->setAction(new TAction([$this, 'limparCampo']), 'Limpar Campo');
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)
{
    THtmlEditor::clearField('nomeForm', 'editor');
}

​
reloadCompletion

(Método estático) Recarrega as opções de conclusão de um campo de entrada de forma dinâmica. Parâmetros:
​
$field
mixed
required
Nome ou ID do campo.
​
$list
mixed
required
Lista de opções para a conclusão.
​
$options
mixed
default:"null"
(Opcional) Opções adicionais para a conclusão.
 Exemplo de código: 
$editor = new THtmlEditor('editor');
$editor->setCompletion(['teste', 'texto']);

$btnReloadCompletion = new TButton('btnReloadCompletion');
$btnReloadCompletion->addStyleClass('btn-default');
$btnReloadCompletion->setImage('far:circle #000000');
$btnReloadCompletion->setAction(new TAction([$this, 'alterarOpcoes']), 'Alterar Opções de Preenchimento Automático');
Código de exemplo da função a ser chamada, lembrando que essa função precisa ser estática (static function). 
public static function alterarOpcoes($param = null)
{
    THtmlEditor::reloadCompletion('editor', ['teste2', 'texto2']);
}

​
insertText

(Método estático) Insere texto no editor HTML. Parâmetros:
​
$form_name
mixed
required
Nome do formulário.
​
$field
mixed
required
Nome do campo.
​
$content
mixed
required
Conteúdo de texto a ser inserido.
 Exemplo de código: 
$editor = new THtmlEditor('editor');

$btnInsertText = new TButton('btnInsertText');
$btnInsertText->addStyleClass('btn-default');
$btnInsertText->setImage('far:circle #000000');
$btnInsertText->setAction(new TAction([$this, 'inserirTexto']), 'Inserir Texto no Campo');
Código de exemplo da função a ser chamada, lembrando que essa função precisa ser estática (static function). 
public static function inserirTexto($param = null)
{
    THtmlEditor::insertText('nomeForm', 'editor', 'Texto inserido.');
}