com.bbn.swede.editor.contentassist
Interface INamespaceSuggester

All Known Implementing Classes:
DefaultNamespaceSuggester

public interface INamespaceSuggester

An interface for creating specialized autocompletion behaviour.

Author:
aperezlo

Method Summary
 void cleanup()
          Performs cleanup activities - free up resources, unregister with the OAST, etc.
 List getInstanceSuggestions(String alreadyTyped)
          Given a representation of what has already been typed, check to see which named instances (i.e not classes or properties, and nothing anonymous) of this namespace are valid autocompletion suggestions.
 List getSuggestions(String alreadyTyped)
          Given a representation of what has already been typed, check to see which classes and properties of this namespace are valid autocompletion suggestions.
 boolean hasSuggestions(String alreadyTyped)
          Indicates whether the suggestor has any completion proposals for the text typed so far.
 void init()
          Performs initialization functions like resource allocation, initial population, and OAST registration.
 

Method Detail

init

public void init()
Performs initialization functions like resource allocation, initial population, and OAST registration.


cleanup

public void cleanup()
Performs cleanup activities - free up resources, unregister with the OAST, etc.


getSuggestions

public List getSuggestions(String alreadyTyped)
Given a representation of what has already been typed, check to see which classes and properties of this namespace are valid autocompletion suggestions.

Parameters:
alreadyTyped - what has already been typed by the user (with any namespaces removed)
Returns:
a list of ISuggestionCandidate objects representing possible completions, or an empty list if none exist
See Also:
ISuggestionCandidate

getInstanceSuggestions

public List getInstanceSuggestions(String alreadyTyped)
Given a representation of what has already been typed, check to see which named instances (i.e not classes or properties, and nothing anonymous) of this namespace are valid autocompletion suggestions.

Parameters:
alreadyTyped - what has already been typed by the user (with any namespaces removed)
Returns:
a list of ISuggestionCandidate objects representing possible completions, or an empty list if none exist
See Also:
ISuggestionCandidate

hasSuggestions

public boolean hasSuggestions(String alreadyTyped)
Indicates whether the suggestor has any completion proposals for the text typed so far.

Parameters:
alreadyTyped - what has already been typed by the user (with any namespaces removed)
Returns:
true if this suggester has suggestions, false otherwise


Copyright © 2004-2005 BBN Technologies. All Rights Reserved.