diff options
Diffstat (limited to 'org.eclipse.jface.text/src/org/eclipse/jface/text/IFindReplaceTargetExtension.java')
-rw-r--r-- | org.eclipse.jface.text/src/org/eclipse/jface/text/IFindReplaceTargetExtension.java | 89 |
1 files changed, 89 insertions, 0 deletions
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/IFindReplaceTargetExtension.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/IFindReplaceTargetExtension.java new file mode 100644 index 00000000000..2cc904da748 --- /dev/null +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/IFindReplaceTargetExtension.java @@ -0,0 +1,89 @@ +/********************************************************************** +Copyright (c) 2000, 2002 IBM Corp. 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 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 the state of 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); +} |