public interface IFindReplaceTargetExtension
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.
Modifier and Type | Method and Description |
---|---|
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.
|
void beginSession()
beginSession()
and endSession()
to
IFindReplaceTarget
and
IFindReplaceTargetExtension
must be embedded within calls to
beginSession()
and endSession()
.endSession()
void endSession()
beginSession()
IRegion getScope()
null
for global scope.null
void setScope(IRegion scope)
null
indicates that the global scope should be used.scope
- the find scope of the target, may be null
Point getLineSelection()
void setSelection(int offset, int length)
offset
- the offset of the selectionlength
- the length of the selectionvoid setScopeHighlightColor(Color color)
color
- the color of the scope highlightvoid setReplaceAllMode(boolean replaceAll)
replaceAll
- true
if this target should switch into replace-all mode,
false
if it should leave the replace-all state
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.