← Toda a documentação

editor.collapse(bStart)

Recolhe a seleção atual para um único ponto de inserção (um cursor sem texto destacado). Use este método depois de uma seleção feita por código ou de um comando que atuou sobre um intervalo, quando você quiser colocar o cursor em uma das extremidades do que estava selecionado em vez de deixar o intervalo inteiro destacado.

Sintaxe

editor.collapse(bStart)

Parâmetros

bStart — booleano. true recolhe a seleção para o início, false para o fim. Omitir o parâmetro equivale a false (recolher para o fim).

Retorno

Nada (undefined).

Observações de comportamento

  • Seleções já recolhidas não são alteradas. Se a seleção já for um cursor, collapse() retorna imediatamente sem movê-lo.
  • Sem intervalo ativo, o documento é selecionado primeiro. Se não houver nenhum intervalo de seleção (por exemplo, quando o editor ainda não recebeu o foco), collapse() seleciona o documento inteiro como alternativa, de modo que a chamada ainda deixa uma seleção bem definida para trabalhar.
  • Ele atua sobre a seleção ativa, a mesma que o usuário vê — não há um cursor separado para manter sincronizado.

Exemplo de uso

Aplique um comando ao documento inteiro e depois coloque o cursor no fim, para que a digitação continue depois dele:

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

Ou recolha para o início, para posicionar o cursor antes da seleção:

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

Relacionados