Package org.eclipse.ui.texteditor

Class FindReplaceAction

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.jface.action.AbstractAction

org.eclipse.jface.action.Action

org.eclipse.ui.texteditor.ResourceAction

org.eclipse.ui.texteditor.FindReplaceAction

All Implemented Interfaces:

IAction, IUpdate

public class FindReplaceAction
extends ResourceAction
implements IUpdate

An action which opens a Find/Replace dialog. The dialog while open, tracks the active workbench part and retargets itself to the active find/replace target.

It can also be used without having an IWorkbenchPart e.g. for dialogs or wizards by just providing a Shell and an IFindReplaceTarget. In this case the dialog won't be shared with the one used for the active workbench part.

This class may be instantiated; it is not intended to be subclassed.

See Also:

• IFindReplaceTarget

Restriction:

This class is not intended to be subclassed by clients.

Field Summary

Fields inherited from interface org.eclipse.jface.action.IAction

AS_CHECK_BOX, AS_DROP_DOWN_MENU, AS_PUSH_BUTTON, AS_RADIO_BUTTON, AS_UNSPECIFIED, CHECKED, DESCRIPTION, ENABLED, HANDLED, IMAGE, RESULT, TEXT, TOOL_TIP_TEXT

Constructor Summary

Constructors

Constructor	Description
FindReplaceAction(ResourceBundle bundle, String prefix, Shell shell, IFindReplaceTarget target)	Creates a new find/replace action for the given target and shell.
FindReplaceAction(ResourceBundle bundle, String prefix, IWorkbenchPart workbenchPart)	Creates a new find/replace action for the given workbench part.
FindReplaceAction(ResourceBundle bundle, String prefix, IWorkbenchWindow workbenchWindow)	Deprecated. use FindReplaceAction(ResourceBundle, String, IWorkbenchPart) instead

Method Summary

Modifier and Type	Method	Description
void	run()	The default implementation of this IAction method does nothing.
void	update()	Requests that this object update itself.

Methods inherited from class org.eclipse.ui.texteditor.ResourceAction

getString, initialize, setHelpContextId

Methods inherited from class org.eclipse.jface.action.Action

convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, isHandled, notifyResult, removeAcceleratorText, removeMnemonics, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText

Methods inherited from class org.eclipse.jface.action.AbstractAction

addPropertyChangeListener, firePropertyChange, firePropertyChange, removePropertyChangeListener

Methods inherited from class org.eclipse.core.commands.common.EventManager

addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FindReplaceAction

public FindReplaceAction(ResourceBundle bundle,
 String prefix,
 IWorkbenchPart workbenchPart)

Creates a new find/replace action for the given workbench part.

The action configures its visual representation from the given resource bundle.

Parameters:

bundle - the resource bundle

prefix - a prefix to be prepended to the various resource keys (described in ResourceAction constructor), or null if none

workbenchPart - the workbench part

See Also:

• ResourceAction(ResourceBundle, String)

FindReplaceAction

public FindReplaceAction(ResourceBundle bundle,
 String prefix,
 Shell shell,
 IFindReplaceTarget target)

Creates a new find/replace action for the given target and shell.

This can be used without having an IWorkbenchPart e.g. for dialogs or wizards.

The action configures its visual representation from the given resource bundle.

Parameters:

bundle - the resource bundle

prefix - a prefix to be prepended to the various resource keys (described in ResourceAction constructor), or null if none

shell - the shell

target - the IFindReplaceTarget to use

Since:

3.3

See Also:

• ResourceAction(ResourceBundle, String)

FindReplaceAction

@Deprecated
public FindReplaceAction(ResourceBundle bundle,
 String prefix,
 IWorkbenchWindow workbenchWindow)

Deprecated.

use FindReplaceAction(ResourceBundle, String, IWorkbenchPart) instead

Creates a new find/replace action for the given workbench window. The action configures its visual representation from the given resource bundle.

Parameters:

bundle - the resource bundle

prefix - a prefix to be prepended to the various resource keys (described in ResourceAction constructor), or null if none

workbenchWindow - the workbench window

See Also:

• ResourceAction(ResourceBundle, String)

Method Details

run

public void run()

Description copied from class: Action

The default implementation of this IAction method does nothing. Subclasses should override this method if they do not need information from the triggering event, or override runWithEvent(Event) if they do.

Specified by:

run in interface IAction

Overrides:

run in class Action

See Also:

• How radio buttons are handled
• How check boxes are handled

update

public void update()

Description copied from interface: IUpdate

Requests that this object update itself.

Specified by:

update in interface IUpdate