KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > jface > text > contentassist > IContextInformationPresenter


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.contentassist;
12
13 import org.eclipse.jface.text.ITextViewer;
14 import org.eclipse.jface.text.TextPresentation;
15
16
17 /**
18  * A context information presenter determines the presentation
19  * of context information depending on a given document position.
20  * <p>
21  * The interface can be implemented by clients.
22  * </p>
23  *
24  * @since 2.0
25  */
26 public interface IContextInformationPresenter {
27
28     /**
29      * Installs this presenter for the given context information.
30      *
31      * @param info the context information which this presenter should style
32      * @param viewer the text viewer on which the information is presented
33      * @param offset the document offset for which the information has been computed
34      */
35     void install(IContextInformation info, ITextViewer viewer, int offset);
36
37     /**
38      * Updates the given presentation of the given context information
39      * at the given document position. Returns whether update changed the
40      * presentation.
41      *
42      * @param offset the current offset within the document
43      * @param presentation the presentation to be updated
44      * @return <code>true</code> if the given presentation has been changed
45      */
46     boolean updatePresentation(int offset, TextPresentation presentation);
47 }
48
Popular Tags