---

Overview  Package    Class   Use  Tree  Deprecated  Index  Help		Eclipse JDT Release 3.5
PREV CLASS   NEXT CLASS	NO FRAMES
SUMMARY: NESTED | FIELD |  CONSTR |  METHOD	DETAIL: FIELD |  CONSTR |  METHOD

---

org.eclipse.jdt.ui.text.java
Class JavaContentAssistInvocationContext

java.lang.Object
  

org.eclipse.jdt.ui.text.java.ContentAssistInvocationContext
      
org.eclipse.jdt.ui.text.java.JavaContentAssistInvocationContext

---

public class JavaContentAssistInvocationContext
extends 
ContentAssistInvocationContext

Describes the context of a content assist invocation in a Java editor.

Clients may use but not subclass this class.

Since:

3.2

Restriction:

This class is not intended to be subclassed by clients.

---

Constructor Summary
JavaContentAssistInvocationContext ( ICompilationUnit unit)           Creates a new context.
JavaContentAssistInvocationContext ( ITextViewer viewer, int offset, IEditorPart editor)           Creates a new context.

 

Method Summary
ICompilationUnit	getCompilationUnit ()           Returns the compilation unit that content assist is invoked in, null if there is none.
CompletionContext	getCoreContext ()           Returns the core completion context if available, null otherwise.
IType	getExpectedType ()           Returns the expected type if any, null otherwise.
float	getHistoryRelevance ( String qualifiedTypeName)           Returns an float in [0.0, 1.0] based on whether the type has been recently used as a right hand side for the type expected in the current context. 0 signals that the qualifiedTypeName does not match the expected type, while 1.0 signals that qualifiedTypeName has most recently been used in a similar context.
IJavaCompletionProposal[]	getKeywordProposals ()           Returns the keyword proposals that are available in this context, possibly none.
CompletionProposalLabelProvider	getLabelProvider ()           Returns a label provider that can be used to compute proposal labels.
IJavaProject	getProject ()           Returns the project of the compilation unit that content assist is invoked in, null if none.

 

Methods inherited from class org.eclipse.jdt.ui.text.java. ContentAssistInvocationContext
computeIdentifierPrefix, equals, getDocument, getInvocationOffset, getViewer, hashCode

 

Methods inherited from class java.lang. Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

JavaContentAssistInvocationContext

public JavaContentAssistInvocationContext(
ITextViewer viewer,
                                          int offset,
                                          
IEditorPart editor)

Creates a new context.

Parameters:

viewer - the viewer used by the editor

offset - the invocation offset

editor - the editor that content assist is invoked in

---

JavaContentAssistInvocationContext

public JavaContentAssistInvocationContext(
ICompilationUnit unit)

Creates a new context.

Parameters:

unit - the compilation unit in document

Method Detail

getCompilationUnit

public 
ICompilationUnit getCompilationUnit()

Returns the compilation unit that content assist is invoked in, null if there is none.

Returns:

the compilation unit that content assist is invoked in, possibly null

---

getProject

public 
IJavaProject getProject()

Returns the project of the compilation unit that content assist is invoked in, null if none.

Returns:

the current java project, possibly null

---

getKeywordProposals

public 
IJavaCompletionProposal[] getKeywordProposals()

Returns the keyword proposals that are available in this context, possibly none.

Note: This method may run codeComplete on the compilation unit.

Returns:

the available keyword proposals

---

getCoreContext

public 
CompletionContext getCoreContext()

Returns the core completion context if available, null otherwise.

Note: This method may run codeComplete on the compilation unit.

Returns:

the core completion context if available, null otherwise

---

getHistoryRelevance

public float getHistoryRelevance(
String qualifiedTypeName)

Returns an float in [0.0, 1.0] based on whether the type has been recently used as a right hand side for the type expected in the current context. 0 signals that the qualifiedTypeName does not match the expected type, while 1.0 signals that qualifiedTypeName has most recently been used in a similar context.

Note: This method may run codeComplete on the compilation unit.

Parameters:

qualifiedTypeName - the type name of the type of interest

Returns:

a relevance in [0.0, 1.0] based on previous content assist invocations

---

getExpectedType

public 
IType getExpectedType()

Returns the expected type if any, null otherwise.

Note: This method may run codeComplete on the compilation unit.

Returns:

the expected type if any, null otherwise

---

getLabelProvider

public 
CompletionProposalLabelProvider getLabelProvider()

Returns a label provider that can be used to compute proposal labels.

Returns:

a label provider that can be used to compute proposal labels

---

Overview  Package    Class   Use  Tree  Deprecated  Index  Help		Eclipse JDT Release 3.5
PREV CLASS   NEXT CLASS	NO FRAMES
SUMMARY: NESTED | FIELD |  CONSTR |  METHOD	DETAIL: FIELD |  CONSTR |  METHOD

---

Copyright (c) IBM Corp. and others 2000, 2008. All Rights Reserved.