| /******************************************************************************* |
| * Copyright (c) 2000, 2005 IBM Corporation and others. |
| * |
| * This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License 2.0 |
| * which accompanies this distribution, and is available at |
| * https://www.eclipse.org/legal/epl-2.0/ |
| * |
| * SPDX-License-Identifier: EPL-2.0 |
| * |
| * 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 {@link org.eclipse.jface.text.IFindReplaceTarget}. |
| * <p> |
| * Introduces the concepts of find/replace sessions, searching in a limiting |
| * scope and a replace-all mode. |
| * <p> |
| * If a scope is set, <code>findAndSelect</code> is limited to the scope. |
| * Occurrences outside of the scope are not considered. |
| * |
| * @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); |
| } |