Métodos de RichTextEditor

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

RichTextEditor ofrece los siguientes métodos.

Método	Descripción
`duplicateCurrentBlock()`	Solo en las compilaciones de core recientes desde el código fuente (no en todos los bundles publicados): duplica los bloques de la selección y coloca el cursor en la copia. Los id únicos y las identidades de revisión no se clonan. El contenido de solo lectura o solo comentarios, las combinaciones de filas no admitidas y el modo de sugerencias rechazan la operación. Un valor true devuelto puede significar una operación vacía protegida, no una prueba de que el contenido se copió. Comprueba typeof editor.duplicateCurrentBlock antes de usarlo con un runtime más antiguo.
`recordUndo()`	Registra el documento actual y confirma su paso de deshacer. Llámalo después de una edición personalizada del DOM para que el cambio se pueda deshacer.
`makePanelResizable(panel, opts)`	Desde core 2.6.11. Añade a un elemento de panel lateral un borde de redimensionamiento que se puede arrastrar y manejar con el teclado (ArrowLeft / ArrowRight / Home / End). opts: ancho mínimo y máximo en px (240 / 720 de forma predeterminada) y label para los lectores de pantalla. Lanza el evento panelresized. Devuelve el elemento tirador, o null si el panel no existe o ya es redimensionable.
`setListStart(n)`	Establece el número inicial de la lista ordenada de la selección, incluido el 0. Devuelve false cuando no hay ninguna lista ordenada seleccionada o n no es válido.
`continueListNumbering()`	Continúa la numeración de la lista ordenada seleccionada a partir de la lista ordenada anterior. Devuelve false cuando no encuentra una lista adecuada.
`toggleTableCaption()`	Añade o quita el título de la tabla seleccionada y registra un paso de deshacer. Devuelve false cuando no hay ninguna tabla seleccionada.
`execCommand(cmd,value)`	Ejecuta un comando sobre la selección actual o sobre el rango indicado.
`attachEvent(name,handler)`	Registra un controlador de eventos. Puedes interactuar con él cuando el editor esté cargado y en funcionamiento.
`detachEvent(name,handler)`	Quita un controlador de eventos de un evento.
`getHTMLCode()`	Este método obtiene el contenido de RichTextEditor como HTML.
`setHTMLCode(html)`	Este método establece el contenido de RichTextEditor.
`getReadOnly()`	Devuelve un valor que indica si el estado del editor en el cliente es de solo lectura.
`setReadOnly(bReadOnly)`	Permite activar o desactivar el modo de solo lectura.
`isCommandEnabled(cmd)`	Indica si el comando especificado está habilitado.
`isCommandActive(cmd)`	Comprueba si este comando se puede ejecutar en este momento.
`focus()`	Intenta dar el foco a la ventana de contenido del editor.
`setContentCssText(text)`	Este método establece el texto CSS en línea que usará el área editable.
`insertRootParagraph(tagname)`	Este método inserta un nuevo párrafo al final del editor.
`insertByTagName(tagName)`	Inserta un elemento por su nombre de etiqueta.
`surroundByTagName(tagName)`	Toma el contenido de la selección y lo coloca dentro de un elemento. Después inserta ese nuevo elemento.
`insertElement(element)`	Inserta un elemento. El elemento debe crearse con editor.document.
`surroundElement(element)`	Crea un elemento con editor.document. Coloca el contenido de la selección dentro del elemento. Después inserta ese nuevo elemento.
`insertText(text)`	Este método inserta el texto sin formato indicado en el documento del editor.
`insertHTML(text)`	Este método inserta el HTML indicado en un rango del documento del editor. Si hay algo seleccionado, la selección se sustituye por el nuevo HTML y texto.
`selectControl(element)`	Selecciona un control.
`selectDoc(bStart)`	Selecciona el documento. bStart es un valor booleano: true mueve la selección a su inicio y false a su final. Si se omite, vale false.
`collapse(bStart)`	Contrae la selección actual a un único punto. bStart es un valor booleano: true contrae el rango a su inicio y false a su final. Si se omite, vale false.
`delete()`	Elimina una selección.
`commitBookmark()`	Crea un marcador para el registro de deshacer.
`clearHistory()`	Borra todos los registros de deshacer y rehacer.
`notifySelectionChange()`	Notifica al editor cualquier cambio en el contenido.
`htmlEncode(text)`	Convierte una cadena en una cadena codificada en HTML.
`htmlDecode(html)`	Convierte una cadena que se codificó en HTML para su transmisión por HTTP en una cadena decodificada.
`getSelection()`	Devuelve el objeto editor.selection.
`getDocument()`	Devuelve el objeto editor.document.
`getEditable()`	Devuelve el elemento raíz del área editable.
`ensureStyleSheetLive(doc,element,id,csstext)`	Llámalo justo después de añadir tu propio elemento <style>. Normalmente no hace nada: solo actúa cuando una Content-Security-Policy estricta ha vaciado el elemento, y entonces vuelve a inyectar el mismo CSS a través del CSSOM para que las reglas se apliquen en lugar de descartarse sin avisar. Mantener tu elemento <style> como vía principal es lo que conserva su lugar en la cascada.
`injectStyleSheet(doc,id,csstext)`	Añade una hoja de estilos al documento indicado sin usar un elemento <style>, así que sobrevive a un style-src estricto. Úsalo cuando no tengas ningún elemento que conservar; si lo tienes, es preferible ensureStyleSheetLive(), porque las reglas acaban en una hoja de estilos adoptada que se ordena después de todas las hojas de estilos del documento. Volver a llamarlo con el mismo id y otro CSS actualiza la hoja existente.
`getPlainText()`	Devuelve el objeto editor.document.body.innerText.
`getJSON()`	Disponible cuando está cargado el puente de contenido estructurado. Devuelve un modelo de documento JSON semántico del contenido actual del editor.
`setJSON(documentModel)`	Disponible cuando está cargado el puente de contenido estructurado. Restaura el editor a partir del modelo de documento JSON estructurado.
`getSelectedControl()`	Devuelve el objeto de control seleccionado.
`getSelectionElement()`	Devuelve el objeto del elemento seleccionado.
`getSelectedText()`	Devuelve el texto sin formato seleccionado.
`createToolbarButton(cmd)`	Crea un botón en la barra de herramientas con los estilos predeterminados. Para más detalles, consulta el ejemplo de plugin.
`createToolbarDropDown(cmd)`	Crea una lista desplegable en la barra de herramientas con los estilos predeterminados. Para más detalles, consulta el ejemplo de plugin.
`createDialog(title,className)`	Crea un cuadro de diálogo con los estilos predeterminados. Para más detalles, consulta el ejemplo de plugin.
`closeCurrentPopup()`	Intenta cerrar todas las ventanas emergentes, listas desplegables, menús y cuadros de diálogo.
`setImageForCommand(element,cmdname)`	Añade al elemento una imagen (svg o png) para cmdname.
`destroy()`	Desmonta el editor y libera sus listeners y su DOM. Llámalo al desmontar en una SPA; prepareDestroy() es un alias.
`getHTML() / setHTML(html)`	Alias de getHTMLCode() y setHTMLCode().
`bindDocumentEvent(type, handler, capture)`	Desde core 2.6.10. Escucha en el documento de edición (keydown, input, ...). Úsalo en lugar de getDocument().addEventListener: el editor lo vuelve a adjuntar cuando el marco de edición recibe un documento nuevo (consulta el evento documentreplaced).
`bindEditableEvent(type, handler, capture)`	Desde core 2.6.10. Lo mismo, sobre el body editable (getEditable()).
`runInSavedView(fn)`	Desde core 2.6.10. Ejecuta fn mientras el área de edición muestra exactamente lo que se GUARDARÍA (las vistas previas de los plugins, como los ejemplos de campos de combinación, se desactivan durante la llamada) y devuelve el resultado de fn. Úsalo en cualquier exportación que tenga que leer estilos calculados o el diseño.
`cancelUploads(reason)`	Cancela todas las cargas que siguen en curso y devuelve cuántas se cancelaron. Llama a la función abort que devuelve el controlador, si la proporciona, e ignora los resultados tardíos. destroy() también cancela las cargas. El resultado de una imagen eliminada del documento se descarta; eliminarla por sí sola no garantiza que se cancele de inmediato la solicitud de red.
`getPendingUploadCount()`	Cuántas cargas siguen en curso.
`uploadEmbeddedImages(callback)`	Sube a través de file_upload_handler las imágenes ya incrustadas en el contenido como URL data: en base64 (contenido establecido con setHTMLCode, pegado desde una página o restaurado desde un borrador) y sustituye cada src por la URL devuelta. El callback recibe { uploaded, failed, skipped, errors }. Las imágenes http(s) no se tocan; sin ningún controlador configurado, no cambia nada.
`getText() / setText(text)`	Alias de getPlainText() y setPlainText().
`setPlainText(text)`	Sustituye el documento por texto sin formato; cada salto de línea se convierte en un bloque propio.
`formatChanged(formats, callback)`	Se suscribe a los cambios de estado de formatos y comandos, para que una barra de herramientas personalizada pueda seguir el estado activo sin sondear. Equivale a formatChanged() de TinyMCE; lo impulsa la misma actualización que la barra de herramientas integrada, así que un suscriptor no puede desincronizarse. También está disponible como editor.formatter.formatChanged.
`getSelectedHTML()`	Devuelve la selección actual como cadena HTML.
`getStatistics()`	Devuelve las estadísticas del contenido del editor (recuentos de palabras, caracteres y relacionados).
`showWordCount()`	Abre el cuadro de diálogo de recuento de palabras.
`showShortcuts()`	Abre la hoja de referencia de atajos de teclado (Cmd/Ctrl + /).
`toMarkdown()`	Devuelve el contenido actual como CommonMark.
`fromMarkdown(md, opts)`	Sustituye el contenido analizando CommonMark.
`exportPdf(options)`	Exporta el documento como un PDF vectorial y etiquetado.
`printPreview()`	Abre la vista previa de impresión del documento actual.
`insertImageByUrl(url, alt)`	Inserta en la posición del cursor una imagen a partir de una URL. El alt opcional establece el texto alternativo (core 2.6.5+); sin él no se escribe ningún atributo alt.
`openFindDialog()`	Abre el cuadro de diálogo de buscar y reemplazar.
`findHighlight(query, options)`	Resalta todas las coincidencias de una búsqueda sin abrir el cuadro de diálogo.
`clearFindHighlights()`	Quita los resaltados añadidos por findHighlight().
`markAllOccurrencesOfSelection()`	Resalta todas las apariciones de la selección actual.
`toggleReadingMode(state) / isReadingMode()`	Activa o desactiva la vista de lectura sin distracciones e informa de su estado.
`setCommentsOnly(bVal) / getCommentsOnly()`	Limita la edición a solo comentar e informa de si ese modo está activo.
`applyMathMarkup() / renderMath()`	Convierte TeX al marcado matemático del editor y lo representa cuando KaTeX o MathJax están presentes en la página.
`setPreviewCssText(text)`	Establece el CSS en línea que usa el modo de vista previa.
`getLangText(key)`	Busca una cadena localizada de la interfaz para el idioma activo.
`fireEvent(name, ...args)`	Invoca un hook de evento desde código.
`autoSave`	Existe cuando está definido config.autoSave. Guarda en tu propio servidor mientras el usuario escribe: trigger() guarda en ese momento, retryNow() reintenta de inmediato un guardado fallido, hasUnsavedChanges() indica si queda algún guardado pendiente, isDirty() compara el contenido con la última versión guardada y lastSavedAt() devuelve la marca de tiempo. Un guardado fallido se reintenta con una espera que se duplica cada vez y cuando el navegador vuelve a tener conexión, reenviando la instantánea que falló. Los eventos autosaved y autosavefailed informan de ambos resultados. Para borradores en el navegador, consulta en cambio la opción localDraft.