Eclipse Platform
Release 3.2

org.eclipse.jface.fieldassist
Class SimpleContentProposalProvider

java.lang.Object
  extended byorg.eclipse.jface.fieldassist.SimpleContentProposalProvider
All Implemented Interfaces:
IContentProposalProvider

public class SimpleContentProposalProvider
extends Object
implements IContentProposalProvider

SimpleContentProposalProvider is a class designed to map a static list of Strings to content proposals.

Since:
3.2
See Also:
IContentProposalProvider

Constructor Summary
SimpleContentProposalProvider(String[] proposals)
          Construct a SimpleContentProposalProvider whose content proposals are always the specified array of Objects.
 
Method Summary
 IContentProposal[] getProposals(String contents, int position)
          Return an array of Objects representing the valid content proposals for a field.
 void setProposals(String[] items)
          Set the Strings to be used as content proposals.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SimpleContentProposalProvider

public SimpleContentProposalProvider(String[] proposals)
Construct a SimpleContentProposalProvider whose content proposals are always the specified array of Objects.

Parameters:
proposals - the array of Strings to be returned whenever proposals are requested.
Method Detail

getProposals

public IContentProposal[] getProposals(String contents,
                                       int position)
Return an array of Objects representing the valid content proposals for a field. Ignore the current contents of the field.

Specified by:
getProposals in interface IContentProposalProvider
Parameters:
contents - the current contents of the field (ignored)
position - the current cursor position within the field (ignored)
Returns:
the array of Objects that represent valid proposals for the field given its current content.

setProposals

public void setProposals(String[] items)
Set the Strings to be used as content proposals.

Parameters:
items - the array of Strings to be used as proposals.

Eclipse Platform
Release 3.2

Guidelines for using Eclipse APIs.

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