Populate the Find dialog with the selected text.

[Joe Kavanagh]

If the user selects some text and then opens the Find dialog the Find field would be automatically populated with the selected text.

This is the behaviour in most applications. It is quite useful when searching for other occurrences of some existing text.

[Garry Yao]

In general, the field is filled only if a word is selected.

[Frederico Caldeira Knabben]

The plain full selection is ok as well.

[Vicul]

For adding that feature is necessary to do some modifications in the file:

/trunk/_source/plugins/find/dialogs/find.js

1. Add the new function:

• before modification:

function getSearchRange( isDefault )

{

var searchRange,

sel = editor.getSelection(),

body = editor.document.getBody();

if ( sel && !isDefault )

{

searchRange = sel.getRanges()[ 0 ].clone();

searchRange.collapse( true );

}

else

{

searchRange = new CKEDITOR.dom.range();

searchRange.setStartAt( body, CKEDITOR.POSITION_AFTER_START );

}

searchRange.setEndAt( body, CKEDITOR.POSITION_BEFORE_END );

return searchRange;

}

• after modification

function getSearchRange( isDefault )

{

var searchRange,

sel = editor.getSelection(),

body = editor.document.getBody();

if ( sel && !isDefault )

{

searchRange = sel.getRanges()[ 0 ].clone();

searchRange.collapse( true );

}

else

{

searchRange = new CKEDITOR.dom.range();

searchRange.setStartAt( body, CKEDITOR.POSITION_AFTER_START );

}

searchRange.setEndAt( body, CKEDITOR.POSITION_BEFORE_END );

return searchRange;

}

function getSelectedText( editor )

{

var selectedText = ;

var selection = editor.getSelection();

if ( selection.getType() == CKEDITOR.SELECTION_TEXT )

{

if ( CKEDITOR.env.ie )

{

selection.unlock(true);

selectedText = selection.getNative().createRange().text;

}

else

{

selectedText = selection.getNative();

}

}

return(selectedText);

}

2. Add the following code in the function onShow : function():

• before modification:

onShow : function()

{

Establish initial searching start position.

finder.searchRange = getSearchRange();

this.selectPage( startupPage );

},

• after modification

onShow : function()

{

Establish initial searching start position.

finder.searchRange = getSearchRange();

this.selectPage( startupPage );

set the user selected text

var editor = this.getParentEditor();

var selectedContent = getSelectedText( editor ).toString();

var pageId = this._.currentTabId;

patternFieldId = pageId === 'find' ? 'txtFindFind' : 'txtFindReplace';

patternField = this.getContentElement( pageId, patternFieldId );

patternField.setValue(selectedContent);

},

[Garry Yao]

@Vicul thanks for the patch, but could u please created a diff file for what you're patching?

[Frederico Caldeira Knabben]

@Vicul, please provide us a SVN patch based on trunk. Thanks!

[Vicul]

New diff file

[Frederico Caldeira Knabben]

Some issues on the patch:

• The toString() call must be done in the getSelectedText function directly (line 615), to avoid it being done on onShow (line 877).

• The patternFieldId and patternField seem to be missing the "var" declaration.

• return(selectedText) should not have the parenthesis.

• With IE, the current selection get lost if you open the dialog and close it immediately.

• With IE, it doesn't work well. Sometimes the field doesn't get filled. This seems to be random and may be related to the browser speed of working with the selection.

• There are several unnecessary TABs in the code. (lines 70, 877 and 881)

[Frederico Caldeira Knabben]

Replying to fredck:

• With IE, the current selection get lost if you open the dialog and close it immediately.

As for this issue, it seems to be enough to simply lock the selection again, after unlocking it.

[Vicul]

patch_2

[Vicul]

I fixed those issues except on IE: I could not catch that situation, tried at several PCs for an hour, please specify additional conditions.

[Frederico Caldeira Knabben]

Calling finder.find() to solve the IE issue was a bit of an ugly hack. It also made it loose the selection again when the selection involved more than one paragraph. The solution for it was already on my last comment, by simply calling selection.lock() again.

As for the random IE issue, seems still to happen, but it's not related to this ticket. It's supposed to be an issue with the selection system which deserves a dedicated ticket as soon as this one gets committed.

The new patch also includes minor fixes in the code style and minor changes.

[Garry Yao]

As for the random IE issue, seems still to happen...

I can hardly call it a random issue as the issue is reproduced for every fresh opening of the dialog, I'm not sure if there's a solution exist regard this particular selection system bug (as it might be a browser bug), but we can definitely avoid it - considering that getSelectedText is really a highly requested method by the community, baking it into dom.selection definitely make sense so lock could consider it as well.

[Garry Yao]

Besides, populated text must be full selected and page select must happen after it to avoid an existing IE6/7 hack.

[Vicul]

Considered your patches, thanks for assisting with those issues. Garry, can't follow your last comment, could you explain it detaily. Still can't reproduce random fail of IE, although been testing it in IE 7,8 even with huge amount of text. And generally please resume what else left to be done from my side to finish it up. Thank you.

[Frederico Caldeira Knabben]

@Vicul, there is nothing else left here. We'll be working to close this ticket now. Thanks for the contribution!

[Garry Yao]

Fixed with [6909], thanks Vicul.

[Garry Yao]

Doc updated with [6910].

[Sa'ar Zac Elias]

The patch broke Chrome, fixed with [6914].