blob: 4a2cf2a058167a732fa7e9e20f5fb0edabab0dce (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
/*******************************************************************************
* Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/cpl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.jface.text;
import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.graphics.Point;
/**
* Extension interface for <code>IFindReplaceTarget</code>. Extends the find replace target with
* the concept of searching in a limiting scope and introduces a replace-all mode.
*
* @since 2.0
*/
public interface IFindReplaceTargetExtension {
/**
* Indicates that a session with the target begins.
* All calls except <code>beginSession()</code> and <code>endSession()</code> to
* <code>IFindReplaceTarget</code> and
* <code>IFindReplaceTargetExtension</code> must be embedded within calls to
* <code>beginSession()</code> and <code>endSession()</code>.
*
* @see #endSession()
*/
void beginSession();
/**
* Indicates that a session with the target ends.
*
* @see #beginSession()
*/
void endSession();
/**
* Returns the find scope of the target, <code>null</code> for global scope.
*
* @return returns the find scope of the target, may be <code>null</code>
*/
IRegion getScope();
/**
* Sets the find scope of the target to operate on. <code>null</code>
* indicates that the global scope should be used.
*
* @param scope the find scope of the target, may be <code>null</code>
*/
void setScope(IRegion scope);
/**
* Returns the currently selected range of lines as a offset and length.
*
* @return the currently selected line range
*/
Point getLineSelection();
/**
* Sets a selection.
*
* @param offset the offset of the selection
* @param length the length of the selection
*/
void setSelection(int offset, int length);
/**
* Sets the scope highlight color
*
* @param color the color of the scope highlight
*/
void setScopeHighlightColor(Color color);
/**
* Sets the target's replace-all mode.
*
* @param replaceAll <code>true</code> if this target should switch into replace-all mode,
* <code>false</code> if it should leave the replace-all state
*/
void setReplaceAllMode(boolean replaceAll);
}
|