org.fife.rsta.ac.java
Class JavaCompletionProvider

java.lang.Object
  org.fife.ui.autocomplete.CompletionProviderBase
      org.fife.ui.autocomplete.LanguageAwareCompletionProvider
          org.fife.rsta.ac.java.JavaCompletionProvider

All Implemented Interfaces:

CompletionProvider, ToolTipSupplier

public class JavaCompletionProvider
extends LanguageAwareCompletionProvider

Completion provider for the Java programming language.

Version:

1.0

Author:

Robert Futrell

Field Summary

Fields inherited from class org.fife.ui.autocomplete.CompletionProviderBase

EMPTY_STRING

Constructor Summary

JavaCompletionProvider()
Constructor.

JavaCompletionProvider(JarManager jarManager)
Constructor.

Method Summary

void	addJar(JarInfo info) Adds a jar to the "build path."
void	clearJars() Removes all jars from the "build path."
String	getAlreadyEnteredText(JTextComponent comp) Defers to the source-analyzing completion provider.
CompilationUnit	getCompilationUnit()
List	getCompletionsAt(JTextComponent tc, Point p)
List	getJars() Returns the jars on the "build path."
List	getParameterizedCompletions(JTextComponent tc)
boolean	removeJar(File jar) Removes a jar from the "build path."
void	setCompilationUnit(CompilationUnit cu)

Methods inherited from class org.fife.ui.autocomplete.LanguageAwareCompletionProvider

clearParameterizedCompletionParams, getCommentCompletionProvider, getCompletionsImpl, getDefaultCompletionProvider, getDocCommentCompletionProvider, getParameterListEnd, getParameterListSeparator, getParameterListStart, getStringCompletionProvider, getToolTipText, isAutoActivateOkay, setCommentCompletionProvider, setDefaultCompletionProvider, setDocCommentCompletionProvider, setParameterizedCompletionParams, setStringCompletionProvider

Methods inherited from class org.fife.ui.autocomplete.CompletionProviderBase

getCompletions, getListCellRenderer, getParameterChoicesProvider, getParent, setAutoActivationRules, setListCellRenderer, setParameterChoicesProvider, setParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JavaCompletionProvider

public JavaCompletionProvider()

Constructor.

JavaCompletionProvider

public JavaCompletionProvider(JarManager jarManager)

Constructor.

Parameters:

jarManager - The jar manager to use when looking up completion choices. This can be passed in to share a single jar manager across multiple RSyntaxTextAreas. This may also be null, in which case this completion provider will have a unique JarManager.

Method Detail

addJar

public void addJar(JarInfo info)
            throws IOException

Adds a jar to the "build path."

Parameters:

info - The jar to add. If this is null, then the current JVM's main JRE jar (rt.jar, or classes.jar on OS X) will be added. If this jar has already been added, adding it again will do nothing (except possibly update its attached source location).

Throws:

IOException - If an IO error occurs.

See Also:

removeJar(File), getJars()

clearJars

public void clearJars()

Removes all jars from the "build path."

See Also:

removeJar(File), addJar(JarInfo), getJars()

getAlreadyEnteredText

public String getAlreadyEnteredText(JTextComponent comp)

Defers to the source-analyzing completion provider.

Specified by:

getAlreadyEnteredText in interface CompletionProvider

Overrides:

getAlreadyEnteredText in class LanguageAwareCompletionProvider

Returns:

The already entered text.

getCompilationUnit

public CompilationUnit getCompilationUnit()

getCompletionsAt

public List getCompletionsAt(JTextComponent tc,
                             Point p)

Specified by:

getCompletionsAt in interface CompletionProvider

Overrides:

getCompletionsAt in class LanguageAwareCompletionProvider

getJars

public List getJars()

Returns the jars on the "build path."

Returns:

A list of JarInfos. Modifying a JarInfo in this list will have no effect on this completion provider; in order to do that, you must re-add the jar via addJar(JarInfo). If there are no jars on the "build path," this will be an empty list.

See Also:

addJar(JarInfo)

getParameterizedCompletions

public List getParameterizedCompletions(JTextComponent tc)

Specified by:

getParameterizedCompletions in interface CompletionProvider

Overrides:

getParameterizedCompletions in class LanguageAwareCompletionProvider

removeJar

public boolean removeJar(File jar)

Removes a jar from the "build path."

Parameters:

jar - The jar to remove.

Returns:

Whether the jar was removed. This will be false if the jar was not on the build path.

See Also:

addJar(JarInfo)

setCompilationUnit

public void setCompilationUnit(CompilationUnit cu)