KickJava   Java API By Example, From Geeks To Geeks.

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


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
15
16 /**
17  * A context information validator is used to determine if
18  * a displayed context information is still valid or should
19  * be dismissed.
20  * <p>
21  * The interface can be implemented by clients.
22  * </p>
23  *
24  * @see IContextInformationPresenter
25  */
26 public interface IContextInformationValidator {
27
28     /**
29      * Installs this validator for the given context information.
30      *
31      * @param info the context information which this validator should check
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      * Returns whether the information this validator is installed on is still valid
39      * at the given document position.
40      *
41      * @param offset the current offset within the document
42      * @return <code>true</code> if the information also valid at the given document position
43      */
44     boolean isContextInformationValid(int offset);
45 }
46
Popular Tags