Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.jface.text
Interface IFindReplaceTargetExtension


public interface IFindReplaceTargetExtension

Extension interface for IFindReplaceTarget.

Introduces the concepts of find/replace sessions, searching in a limiting scope and a replace-all mode.

If a scope is set, findAndSelect is limited to the scope. Occurrences outside of the scope are not considered.

Since:
2.0

Method Summary
 void beginSession ()
          Indicates that a session with the target begins.
 void endSession ()
          Indicates that a session with the target ends.
  Point getLineSelection ()
          Returns the currently selected range of lines as a offset and length.
  IRegion getScope ()
          Returns the find scope of the target, null for global scope.
 void setReplaceAllMode (boolean replaceAll)
          Sets the target's replace-all mode.
 void setScope ( IRegion scope)
          Sets the find scope of the target to operate on.
 void setScopeHighlightColor ( Color color)
          Sets the scope highlight color
 void setSelection (int offset, int length)
          Sets a selection.
 

Method Detail

beginSession

void beginSession()
Indicates that a session with the target begins. All calls except beginSession() and endSession() to IFindReplaceTarget and IFindReplaceTargetExtension must be embedded within calls to beginSession() and endSession().

See Also:
endSession()

endSession

void endSession()
Indicates that a session with the target ends.

See Also:
beginSession()

getScope

IRegion getScope()
Returns the find scope of the target, null for global scope.

Returns:
returns the find scope of the target, may be null

setScope

void setScope(
IRegion scope)
Sets the find scope of the target to operate on. null indicates that the global scope should be used.

Parameters:
scope - the find scope of the target, may be null

getLineSelection

Point getLineSelection()
Returns the currently selected range of lines as a offset and length.

Returns:
the currently selected line range

setSelection

void setSelection(int offset,
                  int length)
Sets a selection.

Parameters:
offset - the offset of the selection
length - the length of the selection

setScopeHighlightColor

void setScopeHighlightColor(
Color color)
Sets the scope highlight color

Parameters:
color - the color of the scope highlight

setReplaceAllMode

void setReplaceAllMode(boolean replaceAll)
Sets the target's replace-all mode.

Parameters:
replaceAll - true if this target should switch into replace-all mode, false if it should leave the replace-all state

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire