Métodos do RichTextEditor

Name: RichTextEditor
Price: 129 USD
Author: Richscripts Inc.

O RichTextEditor expõe os métodos a seguir.

Método	Descrição
`duplicateCurrentBlock()`	Somente em builds mais recentes do core a partir do código-fonte (nem todo pacote publicado o inclui): duplica o(s) bloco(s) da seleção e coloca o cursor na cópia. IDs exclusivos e identidades de revisão não são clonados. Conteúdo somente leitura ou só para comentários, mesclagens de linhas (row spans) não suportadas e o modo de sugestão recusam a operação. Um retorno true pode indicar uma operação protegida que não fez nada, e não prova de que o conteúdo foi copiado. Verifique typeof editor.duplicateCurrentBlock antes de usá-lo com um runtime mais antigo.
`recordUndo()`	Registra o documento atual e confirma a etapa de desfazer correspondente. Chame-o depois de uma edição personalizada no DOM para que a alteração possa ser desfeita com Undo.
`makePanelResizable(panel, opts)`	A partir do core 2.6.11. Adiciona a um elemento de painel lateral uma borda de redimensionamento arrastável e operável pelo teclado (ArrowLeft / ArrowRight / Home / End). opts: largura mínima e máxima em px (padrão 240 / 720) e label para leitores de tela. Dispara o evento panelresized. Retorna o elemento da alça, ou null se o painel não existir ou já for redimensionável.
`setListStart(n)`	Define o número inicial da lista ordenada na seleção, incluindo 0. Retorna false quando nenhuma lista ordenada está selecionada ou n é inválido.
`continueListNumbering()`	Continua a numeração da lista ordenada selecionada a partir da lista ordenada anterior. Retorna false quando nenhuma lista adequada é encontrada.
`toggleTableCaption()`	Adiciona ou remove a legenda da tabela selecionada e registra uma etapa de desfazer. Retorna false quando nenhuma tabela está selecionada.
`execCommand(cmd,value)`	Executa um comando na seleção atual ou no intervalo informado.
`attachEvent(name,handler)`	Registra um handler de evento. Você pode interagir com ele assim que o editor estiver carregado e em execução.
`detachEvent(name,handler)`	Remove um handler de um evento.
`getHTMLCode()`	Obtém o conteúdo do RichTextEditor como HTML.
`setHTMLCode(html)`	Define o conteúdo do RichTextEditor.
`getReadOnly()`	Retorna um valor que indica se o editor está em estado somente leitura no lado do cliente.
`setReadOnly(bReadOnly)`	Ativa ou desativa o modo somente leitura.
`isCommandEnabled(cmd)`	Indica se o comando especificado está habilitado.
`isCommandActive(cmd)`	Verifica se esse comando pode ser executado no momento.
`focus()`	Tenta colocar o foco na janela de conteúdo do editor.
`setContentCssText(text)`	Define o texto de CSS inline usado pela área editável.
`insertRootParagraph(tagname)`	Insere um novo parágrafo no final do editor.
`insertByTagName(tagName)`	Insere um elemento pelo nome da tag.
`surroundByTagName(tagName)`	Pega o conteúdo da seleção e o coloca dentro de um elemento. Em seguida, insere esse novo elemento.
`insertElement(element)`	Insere um elemento. Esse elemento deve ser criado por editor.document.
`surroundElement(element)`	Cria um elemento usando editor.document e coloca o conteúdo da seleção dentro dele. Em seguida, insere esse novo elemento.
`insertText(text)`	Insere o texto simples especificado no documento do editor.
`insertHTML(text)`	Insere o HTML especificado em um intervalo do documento do editor. Se houver algo selecionado, a seleção é substituída pelo novo HTML e texto.
`selectControl(element)`	Seleciona um controle.
`selectDoc(bStart)`	Seleciona o documento. bStart é um valor booleano: true move a seleção para o início, false para o fim. Se omitido, o padrão é false.
`collapse(bStart)`	Recolhe a seleção atual a um único ponto. bStart é um valor booleano: true recolhe o intervalo no início, false no fim. Se omitido, o padrão é false.
`delete()`	Exclui a seleção.
`commitBookmark()`	Cria um bookmark para o registro de desfazer.
`clearHistory()`	Limpa todos os registros de desfazer/refazer.
`notifySelectionChange()`	Notifica o editor sobre qualquer alteração de conteúdo.
`htmlEncode(text)`	Converte uma string em uma string codificada em HTML.
`htmlDecode(html)`	Converte uma string codificada em HTML para transmissão HTTP em uma string decodificada.
`getSelection()`	Retorna o objeto editor.selection.
`getDocument()`	Retorna o objeto editor.document.
`getEditable()`	Retorna o elemento raiz da área editável.
`ensureStyleSheetLive(doc,element,id,csstext)`	Chame-o logo depois de anexar seu próprio elemento <style>. Normalmente ele não faz nada: só age quando uma Content-Security-Policy estrita esvaziou o elemento e, nesse caso, injeta de novo o mesmo CSS pelo CSSOM para que as regras sejam aplicadas em vez de descartadas silenciosamente. Manter o seu elemento <style> como caminho principal é o que preserva a posição dele na cascata.
`injectStyleSheet(doc,id,csstext)`	Adiciona uma folha de estilo ao documento informado sem usar um elemento <style>, de modo que ela sobrevive a um style-src estrito. Use-o quando não houver elemento a preservar; quando houver, prefira ensureStyleSheetLive(), porque as regras vão para uma adopted stylesheet que fica depois de todas as folhas de estilo do documento. Chamá-lo de novo com o mesmo id e um CSS diferente atualiza a folha existente.
`getPlainText()`	Retorna o objeto editor.document.body.innerText.
`getJSON()`	Disponível quando a ponte de conteúdo estruturado está carregada. Retorna um modelo de documento JSON semântico para o conteúdo atual do editor.
`setJSON(documentModel)`	Disponível quando a ponte de conteúdo estruturado está carregada. Restaura o editor a partir do modelo de documento JSON estruturado.
`getSelectedControl()`	Retorna o objeto do controle selecionado.
`getSelectionElement()`	Retorna o objeto do elemento selecionado.
`getSelectedText()`	Retorna o texto simples selecionado.
`createToolbarButton(cmd)`	Cria um botão na barra de ferramentas com os estilos padrão. Para detalhes, consulte o exemplo de plugin.
`createToolbarDropDown(cmd)`	Cria um menu suspenso na barra de ferramentas com os estilos padrão. Para detalhes, consulte o exemplo de plugin.
`createDialog(title,className)`	Cria uma caixa de diálogo com os estilos padrão. Para detalhes, consulte o exemplo de plugin.
`closeCurrentPopup()`	Tenta fechar todos os pop-ups, menus suspensos, menus e caixas de diálogo.
`setImageForCommand(element,cmdname)`	Adiciona ao elemento uma imagem (svg ou png) para cmdname.
`destroy()`	Desmonta o editor e libera seus listeners e seu DOM. Chame-o ao desmontar em uma SPA; prepareDestroy() é um alias.
`getHTML() / setHTML(html)`	Aliases de getHTMLCode() e setHTMLCode().
`bindDocumentEvent(type, handler, capture)`	A partir do core 2.6.10. Escuta eventos no documento de edição (keydown, input, ...). Use-o em vez de getDocument().addEventListener: o editor o reanexa quando o frame de edição recebe um novo documento (veja o evento documentreplaced).
`bindEditableEvent(type, handler, capture)`	A partir do core 2.6.10. O mesmo, no body editável (getEditable()).
`runInSavedView(fn)`	A partir do core 2.6.10. Executa fn enquanto a área de edição mostra exatamente o que seria SALVO (prévias de plugins, como amostras de campos de mesclagem, ficam desligadas durante a chamada) e retorna o resultado de fn. Use-o em qualquer exportação que precise ler estilos calculados ou layout.
`cancelUploads(reason)`	Cancela todos os uploads ainda em andamento e retorna quantos foram cancelados. Chama a função de abort retornada pelo handler, quando fornecida, e ignora resultados que chegam atrasados. destroy() também cancela os uploads. O resultado de uma imagem removida do documento é descartado; a remoção por si só não garante que a requisição de rede seja abortada imediatamente.
`getPendingUploadCount()`	Quantos uploads ainda estão em andamento.
`uploadEmbeddedImages(callback)`	Envia, por meio de file_upload_handler, as imagens já incorporadas ao conteúdo como data: URLs em base64 (conteúdo definido com setHTMLCode, colado de uma página ou restaurado de um rascunho), substituindo cada src pela URL retornada. O callback recebe { uploaded, failed, skipped, errors }. Imagens http(s) não são alteradas; sem um handler configurado, nada muda.
`getText() / setText(text)`	Aliases de getPlainText() e setPlainText().
`setPlainText(text)`	Substitui o documento por texto simples; cada quebra de linha vira um bloco próprio.
`formatChanged(formats, callback)`	Assina as mudanças de estado de formatação/comando para que uma barra de ferramentas personalizada acompanhe o estado ativo sem polling. Corresponde ao formatChanged() do TinyMCE; é acionado pela mesma atualização da barra de ferramentas nativa, então um assinante não fica dessincronizado. Também disponível como editor.formatter.formatChanged.
`getSelectedHTML()`	Retorna a seleção atual como uma string HTML.
`getStatistics()`	Retorna as estatísticas de conteúdo do editor (contagem de palavras, caracteres e afins).
`showWordCount()`	Abre a caixa de diálogo de contagem de palavras.
`showShortcuts()`	Abre a folha de referência de atalhos de teclado (Cmd/Ctrl + /).
`toMarkdown()`	Retorna o conteúdo atual como CommonMark.
`fromMarkdown(md, opts)`	Substitui o conteúdo analisando CommonMark.
`exportPdf(options)`	Exporta o documento como um PDF vetorial com tags.
`printPreview()`	Abre a visualização de impressão do documento atual.
`insertImageByUrl(url, alt)`	Insere uma imagem a partir de uma URL na posição do cursor. O parâmetro opcional alt define o texto alternativo (core 2.6.5+); sem ele, nenhum atributo alt é gravado.
`openFindDialog()`	Abre a caixa de diálogo de localizar e substituir.
`findHighlight(query, options)`	Destaca todas as ocorrências de uma busca sem abrir a caixa de diálogo.
`clearFindHighlights()`	Remove os destaques adicionados por findHighlight().
`markAllOccurrencesOfSelection()`	Destaca todas as ocorrências da seleção atual.
`toggleReadingMode(state) / isReadingMode()`	Liga ou desliga o modo de leitura sem distrações e informa o estado dele.
`setCommentsOnly(bVal) / getCommentsOnly()`	Restringe a edição apenas a comentários e informa se esse modo está ativo.
`applyMathMarkup() / renderMath()`	Converte TeX na marcação matemática do editor e a renderiza quando KaTeX ou MathJax está presente na página.
`setPreviewCssText(text)`	Define o CSS inline usado pelo modo de visualização.
`getLangText(key)`	Busca uma string de interface localizada para o idioma ativo.
`fireEvent(name, ...args)`	Invoca um hook de evento por código.
`autoSave`	Presente quando config.autoSave está definido. Salva no seu próprio servidor enquanto o usuário digita: trigger() salva agora, retryNow() tenta de novo imediatamente um salvamento que falhou, hasUnsavedChanges() informa se ainda há um salvamento pendente, isDirty() compara o conteúdo com a última versão salva e lastSavedAt() retorna o timestamp. Um salvamento que falha é repetido com um intervalo que dobra a cada tentativa e quando o navegador volta a ficar online, reenviando o snapshot que falhou. Os eventos autosaved e autosavefailed informam os dois resultados. Para rascunhos no navegador, veja a opção localDraft.