← Toda la documentación

editor.collapse(bStart)

Contrae la selección actual a un único punto de inserción (un cursor sin texto resaltado). Úsalo después de una selección hecha desde código o de un comando que actuó sobre un rango, cuando quieras colocar el cursor en uno de los extremos de lo seleccionado en lugar de dejar todo el rango resaltado.

Sintaxis

editor.collapse(bStart)

Parámetros

bStart: booleano. true contrae la selección a su inicio, false a su final. Si se omite, se comporta como false (contraer al final).

Valor devuelto

Nada (undefined).

Notas de comportamiento

  • Las selecciones ya contraídas no se tocan. Si la selección ya es un cursor, collapse() vuelve de inmediato sin moverlo.
  • Sin rango activo, primero se selecciona el documento. Si no hay ningún rango de selección (por ejemplo, porque el editor todavía no ha recibido el foco), collapse() recurre a seleccionar todo el documento, así que la llamada deja igualmente una selección bien definida con la que trabajar.
  • Actúa sobre la selección real, la misma que ve el usuario: no hay un cursor aparte que mantener sincronizado.

Ejemplo de uso

Aplica un comando a todo el documento y luego coloca el cursor al final para que la escritura continúe después:

var editor1 = new RichTextEditor("#div_editor1");
editor1.setHTMLCode("<b>hello world</b>");
editor1.selectDoc();
editor1.execCommand("forecolor", "red");
editor1.collapse(false);   // caret lands after the colored text

Contrae al inicio, en cambio, para colocar el cursor antes de la selección:

editor1.selectDoc();
editor1.collapse(true);    // caret lands at the very beginning

Relacionado