KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > jface > text > information > IInformationProviderExtension


1 /*******************************************************************************
2  * Copyright (c) 2000, 2005 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.jface.text.information;
12
13
14 import org.eclipse.jface.text.IRegion;
15 import org.eclipse.jface.text.ITextViewer;
16
17
18 /**
19  * Extends {@link org.eclipse.jface.text.information.IInformationProvider} with
20  * the ability to provide the element for a given subject.
21  *
22  * @see org.eclipse.jface.text.information.IInformationProvider
23  * @since 2.1
24  */
25 public interface IInformationProviderExtension {
26
27     /**
28      * Returns the element for the given subject or <code>null</code> if
29      * no element is available.
30      * <p>
31      * Implementers should ignore the text returned by {@link IInformationProvider#getInformation(ITextViewer, IRegion)}.
32      * </p>
33      *
34      * @param textViewer the viewer in whose document the subject is contained
35      * @param subject the text region constituting the information subject
36      * @return the element for the subject
37      *
38      * @see IInformationProvider#getInformation(ITextViewer, IRegion)
39      * @see org.eclipse.jface.text.ITextViewer
40      */
41     Object JavaDoc getInformation2(ITextViewer textViewer, IRegion subject);
42 }
43
Popular Tags