KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > jface > fieldassist > IContentProposalProvider


1 /*******************************************************************************
2  * Copyright (c) 2005, 2006 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.fieldassist;
12
13 /**
14  * IContentProposalProvider provides an array of IContentProposals that are
15  * appropriate for a textual dialog field, given the field's current content and
16  * the current cursor position.
17  *
18  * @since 3.2
19  */
20 public interface IContentProposalProvider {
21
22     /**
23      * Return an array of Objects representing the valid content proposals for a
24      * field.
25      *
26      * @param contents
27      * the current contents of the text field
28      * @param position
29      * the current position of the cursor in the contents
30      *
31      * @return the array of {@link IContentProposal} that represent valid
32      * proposals for the field.
33      */
34     IContentProposal[] getProposals(String JavaDoc contents, int position);
35 }
36
Popular Tags