Méthodes de RichTextEditor

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

RichTextEditor expose les méthodes suivantes.

Méthode	Description
`duplicateCurrentBlock()`	Uniquement dans les builds du cœur plus récents compilés depuis les sources (pas dans tous les bundles publiés) : duplique le ou les blocs de la sélection et place le curseur dans la copie. Les id uniques et les identités de relecture ne sont pas clonés. Le contenu en lecture seule ou en mode commentaires uniquement, les fusions de lignes non prises en charge et le mode suggestion refusent l’opération. Un retour true peut signifier une opération neutralisée par une garde, et ne prouve pas que le contenu a été copié. Vérifiez typeof editor.duplicateCurrentBlock avant de l’utiliser avec un runtime plus ancien.
`recordUndo()`	Enregistre le document courant et valide son étape d’annulation. Appelez-la après une modification personnalisée du DOM pour rendre la modification annulable.
`makePanelResizable(panel, opts)`	Depuis core 2.6.11. Ajoute à un élément de panneau latéral un bord de redimensionnement que l’on peut faire glisser et utiliser au clavier (ArrowLeft / ArrowRight / Home / End). opts : largeur minimale et maximale en px (par défaut 240 / 720), libellé pour les lecteurs d’écran. Déclenche l’événement panelresized. Renvoie l’élément poignée, ou null si le panneau est absent ou déjà redimensionnable.
`setListStart(n)`	Définit le numéro de départ de la liste ordonnée de la sélection, 0 compris. Renvoie false lorsqu’aucune liste ordonnée n’est sélectionnée ou que n est invalide.
`continueListNumbering()`	Poursuit la numérotation de la liste ordonnée sélectionnée à partir de la liste ordonnée précédente. Renvoie false si aucune liste appropriée n’est trouvée.
`toggleTableCaption()`	Ajoute ou supprime la légende du tableau sélectionné et enregistre une étape d’annulation. Renvoie false lorsqu’aucun tableau n’est sélectionné.
`execCommand(cmd,value)`	Exécute une commande sur la sélection courante, ou sur la plage indiquée.
`attachEvent(name,handler)`	Enregistre un gestionnaire d’événement. Vous pouvez interagir avec lui une fois l’éditeur chargé et en cours d’exécution.
`detachEvent(name,handler)`	Retire un gestionnaire d’un événement.
`getHTMLCode()`	Cette méthode sert à récupérer le contenu de RichTextEditor en HTML.
`setHTMLCode(html)`	Cette méthode sert à définir le contenu de RichTextEditor.
`getReadOnly()`	Renvoie une valeur qui indique si l’éditeur est en lecture seule côté client.
`setReadOnly(bReadOnly)`	Permet d’activer ou de désactiver le mode lecture seule.
`isCommandEnabled(cmd)`	Indique si la commande indiquée est activée.
`isCommandActive(cmd)`	Vérifie si cette commande peut actuellement être exécutée.
`focus()`	Tente de placer le focus dans la fenêtre de contenu de l’éditeur.
`setContentCssText(text)`	Cette méthode sert à définir le texte CSS en ligne qui sera utilisé par la zone modifiable.
`insertRootParagraph(tagname)`	Cette méthode sert à insérer un nouveau paragraphe en bas de l’éditeur.
`insertByTagName(tagName)`	Insère un élément d’après son nom de balise.
`surroundByTagName(tagName)`	Récupère le contenu de la sélection et le place dans un élément, puis insère ce nouvel élément.
`insertElement(element)`	Insère un élément. Cet élément doit être créé par editor.document.
`surroundElement(element)`	Crée un élément à l’aide d’editor.document, place le contenu de la sélection dans cet élément, puis insère ce nouvel élément.
`insertText(text)`	Cette méthode sert à insérer le texte brut indiqué dans le document de l’éditeur.
`insertHTML(text)`	Cette méthode sert à insérer le HTML indiqué dans une plage du document de l’éditeur. Si quelque chose est sélectionné, la sélection est remplacée par le nouveau HTML et le nouveau texte.
`selectControl(element)`	Sélectionne un contrôle.
`selectDoc(bStart)`	Sélectionne le document. bStart est une valeur booléenne : true place la sélection à son début, false à sa fin. S’il est omis, il vaut false par défaut.
`collapse(bStart)`	Réduit la sélection courante à un seul point. bStart est une valeur booléenne : true réduit la plage à son début, false à sa fin. S’il est omis, il vaut false par défaut.
`delete()`	Supprime une sélection.
`commitBookmark()`	Crée un signet pour l’enregistrement d’annulation.
`clearHistory()`	Efface tous les enregistrements d’annulation et de rétablissement.
`notifySelectionChange()`	Informe l’éditeur de toute modification du contenu.
`htmlEncode(text)`	Convertit une chaîne en chaîne encodée en HTML.
`htmlDecode(html)`	Convertit une chaîne encodée en HTML pour la transmission HTTP en chaîne décodée.
`getSelection()`	Renvoie l’objet editor.selection.
`getDocument()`	Renvoie l’objet editor.document.
`getEditable()`	Renvoie l’élément racine de la zone modifiable.
`ensureStyleSheetLive(doc,element,id,csstext)`	Appelez-la juste après avoir ajouté votre propre élément <style>. Normalement, elle ne fait rien : elle n’agit que lorsqu’une Content-Security-Policy stricte a vidé l’élément, et elle réinjecte alors le même CSS via le CSSOM pour que les règles s’appliquent au lieu d’être silencieusement abandonnées. Conserver votre élément <style> comme voie principale préserve sa place dans la cascade.
`injectStyleSheet(doc,id,csstext)`	Ajoute une feuille de style au document indiqué sans utiliser d’élément <style>, pour qu’elle survive à un style-src strict. Utilisez-la lorsque vous n’avez aucun élément à préserver ; préférez ensureStyleSheetLive() dans le cas contraire, car les règles atterrissent dans une feuille de style adoptée qui se place après toutes les feuilles de style du document. La rappeler avec le même id et un CSS différent met à jour la feuille existante.
`getPlainText()`	Renvoie l’objet editor.document.body.innerText.
`getJSON()`	Disponible lorsque la passerelle de contenu structuré est chargée. Renvoie un modèle de document JSON sémantique pour le contenu courant de l’éditeur.
`setJSON(documentModel)`	Disponible lorsque la passerelle de contenu structuré est chargée. Restaure l’éditeur à partir du modèle de document JSON structuré.
`getSelectedControl()`	Renvoie l’objet de contrôle sélectionné.
`getSelectionElement()`	Renvoie l’objet élément sélectionné.
`getSelectedText()`	Renvoie le texte brut sélectionné.
`createToolbarButton(cmd)`	Crée un bouton de barre d’outils avec les styles par défaut. Pour plus de détails, consultez l’exemple de plugin.
`createToolbarDropDown(cmd)`	Crée une liste déroulante dans la barre d’outils avec les styles par défaut. Pour plus de détails, consultez l’exemple de plugin.
`createDialog(title,className)`	Crée une boîte de dialogue avec les styles par défaut. Pour plus de détails, consultez l’exemple de plugin.
`closeCurrentPopup()`	Tente de fermer toutes les fenêtres contextuelles, listes déroulantes, menus et boîtes de dialogue.
`setImageForCommand(element,cmdname)`	Ajoute à l’élément une image (svg ou png) pour cmdname.
`destroy()`	Démonte l’éditeur et libère ses écouteurs et son DOM. Appelez-la lors du démontage dans une SPA ; prepareDestroy() en est un alias.
`getHTML() / setHTML(html)`	Alias de getHTMLCode() et setHTMLCode().
`bindDocumentEvent(type, handler, capture)`	Depuis core 2.6.10. Écoute sur le document d’édition (keydown, input, ...). Utilisez-la à la place de getDocument().addEventListener : l’éditeur rattache l’écouteur lorsque le cadre d’édition reçoit un nouveau document (voir l’événement documentreplaced).
`bindEditableEvent(type, handler, capture)`	Depuis core 2.6.10. La même chose, sur le body modifiable (getEditable()).
`runInSavedView(fn)`	Depuis core 2.6.10. Exécute fn pendant que la zone d’édition affiche exactement ce qui serait ENREGISTRÉ (les aperçus des plugins, comme les exemples de champs de fusion, sont désactivés le temps de l’appel) et renvoie le résultat de fn. Utilisez-la pour tout export qui doit lire des styles calculés ou la mise en page.
`cancelUploads(reason)`	Annule tous les envois encore en cours et renvoie le nombre d’envois annulés. Appelle la fonction d’interruption renvoyée par le gestionnaire lorsqu’elle est fournie, et ignore les résultats tardifs. destroy() annule aussi les envois. Le résultat concernant une image retirée du document est abandonné ; ce retrait seul ne garantit pas une interruption réseau immédiate.
`getPendingUploadCount()`	Le nombre d’envois encore en cours.
`uploadEmbeddedImages(callback)`	Envoie, via file_upload_handler, les images déjà intégrées dans le contenu sous forme d’URL data: en base64 — contenu défini avec setHTMLCode, collé depuis une page ou restauré depuis un brouillon — en remplaçant chaque src par l’URL renvoyée. Le callback reçoit { uploaded, failed, skipped, errors }. Les images http(s) ne sont pas touchées ; sans gestionnaire configuré, rien ne change.
`getText() / setText(text)`	Alias de getPlainText() et setPlainText().
`setPlainText(text)`	Remplace le document par du texte brut ; chaque saut de ligne devient un bloc distinct.
`formatChanged(formats, callback)`	S’abonne aux changements d’état des formats et des commandes, pour qu’une barre d’outils personnalisée puisse suivre l’état actif sans interrogation périodique. Correspond au formatChanged() de TinyMCE ; piloté par la même actualisation que la barre d’outils intégrée, un abonné ne peut donc pas se désynchroniser. Également disponible sous editor.formatter.formatChanged.
`getSelectedHTML()`	Renvoie la sélection courante sous forme de chaîne HTML.
`getStatistics()`	Renvoie les statistiques du contenu de l’éditeur (nombre de mots, de caractères et comptages associés).
`showWordCount()`	Ouvre la boîte de dialogue du nombre de mots.
`showShortcuts()`	Ouvre l’aide-mémoire des raccourcis clavier (Cmd/Ctrl + /).
`toMarkdown()`	Renvoie le contenu courant en CommonMark.
`fromMarkdown(md, opts)`	Remplace le contenu en analysant du CommonMark.
`exportPdf(options)`	Exporte le document en PDF vectoriel balisé.
`printPreview()`	Ouvre l’aperçu avant impression du document courant.
`insertImageByUrl(url, alt)`	Insère à l’emplacement du curseur une image à partir d’une URL. Le paramètre facultatif alt définit le texte alternatif (core 2.6.5+) ; sans lui, aucun attribut alt n’est écrit.
`openFindDialog()`	Ouvre la boîte de dialogue Rechercher et remplacer.
`findHighlight(query, options)`	Met en évidence toutes les correspondances d’une requête sans ouvrir la boîte de dialogue.
`clearFindHighlights()`	Supprime les mises en évidence ajoutées par findHighlight().
`markAllOccurrencesOfSelection()`	Met en évidence toutes les occurrences de la sélection courante.
`toggleReadingMode(state) / isReadingMode()`	Active ou désactive l’affichage de lecture épuré, et indique son état.
`setCommentsOnly(bVal) / getCommentsOnly()`	Limite l’édition aux seuls commentaires, et indique si ce mode est actif.
`applyMathMarkup() / renderMath()`	Convertit le TeX dans le balisage mathématique de l’éditeur, et l’affiche lorsque KaTeX ou MathJax est présent sur la page.
`setPreviewCssText(text)`	Définit le CSS en ligne utilisé par le mode aperçu.
`getLangText(key)`	Recherche une chaîne d’interface localisée pour la langue active.
`fireEvent(name, ...args)`	Invoque un hook d’événement par programmation.
`autoSave`	Présent lorsque config.autoSave est défini. Enregistre sur votre propre serveur au fil de la saisie : trigger() enregistre immédiatement, retryNow() relance aussitôt un enregistrement échoué, hasUnsavedChanges() indique si un enregistrement est encore en attente, isDirty() compare le contenu à la dernière version enregistrée et lastSavedAt() renvoie l’horodatage. Un enregistrement échoué est relancé avec un délai qui double à chaque fois, ainsi qu’au retour de la connexion du navigateur, en renvoyant l’instantané qui a échoué. Les événements autosaved et autosavefailed signalent les deux issues. Pour des brouillons côté navigateur, consultez plutôt l’option localDraft.