Eclipse Platform
Release 3.1

org.eclipse.ui
Interface IEditorMatchingStrategy


public interface IEditorMatchingStrategy

An editor matching strategy allows editor extensions to provide their own algorithm for matching the input of an open editor of that type to a given editor input. This is used to find a matching editor during IWorkbenchPage.openEditor(IEditorInput, String, boolean) and IWorkbenchPage.findEditor(IEditorInput).

Since:
3.1

Method Summary
 boolean matches(IEditorReference editorRef, IEditorInput input)
          Returns whether the editor represented by the given editor reference matches the given editor input.
 

Method Detail

matches

public boolean matches(IEditorReference editorRef,
                       IEditorInput input)
Returns whether the editor represented by the given editor reference matches the given editor input.

Implementations should inspect the given editor input first, and try to reject it early before calling IEditorReference.getEditorInput(), since that method may be expensive.

Parameters:
editorRef - the editor reference to match against
input - the editor input to match
Returns:
true if the editor matches the given editor input, false if it does not match

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.